Skip to content

Latest commit

 

History

513 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Knossos-MCP

The labyrinth mapped once, so nobody has to wander it again.

Release Tool page CI Coverage License Language Last commit Conventional Commits MCP Observatory Status

Knossos (Κνωσός) is the Bronze Age palace at the heart of Minoan Crete, a complex so sprawling that Greek myth remembered it as the Labyrinth: the maze Daedalus built for the Minotaur, which no one could navigate without a thread to follow back out. Ariadne handed Theseus that thread.

TL;DR: Knossos-MCP scans a repository once and turns its source relationships into a local, evidence-backed graph. Its MCP tools and CLI answer dependency, call-site, architecture, and blast-radius questions with file and line evidence, so an agent does not need to rescan the tree.

Every fact points back to a file and a source location. Facts that static analysis cannot prove are labelled with their confidence and origin instead of being guessed. Nothing in the scan pipeline installs dependencies, imports a module, or boots an application framework.

Status: pre-release. Knossos-MCP is not yet published to Packagist or any container registry. The source is public on GitHub, so build from source (see Install). Image names such as knossos-mcp:dev in this README are built locally by you; there is no docker pull to fetch them yet.

Contents: What you can ask · Worked example · Tools · Install · Languages · Safety · Documentation


What you can ask after one scan

  • What are the major modules, entry points, and boundaries?
  • What depends, directly or transitively, on UserRepository?
  • What are the exact call sites of ScannerClient::scan?
  • How can a checkout request reach invoice generation?
  • Which relationships cross a declared boundary policy?
  • Which test files exercise the blast radius of this diff?
  • What does this working tree risk, reviewed architecturally in one call?
  • Where would a refunds feature fit the existing structure?

Every query and analysis capability is available both as an MCP tool and as an equivalent CLI command. See the documentation index for the full map.

Worked example

Scanning this repository takes about six seconds and yields a graph you can interrogate. Output below is real, abridged with ….

$ knossos scan . --json
{"summary":"Scanned 425 files into 6126 nodes and 35667 relationships.",
 "data":{"files":425,"nodes":6126,"edges":35667,"diagnostics":0,"mode":"full",
 "scanner_metadata":{"knossos.php":{"files_scanned":394},
   "knossos.typescript":{"files_scanned":17,"programs":1},
   "knossos.python":{"files_scanned":5,"parser":"python.ast"},
   "knossos.rust":{"files_scanned":9,"parser":"rust.syn"}},
 "metrics":{"elapsed_ms":6103.6, …}}}

Orient yourself in a codebase you have never opened:

$ knossos architecture-summary project_1b4f41… --json
{"summary":"Knossos-MCP contains 6126 nodes and 35667 relationships.",
 "data":{"node_kinds":[{"kind":"method","count":4196},{"kind":"class","count":453},
   {"kind":"function","count":311},{"kind":"module","count":51},
   {"kind":"interface","count":12}, …],
  "edge_kinds":[{"kind":"calls","count":23381},{"kind":"contains","count":4727},
   {"kind":"constructs","count":3898}, …]}}

Ask what breaks if you change an interface. Each dependant carries the edge that justifies it and the exact source line, so the answer is checkable:

$ knossos impact-analysis project_1b4f41… 'Knossos\Scanner\ScannerClient' --json
{"summary":"Found 100 potential static dependants within depth 4.",
 "data":{"target":{"kind":"interface","canonical_name":"Knossos\\Scanner\\ScannerClient", …},
   "dependants":[{"node":{"canonical_name":"Knossos\\Scanner\\Worker\\ProcessScannerClient", …},
     "distance":1,"path_confidence":"certain",
     "via":{"kind":"implements","origin":"ast",
       "explanation":"ProcessScannerClient depends through --implements (certain, ast)--> ScannerClient",
       "evidence":{"path":"src/Scanner/Worker/ProcessScannerClient.php","start_line":11}}}, …],
   "counts":{"by_distance":{"1":5,"2":15,"3":75,"4":5},
     "by_confidence":{"certain":100,"probable":0,"possible":0}}, …}}

Find refactor targets without shelling out to wc and find:

$ knossos file-metrics project_1b4f41… --limit=3 --json
{"summary":"3 of 425 files by line_count desc.",
 "data":{"files":[{"path":"tests/phpunit/Reconciliation/GraphReconcilerTest.php","language":"php","line_count":2473},
   {"path":"workers/rust/src/visit.rs","language":"rust","line_count":1559},
   {"path":"workers/rust/tests/scan.rs","language":"rust","line_count":1521}]}}

