Skip to main content

Project knowledge indexer for AI agents — scans code, tracks documentation staleness, and serves a knowledge graph to AI agents via MCP

Project description

Cortex

A project knowledge indexer that scans your codebase, builds a structured graph of modules, functions, classes, and documentation, and tracks when docs drift from the code they describe. Designed for AI-assisted development -- cortex gives agents structured access to your project through the Model Context Protocol (MCP).

Quick Start

pip install axiom-graph[viz]

cortex init /path/to/your/project    # scan and build the index
cortex check /path/to/your/project   # see what's stale
cortex viz /path/to/your/project     # launch the dashboard

Features

  • Knowledge graph -- indexes Python (and JS/TS via tree-sitter) into nodes and edges: functions, modules, classes, docs, tests, and their relationships
  • Staleness detection -- two-dimensional tracking (own content changes + linked dependency changes) with transitive propagation through doc chains
  • MCP server -- 29 tools for AI agents to search, read, navigate, and modify the index over the Model Context Protocol
  • Viz dashboard -- interactive browser UI with graph view, list view, doc manager, workflow explorer, and detail panels
  • DocJSON -- structured documentation format that links sections to code nodes, enabling automated drift detection
  • dFlow integration -- optional workflow/task decorators with step markers, indexed alongside code
  • CI gate -- cortex check --fail-on any in GitHub Actions prevents stale docs from merging

MCP Server Setup

The MCP server is how AI agents interact with cortex. It uses stdio transport.

Claude Code

Create .mcp.json in your project root:

{
  "mcpServers": {
    "cortex": {
      "type": "stdio",
      "command": "/path/to/your/venv/bin/python",
      "args": ["-m", "cortex.mcp_server"],
      "env": {
        "CORTEX_LOG_LEVEL": "INFO"
      }
    }
  }
}

VS Code (Copilot / Continue)

Add to .vscode/settings.json:

{
  "mcp.servers": {
    "cortex": {
      "command": "/path/to/your/venv/bin/python",
      "args": ["-m", "cortex.mcp_server"],
      "env": {
        "CORTEX_LOG_LEVEL": "INFO"
      }
    }
  }
}

Any MCP client

The entry point is cortex-mcp (installed as a console script) or python -m cortex.mcp_server. Both use stdio transport -- JSON-RPC on stdin/stdout, logs on stderr.

Logging

Variable Default Description
CORTEX_LOG_LEVEL INFO DEBUG, INFO, WARNING, ERROR
CORTEX_LOG_FILE (none) Path to a rotating log file (5 MB max, 2 backups)

Set CORTEX_LOG_LEVEL=DEBUG to see tool entry/exit timing, SQL queries, and build details. Logs always go to stderr; CORTEX_LOG_FILE adds a file copy.

Documentation

Full documentation is available as a consumer docs site:

pip install axiom-graph[viz]              # includes mkdocs-material
cortex render-site /path/to/project  # generates site/ directory
cortex render-site /path/to/project --serve  # live preview at localhost:8000

Or read the DocJSON source files directly in docs/consumer/:

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

axiom_graph-1.0.4.tar.gz (4.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

axiom_graph-1.0.4-py3-none-any.whl (5.0 MB view details)

Uploaded Python 3

File details

Details for the file axiom_graph-1.0.4.tar.gz.

File metadata

  • Download URL: axiom_graph-1.0.4.tar.gz
  • Upload date:
  • Size: 4.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.9 Windows/10

File hashes

Hashes for axiom_graph-1.0.4.tar.gz
Algorithm Hash digest
SHA256 b450e296d7e611bf76489be8accd47125135f809d0f07a4bc410057843b4e2c9
MD5 1af60205332160e6cb13459e10c98279
BLAKE2b-256 f76776aa7edb659bfa3c992638046e95e61facb07d13c215e05d5727afd6eab1

See more details on using hashes here.

File details

Details for the file axiom_graph-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: axiom_graph-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 5.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.9 Windows/10

File hashes

Hashes for axiom_graph-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 effa0c5c470c38cda0fa144abee7a1855386ff9f65a7b78b16ffc8f2db1381bb
MD5 3008e72589231ee47f6e6b6306d9829f
BLAKE2b-256 05da0a258d7018c6d466b6f0cfe19ad48d3d1f054faa2b955f60dbe37ba58a07

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page