Skip to main content

Symbol-level code indexer MCP server — token-efficient AI editing with confirm-before-read flow

Project description

code-outline-graph

Symbol-level code indexer and MCP server. Parses your codebase with tree-sitter, stores symbols in SQLite + vector DB, and exposes a confirm-before-read protocol so AI assistants read only the symbols they need — not whole files.

10x–50x fewer tokens compared to reading files directly.

Install

pip install code-outline-graph

Quick Start

# Index your project (writes .mcp.json automatically)
cd your-project
code-outline-graph build .

# MCP server auto-configures via .mcp.json
# Supported clients: Claude Code, Cursor, Codex, any MCP-compatible client

CLI Commands

Command Description
code-outline-graph build [path] Index project + write MCP configs for all clients
code-outline-graph update [path] Reindex changed files only
code-outline-graph search <query> Search symbols by keyword
code-outline-graph outline <file> List all symbols in a file
code-outline-graph status [path] Show index stats
code-outline-graph serve [path] Start MCP server (stdio)
code-outline-graph install-skill Install Claude Code skill to ~/.claude/skills/

MCP Tools

The server exposes 9 tools to AI assistants:

Tool Description
resolve_edit_target NL description → top-5 symbol candidates (signatures only, no body)
read_symbol_body Read source lines for one symbol only
list_outline All symbols in a file with line ranges
get_outline_summary Compressed signatures-only outline
get_file_header Imports + top-level constants only
get_symbol Exact symbol metadata by name
find_by_keyword Keyword search across all symbol names
get_line_range Read arbitrary line slice from a file
index_project Index a directory and start file watcher

Confirm-Before-Read Protocol

1. resolve_edit_target({"description": "user login handler"})
   → [{name: "login", file: "views/auth.py", start: 45, end: 89, signature: "def login(...)"}]

2. AI picks correct candidate from signatures (no body read yet)

3. read_symbol_body({"name": "login", "file": "views/auth.py"})
   → 44 lines instead of 300-line file

Supported Languages

Python, JavaScript, TypeScript, TSX, Go, Rust, Java, C, C++, C#, Ruby, PHP, Swift, Kotlin, JSON, YAML, TOML, INI

Architecture

cli.py          CLI entry point — build/update/search/outline/status/serve
server.py       MCP server — 9 tools, file watcher lifecycle
indexer.py      Orchestrates parse → checksum → DB upsert → embeddings
parser.py       tree-sitter parsing → Symbol extraction per language
db.py           SQLite + sqlite-vec — symbols table + FTS5 + vector index
search.py       FTS search, keyword search, vector search, resolve_edit_target
watcher.py      watchdog file watcher — debounced reindex + git HEAD tracking
embeddings.py   fastembed vector embeddings for semantic search
paths.py        Per-project DB path resolution (~/.cache/code-outline-graph/)

Each project gets its own SQLite DB at ~/.cache/code-outline-graph/<hash>/vectors.db. The watcher reindexes files on save and reindexes the whole project on git branch switches.

MCP Configuration

build auto-configures all supported clients in one shot:

Client MCP config SessionStart hook
Claude Code / Cursor .mcp.json .claude/settings.json
Codex CLI .codex/config.toml .codex/hooks.json
Gemini CLI .gemini/settings.json .gemini/settings.json

It also appends usage instructions (sentinel-bounded, safe to re-run) to AGENTS.md and GEMINI.md so clients that read those files know to use the MCP tools.

The SessionStart hook runs code-outline-graph update . at the start of every AI session, keeping the index fresh without manual intervention.

Claude Code Skill

build automatically installs the Claude Code skill to ~/.claude/skills/code-outline-graph/ (SKILL.md + examples.md). The skill teaches Claude the confirm-before-read protocol and tool reference.

To install manually or update after upgrading:

code-outline-graph install-skill

Development

pip install -e ".[dev]"
pytest                        # run all tests
pytest tests/test_parser.py   # run single test file

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

code_outline_graph-0.2.10.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

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

code_outline_graph-0.2.10-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file code_outline_graph-0.2.10.tar.gz.

File metadata

  • Download URL: code_outline_graph-0.2.10.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for code_outline_graph-0.2.10.tar.gz
Algorithm Hash digest
SHA256 00f41936c8e5a0e3668b666ceb28a671bda1f87157a629213992259a5ca9d0e7
MD5 111c0482ac8dd7cae3605148d8bc8d45
BLAKE2b-256 3f4e9ea7183dd550d11fdb8f13eb392e275581edbfaf9c9bda2e00da998d435e

See more details on using hashes here.

File details

Details for the file code_outline_graph-0.2.10-py3-none-any.whl.

File metadata

File hashes

Hashes for code_outline_graph-0.2.10-py3-none-any.whl
Algorithm Hash digest
SHA256 0d11363887c8dc31f9a52217e6743243666d078e0d54d53ea5716491c045d551
MD5 232413163498eea9f028146b983266bb
BLAKE2b-256 afcfed8a9886b7f8f5a7d976438bb77359de1de111eb3ffcde677447241887fc

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