Skip to main content

OpenTrace Python agent — maps system architecture, code structure, and service relationships into a knowledge graph

Project description

OpenTrace

PyPI - Version License

Index any codebase into a knowledge graph — then query it with AI via MCP.

OpenTrace parses source code with tree-sitter, extracts classes, functions, imports, and call relationships, and stores the result in an embedded graph database. The graph is queryable through a built-in MCP server, so tools like Claude Code can search, traverse, and understand your codebase structure.

Install

pip install opentraceai

Or run directly with uv:

uvx opentraceai index .

Requires Python 3.12+.

Quick Start

1. Index a codebase

opentraceai index /path/to/repo

This parses every supported file, extracts symbols and relationships, and writes the graph to .opentrace/index.db.

$ opentraceai index ~/projects/myapp
Opening database at .opentrace/index.db ...
Indexing /home/user/projects/myapp ...
  1284 nodes, 3421 relationships, 187 files, 95 classes, 412 functions
Done in 4.2s.

2. Query via MCP

Start a stdio MCP server against the indexed database:

opentraceai mcp

The database is auto-discovered by walking up from the current directory to the git root, looking for .opentrace/index.db. You can override with --db <path>.

Claude Code

Add OpenTrace to Claude Code as a plugin, or configure it manually in your project's .mcp.json:

{
  "mcpServers": {
    "opentrace": {
      "type": "stdio",
      "command": "uvx",
      "args": ["opentraceai", "mcp"]
    }
  }
}

MCP Tools

Tool Description
search_graph Full-text search across nodes by name or properties
list_nodes List nodes by type (Class, Function, File, etc.)
get_node Get a node's full details and immediate neighbors
traverse_graph Walk relationships from a node (outgoing, incoming, or both)
get_stats Graph statistics — node/edge counts broken down by type

Supported Languages

Full extraction (symbols + calls + imports) Structural extraction (symbols only)
Python, TypeScript/JavaScript, Go Rust, Java, Kotlin, C#, C/C++, Ruby, Swift

Config and data files (JSON, YAML, TOML, Protobuf, SQL, GraphQL, Bash) are indexed as file nodes.

CLI Reference

opentraceai index [PATH]

Index a local codebase into a LadybugDB knowledge graph.

Option Default Description
PATH . Directory to index
--db .opentrace/index.db Database path
--repo-id directory name Repository identifier
--batch-size 200 Items per write batch
-v, --verbose off Debug logging

opentraceai mcp

Start a stdio MCP server exposing graph query tools.

Option Default Description
--db auto-discovered Database path
-v, --verbose off Debug logging

opentraceai stats

Display graph statistics (node/edge counts by type).

Option Default Description
--db auto-discovered Database path
--output text Output format (text or json)

opentraceai serve

Start an HTTP server exposing the graph database as a REST API.

Option Default Description
--db auto-discovered Database path
--host 127.0.0.1 Bind address
--port 8787 Bind port
-v, --verbose off Debug logging

opentraceai query QUERY_STRING

Run a Cypher or full-text search query against the graph database.

Option Default Description
--db auto-discovered Database path
-t, --type cypher Query language (cypher or fts)
--limit 100 Max rows (FTS only)
--output table Output format (table, json, or jsonl)

opentraceai export [OUTPUT]

Export the graph database as a .parquet.zip archive.

opentraceai import ARCHIVE

Import a .parquet.zip archive into the graph database.

opentraceai impact FILE_PATH

Analyze the blast radius of changes to a file.

opentraceai config

Read or write project configuration (.opentrace/config.yaml). Subcommands: set, get, show, path.

opentraceai login / logout / whoami / refresh

Authenticate with api.opentrace.ai.

Development

uv sync          # Install dependencies
uv run pytest    # Run tests
uv run ruff check src/ tests/   # Lint
uv run ruff format src/ tests/  # Format

Part of OpenTrace

This package is the CLI/MCP component of OpenTrace, an open-source platform for mapping system architecture into knowledge graphs. The full project also includes a browser-based graph explorer at oss.opentrace.ai.

License

Apache License 2.0

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

opentraceai-0.4.0.dev2963.tar.gz (243.6 kB view details)

Uploaded Source

Built Distribution

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

opentraceai-0.4.0.dev2963-py3-none-any.whl (124.5 kB view details)

Uploaded Python 3

File details

Details for the file opentraceai-0.4.0.dev2963.tar.gz.

File metadata

  • Download URL: opentraceai-0.4.0.dev2963.tar.gz
  • Upload date:
  • Size: 243.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for opentraceai-0.4.0.dev2963.tar.gz
Algorithm Hash digest
SHA256 d8cdd90dda0fe58c7219130d43a58e65208c4217c1dc09f4763c440d6dee54be
MD5 e1ef1201e4f282761ac45a6cacf58a25
BLAKE2b-256 57fa1257c646e0cd2e60bcecd1b77fda74f061bb5fab70878d49c4139330b1d3

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentraceai-0.4.0.dev2963.tar.gz:

Publisher: publish-preview.yml on opentrace/opentrace

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file opentraceai-0.4.0.dev2963-py3-none-any.whl.

File metadata

File hashes

Hashes for opentraceai-0.4.0.dev2963-py3-none-any.whl
Algorithm Hash digest
SHA256 e1444b715b768af0738a820a68985ed8da540ce2b0fc57be7a75b7e7aacb2dc9
MD5 26ed2d91991b9d8d1296d526ab238472
BLAKE2b-256 788f2b0d1b3f7b72b826c4a9bff6a3a8dec59943e2ebab2be2590abd17466e7e

See more details on using hashes here.

Provenance

The following attestation bundles were made for opentraceai-0.4.0.dev2963-py3-none-any.whl:

Publisher: publish-preview.yml on opentrace/opentrace

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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