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.6.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.6-py3-none-any.whl (5.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: axiom_graph-1.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 78808606d30ff265a909499eb5eb36e8930aa5631eec378c6e1bf0163c0a0de2
MD5 dabcdf069c49d7a86609e211610b7fbd
BLAKE2b-256 92afe3e14b1c61bb36ecd936a558a07951d14155bbf378f7df86d0bd672f0e67

See more details on using hashes here.

File details

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

File metadata

  • Download URL: axiom_graph-1.0.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 c87200a93b5432cbd5671317c5f25d2f88a9a8b39e72c6fe27e59fac3d242a7f
MD5 859577a51454f1c2c25a943f6f93e7de
BLAKE2b-256 c54af6d59df1dc429efba494dc7f270b27e713995a5121ec9640daf6826c8910

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