Answers that rest on inference say so. impact_analysis returns the warning "Impact is a conservative static blast radius; it does not guarantee that a dependant will break", and dead-code candidates report absence of evidence rather than proven absence.

MCP tool calls default to a compact verbosity that agents should prefer over --json: it hoists each repeated node object into a one-time component_legend keyed by canonical name, leaving a plain name string behind wherever the node appeared, and shortens each via object down to just its edge kind. The same call is roughly a third of the tokens. See response envelopes.

Tools

Thirty-three MCP tools, all but server_info with an equivalent CLI command. Full input schemas are in the MCP tool reference and CLI reference; each group below links to its capability guide.

Orientation

MCP tool CLI Answers
server_info – Which roots this server may read, the roots file to extend, and whether it is containerised.
diagnose_runtime doctor Whether the runtimes, scanner workers, database, and migrations are healthy.

Finding and reading components

MCP tool CLI Answers
list_projects list-projects Which projects are scanned, how fresh, how large.
find_component find-component Ranked candidates when you only know part of a name.
inspect_component inspect-component One component's roles, boundary, relations, and evidence.
list_usages list-usages Every usage site of a symbol with file:line evidence.
architecture_summary architecture-summary A one-call overview by language and node/edge kind.
search_architecture search-architecture Components filtered by kind, role, boundary, confidence.
file_metrics file-metrics Files ranked by line count or path, filterable.
list_boundaries list-boundaries How the codebase is partitioned, explicitly or inferred.
export_diagram export-diagram Mermaid or PlantUML source for the current graph.

Structure analysis

MCP tool CLI Answers
impact_analysis impact-analysis What depends on a symbol, with the edge that proves it.
explain_flow explain-flow How A reaches B, as ranked evidence-backed paths.
dependency_cycles dependency-cycles Circular dependencies as bounded strongly connected groups.
architecture_health architecture-health Hubs, hotspots, and dead code split into what nothing references and what only tests reach.
suggest_location suggest-location Where new code for a feature belongs, with visible factors.

Reviewing a change

MCP tool CLI Answers
review_diff review-diff One-call review: impact, boundary violations, gate delta, cycles.
changed_files_impact changed-files-impact What a set of changed files, or your working tree, touches.
test_impact test-impact Which test files statically exercise a change, ranked by distance.
change_impact change-impact Static blast radius weighted by recent Git churn.

Rules, budgets, and history

MCP tool CLI Answers
check_architecture check-architecture Which relationships violate declared boundary policies.
quality_gate quality-gate Whether a change breaches architecture budgets, with SARIF.
list_snapshots list-snapshots The retained scan history for a project.
snapshot_diff snapshot-diff What changed architecturally between two scans.
architecture_trends architecture-trends How metrics moved over recent scans, plus release notes.

Agent integration

MCP tool CLI Answers
architecture_context architecture-context A bounded task-shaped evidence bundle for a coding task.
export_agent_brief export-agent-brief A ready-to-paste markdown orientation brief for agent memory files.
annotate_component annotate-component Record a durable annotation on a component.
list_annotations list-annotations Durable agent annotations recorded on components.

Scanning and maintenance

MCP tool CLI Answers
scan_project scan Build or refresh the graph (auto, full, or incremental).
remove_project remove-project Delete a project and its graph.
cleanup_stale_scans cleanup-stale-scans Drop failed, cancelled, or abandoned scan records.
maintain_database maintain-database Integrity check, checkpoint, optimize, or atomic backup.

Read tools are annotated read-only and idempotent. Five tools write: scan_project rebuilds the graph directly, and the other four (annotate_component, remove_project, cleanup_stale_scans, and maintain_database) preview by default and only apply once called with execute set. remove_project and cleanup_stale_scans are additionally annotated destructive, which is what makes a client ask before running them.

Eight commands are CLI-only: version, serve, watch, session-brief, install-agent-plugin, allow-root, and the export-bundle/import-bundle pair that moves a graph between databases. The server also exposes per-project MCP resources (summary, boundaries, brief) and prompts (orient, review_diff), which have no CLI equivalent because they are MCP-protocol surfaces.

Install

