@reneturcios/threatkb

中文文档
0.1.0发布于 2026/11/02MITES Module

Query a local MITRE ATT&CK dataset: techniques by ID or fuzzy name, full technique detail, mitigations, detections, and tactics from an enterprise-attack STIX file. One bin serves a small CLI and a stdio MCP server.

原始使用文档
文档目录7 节
  1. Install
  2. CLI
  3. MCP server
  4. Tools
  5. How the STIX dataset is read
  6. Development
  7. License

threatkb

threatkb answers questions about the MITRE ATT&CK knowledge base from a dataset file you keep on your own machine: look a technique up by its ATT&CK id or by an approximate name, pull the full record for a technique (platforms, kill-chain phases, references, sub-techniques, mitigations, detections), list the mitigations or detections tied to a technique, and list the tactics the dataset knows about. One binary serves a command-line interface and a stdio MCP server.

There is no bundled dataset and no network service behind this tool. You point it at a STIX bundle in the enterprise-attack.json shape (the layout MITRE publishes for the enterprise matrix) with the THREATKB_DATA_FILE environment variable. When the variable is unset or the file cannot be read, the query commands fail with an error naming the missing dataset instead of guessing — threatkb never invents ATT&CK data. threatkb info still answers in that state and reports dataset_loaded: false with the reason.

Install

THREATKB_DATA_FILE=/path/to/enterprise-attack.json npx @reneturcios/threatkb tactics

Or run the container image:

docker run -i -e THREATKB_DATA_FILE=/data/enterprise-attack.json \
  -v /path/to/data:/data ghcr.io/cloudcorprecords/threatkb

The container defaults to the MCP server (see below). Pass CLI arguments to use it as a CLI instead.

CLI

export THREATKB_DATA_FILE=/path/to/enterprise-attack.json

threatkb query --id T1059
threatkb query --name "command and scripting"
threatkb full --id T1059
threatkb full --name PowerShell
threatkb mitigations T1059
threatkb detections T1059
threatkb tactics
threatkb info

threatkb --version

Results print as JSON. Technique searches return {results: [...], count: N}; mitigation and detection queries return {technique_id, results: [...], count: N} for the one technique asked about, and an unknown technique id is an error. Exit codes: 0 on success, 1 when a query fails (including a missing dataset), 2 for usage errors.

Lookup rules: an id lookup is exact and case-insensitive (t1059 finds T1059). A name lookup is fuzzy — exact name first, then names starting with the query, then names containing it, then names containing every word of the query.

MCP server

One bin serves both faces. The mcp subcommand starts a stdio MCP server:

npx -y @reneturcios/threatkb mcp

MCP client configuration:

{
  "mcpServers": {
    "threatkb": {
      "command": "npx",
      "args": ["-y", "@reneturcios/threatkb", "mcp"],
      "env": {
        "THREATKB_DATA_FILE": "/path/to/enterprise-attack.json"
      }
    }
  }
}

Tools

ToolInputWhat it returns
query_techniquetechnique_id or tech_name (one required in practice)Matching technique summaries as {results, count}.
search_technique_fulltechnique_id or tech_nameThe same matches with full detail: platforms, kill-chain phases, references, sub-techniques, mitigations, detections.
query_mitigationstechnique_id (required)Mitigations linked to that technique.
query_detectionstechnique_id (required)Detections linked to that technique.
list_tactics(none)Every tactic in the dataset as {results, count}.
server_info(none)Server name, version, dataset path, whether the dataset loaded, and object counts when it did.

How the STIX dataset is read

threatkb indexes a deliberately simplified slice of the STIX model, documented here so the limits are clear:

  • Techniques are attack-pattern objects; the ATT&CK id comes from the external_references entry with source name mitre-attack. Tactics come from a technique's kill_chain_phases phase names.
  • Tactics are x-mitre-tactic objects (with x_mitre_shortname).
  • Mitigations are course-of-action objects linked to a technique by a mitigates relationship.
  • Detections are detects relationships pointing at the technique; the relationship's source (usually an x-mitre-data-component) is resolved, including its data source name when linked. A technique's x_mitre_detection guidance text is also returned as a detection entry.
  • Sub-techniques are recognised by x_mitre_is_subtechnique or a dotted id; the parent comes from a subtechnique-of relationship when present, otherwise from the id prefix.

Revocation/deprecation flags, analytics, data-source coverage scoring, and group/software attribution are out of scope.

Development

npm install
npm run build   # tsc -> dist/
npm test        # node test runner over test/*.test.ts, on a hand-written STIX fixture, no real dataset needed
npm run dev     # run the CLI from source via tsx

License

MIT — see LICENSE.

版本与发布记录

@reneturcios/threatkb 共发布 2 个版本,首次发布于 2026/11/02;过去 12 个月发布了 2 个版本。

版本发布日期距今
0.1.0latest2026/11/021 天前
0.0.0-stage2026/11/021 天前

关于 @reneturcios/threatkb 的常见问题

@reneturcios/threatkb 是什么?

查询本地MITRE攻击和ck数据集:通过ID或模糊名称查询技术、完整的技术细节、缓解、检测和企业攻击STIX文件中的策略。一个bin提供一个小型CLI和一个studio MCP服务器。

如何安装 @reneturcios/threatkb?

在项目目录运行 npm install @reneturcios/threatkb,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 threatkb,可以用 npx threatkb 直接运行。

@reneturcios/threatkb 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/reneturcios__threatkb 是否存在。

@reneturcios/threatkb 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@reneturcios/threatkb 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@reneturcios/threatkb 可以商用吗?

@reneturcios/threatkb 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@reneturcios/threatkb 还在维护吗?

最新版本 0.1.0 发布于 2026/11/02(1 天前);至今共发布 2 个版本,其中过去 12 个月发布了 2 个;首次发布于 2026/11/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。