# nocoolusername/volatility-mcp architecture

> Architecture diagram of the GitHub repository nocoolusername/volatility-mcp, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nocoolusername/volatility-mcp
- Repository: https://github.com/nocoolusername/volatility-mcp

## Overview

volatility-mcp is a local stdio MCP server that brokers queries to a separately installed Volatility 3 analyzer. Its main workflow is image discovery, plugin selection and analysis, durable run capture, then bounded reading or querying of saved results. Optional branches provide symbol provisioning, CryptoMem/add-on analysis, coverage and reports, and a local Workbench. The source index supports several internal dependency links; unsampled modules are represented by their exact paths, and uncertain wiring is omitted.

Main entry points: [`src/volatility_mcp/backend.py`](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/backend.py) (Analysis backend), [`src/volatility_mcp/cli.py`](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/cli.py) (Operator CLI), [`src/volatility_mcp/execution.py`](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/execution.py) (Subprocess execution), [`src/volatility_mcp/server.py`](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/server.py) (Stdio MCP server)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interface["Client interface"]
  node_server["Stdio MCP server<br/>[server.py]"]
  node_cli["Operator CLI<br/>[cli.py]"]
  node_config["Local configuration<br/>[config.py]"]
end

subgraph group_analysis["Memory analysis"]
  node_backend["Analysis backend<br/>[backend.py]"]
  node_addons["Plugin discovery<br/>[addons.py]"]
  node_batch["Batch analysis<br/>[addon_batch.py]"]
  node_sensitive["Sensitive-data scans<br/>[addon_sensitive.py]"]
  node_go["Go runtime analysis<br/>[addon_go.py]"]
  node_pythonruntime["Python runtime analysis"]
  node_bitlocker["BitLocker analysis<br/>[addon_bitlocker.py]"]
  node_keyring["Keyring analysis<br/>[addon_keyring.py]"]
end

subgraph group_evidence["Evidence and results"]
  node_evidence[("Memory acquisitions")]
  node_execution["Subprocess execution<br/>[execution.py]"]
  node_outputs[("Saved run artifacts")]
  node_savedquery["Saved-result queries<br/>[saved_evidence.py]"]
  node_inspection["Artifact inspection"]
  node_reuse["Verified run reuse<br/>[reuse.py]"]
end

subgraph group_symbols["Symbol provisioning"]
  node_packs["Official symbol packs<br/>[symbol_packs.py]"]
  node_linuxsymbols["Linux symbol catalog<br/>[linux_symbols.py]"]
  node_symbolstore[("Local symbol store")]
end

subgraph group_investigation["Investigation and UI"]
  node_coverage["Coverage tracking<br/>[coverage.py]"]
  node_reporting["Report validation<br/>[reporting.py]"]
  node_workbench["Local Workbench"]
end

node_client(("MCP client"))
node_volatility["Volatility 3"]
node_downloadhost["Official download host"]

node_client -->|"calls tools"| node_server
node_server -->|"invokes operations"| node_backend
node_cli -->|"loads settings"| node_config
node_server -->|"loads settings"| node_config
node_backend -->|"uses settings"| node_config
node_backend -->|"runs commands"| node_execution
node_backend -->|"checks prior runs"| node_reuse
node_backend -->|"queries saved evidence"| node_savedquery
node_backend -->|"inspects artifacts"| node_inspection
node_backend -->|"projects evidence"| node_coverage
node_execution -->|"runs analyzer"| node_volatility
node_execution -->|"reads images"| node_evidence
node_execution -->|"saves outputs"| node_outputs
node_backend -->|"discovers plugins"| node_addons
node_cli -->|"configures plugins"| node_addons
node_sensitive -->|"reuses scanning"| node_batch
node_savedquery -->|"reads artifacts"| node_outputs
node_inspection -->|"reads artifacts"| node_outputs
node_reuse -->|"checks run records"| node_outputs
node_coverage -->|"projects saved runs"| node_outputs
node_reporting -->|"validates provenance"| node_coverage
node_reporting -->|"checks artifacts"| node_outputs
node_cli -->|"validates reports"| node_reporting
node_client -.->|"uses optionally"| node_workbench
node_cli -->|"installs packs"| node_packs
node_cli -->|"manages Linux symbols"| node_linuxsymbols
node_packs -->|"provisions tables"| node_symbolstore
node_linuxsymbols -->|"installs tables"| node_symbolstore
node_packs -->|"downloads from"| node_downloadhost
node_linuxsymbols -->|"downloads from"| node_downloadhost

click node_server "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/server.py"
click node_cli "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/cli.py"
click node_config "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/config.py"
click node_backend "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/backend.py"
click node_addons "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/addons.py"
click node_batch "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/addon_batch.py"
click node_sensitive "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/addon_sensitive.py"
click node_go "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/addon_go.py"
click node_pythonruntime "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/addon_python_runtime.py"
click node_bitlocker "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/addon_bitlocker.py"
click node_keyring "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/addon_keyring.py"
click node_execution "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/execution.py"
click node_savedquery "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/saved_evidence.py"
click node_inspection "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/artifact_inspection.py"
click node_reuse "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/reuse.py"
click node_coverage "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/coverage.py"
click node_reporting "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/reporting.py"
click node_workbench "https://github.com/nocoolusername/volatility-mcp/tree/main/src/volatility_mcp/ui"
click node_packs "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/symbol_packs.py"
click node_linuxsymbols "https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/linux_symbols.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_server,node_cli,node_config,node_client toneBlue
class node_backend,node_addons,node_batch,node_sensitive,node_go,node_pythonruntime,node_bitlocker,node_keyring toneAmber
class node_evidence,node_execution,node_outputs,node_savedquery,node_inspection,node_reuse toneMint
class node_packs,node_linuxsymbols,node_symbolstore toneRose
class node_coverage,node_reporting,node_workbench,node_volatility,node_downloadhost toneIndigo
```

## Components

### Client interface

- [Stdio MCP server](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/server.py): `src/volatility_mcp/server.py`
- [Operator CLI](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/cli.py): `src/volatility_mcp/cli.py`
- [Local configuration](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/config.py): `src/volatility_mcp/config.py`

### Memory analysis

- [Analysis backend](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/backend.py): `src/volatility_mcp/backend.py`
- [Plugin discovery](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/addons.py): `src/volatility_mcp/addons.py`
- [Batch analysis](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/addon_batch.py): `src/volatility_mcp/addon_batch.py`
- [Sensitive-data scans](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/addon_sensitive.py): `src/volatility_mcp/addon_sensitive.py`
- [Go runtime analysis](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/addon_go.py): `src/volatility_mcp/addon_go.py`
- [Python runtime analysis](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/addon_python_runtime.py): `src/volatility_mcp/addon_python_runtime.py`
- [BitLocker analysis](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/addon_bitlocker.py): `src/volatility_mcp/addon_bitlocker.py`
- [Keyring analysis](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/addon_keyring.py): `src/volatility_mcp/addon_keyring.py`

### Evidence and results

- **Memory acquisitions**
- [Subprocess execution](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/execution.py): `src/volatility_mcp/execution.py`
- **Saved run artifacts**
- [Saved-result queries](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/saved_evidence.py): `src/volatility_mcp/saved_evidence.py`
- [Artifact inspection](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/artifact_inspection.py): `src/volatility_mcp/artifact_inspection.py`
- [Verified run reuse](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/reuse.py): `src/volatility_mcp/reuse.py`

### Symbol provisioning

- [Official symbol packs](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/symbol_packs.py): `src/volatility_mcp/symbol_packs.py`
- [Linux symbol catalog](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/linux_symbols.py): `src/volatility_mcp/linux_symbols.py`
- **Local symbol store**

### Investigation and UI

- [Coverage tracking](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/coverage.py): `src/volatility_mcp/coverage.py`
- [Report validation](https://github.com/nocoolusername/volatility-mcp/blob/main/src/volatility_mcp/reporting.py): `src/volatility_mcp/reporting.py`
- [Local Workbench](https://github.com/nocoolusername/volatility-mcp/tree/main/src/volatility_mcp/ui): `src/volatility_mcp/ui`

### Other components

- **MCP client**
- **Volatility 3**
- **Official download host**

## Connections

- MCP client → Stdio MCP server: calls tools (evidence: `README.md`)
- Stdio MCP server → Analysis backend: invokes operations (evidence: `src/volatility_mcp/server.py`)
- Operator CLI → Local configuration: loads settings (evidence: `src/volatility_mcp/cli.py`)
- Stdio MCP server → Local configuration: loads settings (evidence: `src/volatility_mcp/server.py`)
- Analysis backend → Local configuration: uses settings (evidence: `src/volatility_mcp/backend.py`)
- Analysis backend → Subprocess execution: runs commands (evidence: `src/volatility_mcp/backend.py`)
- Analysis backend → Verified run reuse: checks prior runs (evidence: `src/volatility_mcp/backend.py`)
- Analysis backend → Saved-result queries: queries saved evidence (evidence: `src/volatility_mcp/backend.py`)
- Analysis backend → Artifact inspection: inspects artifacts (evidence: `src/volatility_mcp/backend.py`)
- Analysis backend → Coverage tracking: projects evidence (evidence: `src/volatility_mcp/backend.py`)
- Subprocess execution → Volatility 3: runs analyzer (evidence: `README.md`)
- Subprocess execution → Memory acquisitions: reads images (evidence: `README.md`)
- Subprocess execution → Saved run artifacts: saves outputs (evidence: `README.md`)
- Analysis backend → Plugin discovery: discovers plugins (evidence: `src/volatility_mcp/addons.py`)
- Operator CLI → Plugin discovery: configures plugins (evidence: `src/volatility_mcp/addons.py`)
- Sensitive-data scans → Batch analysis: reuses scanning (evidence: `src/volatility_mcp/addon_sensitive.py`)
- Saved-result queries → Saved run artifacts: reads artifacts (evidence: `src/volatility_mcp/saved_evidence.py`)
- Artifact inspection → Saved run artifacts: reads artifacts (evidence: `src/volatility_mcp/artifact_inspection.py`)
- Verified run reuse → Saved run artifacts: checks run records (evidence: `src/volatility_mcp/reuse.py`)
- Coverage tracking → Saved run artifacts: projects saved runs (evidence: `src/volatility_mcp/coverage.py`)
- Report validation → Coverage tracking: validates provenance (evidence: `src/volatility_mcp/reporting.py`)
- Report validation → Saved run artifacts: checks artifacts (evidence: `src/volatility_mcp/reporting.py`)
- Operator CLI → Report validation: validates reports (evidence: `src/volatility_mcp/cli.py`)
- MCP client → Local Workbench: uses optionally (evidence: `README.md`)
- Operator CLI → Official symbol packs: installs packs (evidence: `src/volatility_mcp/cli.py`)
- Operator CLI → Linux symbol catalog: manages Linux symbols (evidence: `src/volatility_mcp/cli.py`)
- Official symbol packs → Local symbol store: provisions tables (evidence: `src/volatility_mcp/symbol_packs.py`)
- Linux symbol catalog → Local symbol store: installs tables (evidence: `src/volatility_mcp/linux_symbols.py`)
- Official symbol packs → Official download host: downloads from (evidence: `src/volatility_mcp/symbol_packs.py`)
- Linux symbol catalog → Official download host: downloads from (evidence: `src/volatility_mcp/linux_symbols.py`)