The recommended distribution is Docker: built from digest-pinned base images, it carries PHP 8.5, Node 26, Python, Composer, SQLite, the PHP parser, the TypeScript compiler, and a prebuilt Rust worker, so the scanned project needs none of them.

docker build --target runtime -t knossos-mcp:dev .
docker run --rm knossos-mcp:dev doctor --json

Scan a project with networking disabled and the source mounted read-only:

docker run --rm --network none \
  --mount type=bind,source=/absolute/project,target=/workspace,readonly \
  --mount type=volume,source=knossos-data,target=/data \
  knossos-mcp:dev scan /workspace --json

Recover persisted project IDs later without exposing absolute roots:

docker run --rm \
  --mount type=volume,source=knossos-data,target=/data \
  knossos-mcp:dev list-projects --json

A native install needs PHP 8.3+ (with JSON, PDO, PDO SQLite), Node 22+, Python 3.11+, Composer 2, and Git; Cargo 1.82+ is optional and enables the Rust scanner. Each is a floor, not a range.

Registering the server

Register the server once, for your user. tools/install writes this for you; the shape matters more than the mechanism:

{
    "mcpServers": {
        "knossos": {
            "command": "/absolute/Knossos-MCP/bin/knossos",
            "args": ["serve"],
            "env": {
                "KNOSSOS_DATA_DIR": "/absolute/knossos-data",
                "KNOSSOS_ROOTS_FILE": "/absolute/knossos-data/roots.json"
            }
        }
    }
}

Three things are deliberate. The command is absolute, so the server cannot resolve to whatever checkout the client happened to launch it from. There is no --allow-root: the roots file governs, and it is re-read per request, so granting another project needs no restart. And KNOSSOS_DATA_DIR is pinned, which is what keeps one graph. Leave it out and the location falls back to <cwd>/.knossos, so the server, the CLI you type, and the session-brief hook can each end up addressing a different database of the same project without anything warning you.

Docker, native, and client-specific variants are in installation.

Codex

For a native checkout, register the stdio server with the Codex CLI. Pin the data and roots paths so the CLI and server use one graph:

codex mcp add knossos \
    --env KNOSSOS_DATA_DIR="$HOME/.knossos" \
    --env KNOSSOS_ROOTS_FILE="$HOME/.knossos/roots.json" \
    -- /absolute/path/to/Knossos-MCP/tools/mcp-serve

For the recommended Docker install, build the image first and keep the host project at the same absolute path inside the container:

docker build --target runtime -t knossos-mcp:dev /absolute/path/to/Knossos-MCP
codex mcp add knossos -- docker run --rm -i --network none \
    --mount type=bind,source=/absolute/project,target=/absolute/project,readonly \
    --mount type=volume,source=knossos-data,target=/data \
    knossos-mcp:dev serve --allow-root=/absolute/project

Claude Code

The equivalent native registration is:

claude mcp add knossos --scope user \
    -e KNOSSOS_DATA_DIR="$HOME/.knossos" \
    -e KNOSSOS_ROOTS_FILE="$HOME/.knossos/roots.json" \
    -- /absolute/path/to/Knossos-MCP/tools/mcp-serve

The optional Claude session-orientation plugin is a separate install; after the server is working, preview it with knossos install-agent-plugin and add --execute to apply it. Codex uses the MCP server registration above and does not need that Claude-only hook plugin.

Codex architecture skill

This checkout also includes a Codex plugin containing the same Knossos routing skill used by the Claude integration. It complements the MCP server registration above; install both when you want graph-backed tools and automatic question routing in Codex:

codex plugin marketplace add /absolute/path/to/Knossos-MCP
codex plugin add knossos@knossos-dev
codex plugin list

The marketplace is repo-local at .agents/plugins/marketplace.json, and the plugin source is plugins/knossos. Start a new Codex session after installing or updating it so the skill is loaded. The Claude SessionStart hook is not portable to Codex, so Codex gets the shared routing skill while Claude keeps its optional session-brief hook.

Installation pitfalls

  • Native installation needs PHP 8.3+ with JSON/PDO/PDO SQLite, Node 22+, Python 3.11+, Composer 2, and Git. Cargo 1.82+ is optional. If PHP or Composer is absent, use the Docker image instead of registering tools/mcp-serve and expecting it to start.
  • The image is not published yet. docker build --target runtime from this checkout is required; an unqualified docker build selects the repository's CI quality stage, not the server runtime, and docker pull knossos-mcp:dev cannot replace it.
  • Docker stdio needs -i and must not use -t; terminal framing can corrupt the NDJSON MCP stream. If Docker reports a socket permission error, enable a rootless runtime or grant the invoking user access to Docker before starting the Codex/Claude client.
  • Keep KNOSSOS_DATA_DIR and KNOSSOS_ROOTS_FILE explicit and use absolute paths. The fallback <cwd>/.knossos can silently create a second graph.
  • In Docker, mount each allowed project read-only at the same absolute path inside the container and pass that same path to --allow-root; otherwise host paths in MCP requests will not match the container filesystem.
  • Docker runs the service as www-data. A host Git checkout owned by another UID can therefore produce Git's dubious ownership warning; scanning still works, but Git-aware metadata and change-impact queries may be degraded until the container's Git safe-directory policy is configured for that path.

Session orientation for Claude Code

A separate, optional plugin injects a short session brief at the start of each Claude Code session: whether the graph is fresh, the project's boundary rules and recorded notes, and its entry points and hubs. The same plugin ships a routing skill that the brief arms at the end of every session it renders: it decides which questions a session brings back to the graph, and which it keeps answering by grepping and reading files.

knossos install-agent-plugin           # previews; add --execute to apply

The hook runs whatever knossos binary it can find on the machine and fails silently when it finds none, so a symlink is usually the missing step:

ln -s /absolute/Knossos-MCP/bin/knossos ~/.local/bin/knossos

Registering the MCP server and installing the plugin are separate steps and stay that way. The full picture, including containerised installs and why there is no public marketplace route, is in the agent plugin guide.

Supported languages

Language Extraction Framework enrichment
PHP 8.3 or newer Declarations, inheritance, calls, construction, types, injection Laravel, Symfony
TypeScript/JavaScript Compiler symbol resolution, imports, calls, types, project references, Vue/Svelte/Astro components Next.js, React, Vue, stores, endpoints
Python 3.11 or newer Standard-library AST in an isolated interpreter; manifests, packages, calls, routes FastAPI, Django, Flask, Celery
Rust 1.82 or newer, optional on a native install syn parsing; Cargo manifests, cross-file impls, routes; never invokes cargo/rustc Details and limits

Mixed repositories reconcile into one graph. Third-party scanners plug in as isolated worker processes through the scanner SDK.

Safety model

  • Scanning never installs dependencies, executes project code, or boots a framework; workers are supervised, resource-capped, and their output is untrusted until it passes schema and limit validation.
  • The allow-list is a security boundary, not a convenience. serve refuses to start with no root from --allow-root, KNOSSOS_ALLOWED_ROOTS, or the roots file. That file is re-read per request so one installation can serve every project; Knossos only ever reads it, so widening the boundary stays a deliberate act recorded on disk.
  • The SQLite database is derived and rebuildable; source mounts stay read-only. The one exception is architecture_context's opt-in include_source, which reads a bounded query-time excerpt (≤40 lines) through the same root guard as scanning and degrades to unavailable rather than failing, so it does not require write access.
  • The Git-backed diff tools do invoke git inside the project, with repository-controlled command hooks (core.fsmonitor, core.hooksPath, diff.external, and any .gitattributes filter/textconv driver) forced off, core.pager neutralised by --no-pager at each call site, and a minimal environment.
  • MCP stdio is the default and recommended transport. The constrained loopback-only Streamable HTTP profile and its deployment limits are documented in the HTTP threat model.
  • Failed work is never activated: the last complete scan remains the queryable graph. See the fault recovery matrix.

Documentation

docs/README.md is the index. The most-used entries:

Development

One versioned quality profile runs locally, in Git hooks, and in CI:

tools/quality-container fast
tools/quality-container full

fast covers linting, static analysis, formatting, hygiene, and the whole test suite; full adds security audits, coverage floors, performance budgets, mutation score, and supply-chain assurance. Details are in quality gates.

See CONTRIBUTING.md for the contribution workflow, the Conventional Commit prefixes that drive releases, and how to add a language scanner.

Further reading

License

MIT.


Built by Tim Schipper and released as open source under Aranea Development.

About

Local-first MCP server that scans a repository once and answers architecture questions from an evidence-backed graph, so agents stop re-reading the source tree. Impact analysis, dependency cycles, boundary policies and diagram export.

Topics

Resources

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages