Skip to main content

Multi-language workspace code graph orchestrator

Project description

codegraph

Multi-language workspace code graph orchestrator.

Auto-discovers services, frontends, gateways, and libraries in a workspace, orchestrates builds using language-specific tools (gograph, tsgraph, pygraph), merges their graph.json outputs into a unified graph, and exposes a single MCP server for querying any symbol across any service.

Install from git source only. Do not use PyPI or npm — there are unrelated packages with the same names. All 4 repos must be installed together from source to stay in sync.

Quick Start

# 1. Clone all 4 repos as siblings
git clone https://github.com/shvmgyl15/gograph
git clone https://github.com/shvmgyl15/tsgraph
git clone https://github.com/shvmgyl15/pygraph
git clone https://github.com/shvmgyl15/codegraph

# 2. Run the install script (builds all tools from source)
cd codegraph && ./scripts/install.sh

# 3. Create workspace config
#    (or run from a directory with go.mod/package.json/pyproject.toml subdirectories)
echo '{"version":1,"entries":[{"name":"frontend","path":"./frontend","language":"typescript","type":"frontend"},{"name":"api","path":"./api","language":"python","type":"service"}]}' > ../codegraph.json

# 4. Build the unified graph
codegraph build

# 5. Query across all services
codegraph query "getUser"
codegraph callers "get_user"
codegraph routes
codegraph orphans

# 6. Start MCP server for AI agents
codegraph mcp

# 7. Generate .opencode.json for AI agent integration
codegraph add-opencode-plugin

# 8. Clean up
codegraph clean

Requirements

  • Python 3.11+
  • Go 1.22+ (for gograph)
  • Node.js 20+ (for tsgraph)
  • uv (Python package manager)

Install

# Install all tools from local git source:
./scripts/install.sh

# This builds:
#   gograph  → ~/.local/bin/gograph   (from ../gograph)
#   tsgraph  → ~/.local/bin/tsgraph   (from ../tsgraph)
#   pygraph  → ~/.local/bin/pygraph   (from ../pygraph)
#   codegraph → ~/.local/bin/codegraph (from current dir)

The script looks for sibling repos (../gograph, ../tsgraph, ../pygraph). It builds each from source and installs binaries to ~/.local/bin/.

Uninstall

./scripts/uninstall.sh

Removes all binaries from ~/.local/bin/, all .gograph/.tsgraph/.pygraph/.codegraph output directories, virtual envs, node_modules, caches, and lock files from all 4 repos.

Configuration

Create codegraph.jsonc or codegraph.json at your workspace root:

{
  "version": 1,
  "auto_discover": true,
  "entries": [
    { "name": "frontend",     "path": "./frontend",    "language": "typescript", "type": "frontend" },
    { "name": "api-gateway",  "path": "./api-gateway", "language": "python",     "type": "gateway" },
    { "name": "user-svc",     "path": "./user-svc",    "language": "go",         "type": "service" },
    { "name": "py-common",    "path": "./libs/py-common", "language": "python",  "type": "library" }
  ],
  "plugins": ["./scripts/custom_enrichment.py"]
}

When auto_discover: true, codegraph probes subdirectories for go.mod, package.json, pyproject.toml, Cargo.toml, pom.xml etc.

The --root parameter

--root specifies the workspace root directory — the same directory where you ran codegraph build. It tells codegraph where to find the .codegraph/ output folder. It is NOT a query scope filter.

# Build in /home/user/myproject
codegraph build --root /home/user/myproject

# Query the same workspace
codegraph context get_user --root /home/user/myproject

If you pass the wrong --root, codegraph suggests the correct one.

CLI Commands

Command Description
status List discovered entries with build status
build Build graph for all entries (--entry for one)
clean Remove .codegraph/ output directory
query <pattern> Search symbols by regex or substring
callers <name> Who calls a given symbol
callees <name> What a symbol calls
routes List all HTTP routes (--entry, --type)
impact <name> BFS downstream blast radius (--max-depth)
orphans Dead code detection (--all, --exclude-type)
context <name> Full bundle: symbol + callers + callees + tests
trace <message> Error flow search with reverse call chain
cross-service Cross-service HTTP call edges
add-opencode-plugin Generate .opencode.json for AI agent config
mcp Start MCP stdio server

MCP Tools (for AI Agents)

All MCP tool responses include a duration_ms field showing how long the query took. List responses are wrapped in {"items": [...], "duration_ms": N}.

Tool Description
entry_status List entries with language, type, build status
query_symbols Search symbols across all entries
callers / callees Who calls / what a symbol calls
context Symbol + callers + callees + tests
routes HTTP routes with entry/type/path/method/handler filters
impact Blast radius with max depth
orphans Dead code with include-public and exclude-type
trace Error message search with backtrace
cross_service_calls Cross-service HTTP call edges
add_opencode_plugin Generate AI agent config
dispatch_map List dispatch handlers with entity/command filters
trace_async_flow Resolved steps for a named flow
flow_warnings Flow completeness warnings
sse_edges Backend-to-frontend SSE connections

Performance

  • Build: Entries are built in parallel (4 workers). Per-entry timing shown.
  • MCP queries: The graph is loaded and indexed once, then cached in memory for subsequent queries within the same MCP session. Each response includes duration_ms so you can monitor performance.

Plugin System

User-provided Python scripts that run post-merge to enrich the graph and/or register custom MCP tools. Configured in codegraph.jsonc:

{ "plugins": ["./scripts/enrich.py"] }

Graph mutation

from codegraph.graph.types import UnifiedGraph

def run(graph: UnifiedGraph) -> None:
    # Mutate graph in-place
    graph.cross_service_edges.append({
        "source_entry": "frontend",
        "source_file": "src/api.ts",
        "source_line": 10,
        "source_symbol": "loadUsers",
        "method": "GET",
        "url_pattern": "/api/users",
        "target_entry": "api",
        "target_route_path": "/api/users",
        "target_route_handler": "get_users",
        "confidence": "high",
    })

MCP tool registration

Use the optional register_tools(graph) hook to expose custom MCP query tools:

from codegraph.graph.types import UnifiedGraph
from codegraph.plugin import MCPTool

def register_tools(graph: UnifiedGraph) -> list[MCPTool]:
    return [
        MCPTool(
            name="my_tool",
            description="Describe what it does",
            input_schema={
                "type": "object",
                "properties": {
                    "filter": {"type": "string"},
                },
            },
            handler=lambda args, g: json.dumps({"items": [...]}),
        ),
    ]

Tools are namespaced as plugin.<filename>.<name> in the MCP server.

Built-in plugin

async_flow_tools is auto-loaded and registers 4 tools:

  • dispatch_map — List dispatch handlers by entity/command
  • trace_async_flow — Resolved steps for a named flow
  • flow_warnings — Completeness warnings (deadends, missing subscribers)
  • sse_edges — Backend-to-frontend SSE connections

Async flow configuration

Define event boundaries (Kafka, SSE, callbacks, etc.) and flows in codegraph.jsonc:

{
  "event_boundaries": [
    {
      "name": "kafka_publish",
      "type": "producer",
      "match": { "callee": "producer.send", "args": { "topic": "topic" } }
    },
    {
      "name": "callback_handler",
      "type": "consumer",
      "match": { "interface": "CallbackHandler" }
    }
  ],
  "flows": [
    {
      "name": "order_creation",
      "steps": [
        { "type": "db_callback", "dispatch_key": { "entityType": "ORDER" },
          "success": [{ "type": "kafka_bridge", "topic": "orders" }],
          "failure": [{ "type": "sse_push" }]
        }
      ]
    }
  ]
}

Troubleshooting

Problem Solution
codegraph: command not found Run ./scripts/install.sh — make sure ~/.local/bin is on PATH
Graph not found at ... You passed a wrong --root. Run codegraph build in your workspace root first, then use the same root for queries.
MCP queries are slow First call loads and indexes the graph (takes a few seconds for large workspaces). Subsequent calls use the in-memory cache and are fast.
pip install codegraph installs wrong package codegraph is NOT on PyPI. Use ./scripts/install.sh from the git repo.
npm install tsgraph installs wrong package tsgraph is NOT on npm. Use ./scripts/install.sh from the git repo.

Architecture

codegraph (orchestrator)
  ├── gograph  ─── indexes Go codebases
  ├── tsgraph  ─── indexes TypeScript/Next.js codebases
  └── pygraph  ─── indexes Python/Flask codebases

Output: .codegraph/workspace.graph.json  (merged)
        .codegraph/manifest.json          (entry metadata)
  • Each per-language tool produces its own graph.json
  • codegraph merges them, stamps entries with metadata
  • Cross-service edges are detected via URL → route matching
  • Plugins can enrich the graph post-merge
  • Single MCP server exposes all query tools
  • WorkspaceQuery is cached in memory across MCP calls

Related

  • gograph — Go codebase indexer
  • tsgraph — TypeScript/React/Next.js indexer
  • pygraph — Python/Flask codebase indexer

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

workspace_graph-0.3.17.tar.gz (185.6 kB view details)

Uploaded Source

Built Distribution

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

workspace_graph-0.3.17-py3-none-any.whl (44.8 kB view details)

Uploaded Python 3

File details

Details for the file workspace_graph-0.3.17.tar.gz.

File metadata

  • Download URL: workspace_graph-0.3.17.tar.gz
  • Upload date:
  • Size: 185.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for workspace_graph-0.3.17.tar.gz
Algorithm Hash digest
SHA256 77846246a03380ab94f0a3fdbdd3454c94048f3d4af8c2ae1bc32981bdf47695
MD5 8dbc9d1362dd2b598c55117a14852eb8
BLAKE2b-256 121d690f53caaaae7d4c784f24b76018f67ab4d6b63f059c483290fc127fc4e7

See more details on using hashes here.

File details

Details for the file workspace_graph-0.3.17-py3-none-any.whl.

File metadata

  • Download URL: workspace_graph-0.3.17-py3-none-any.whl
  • Upload date:
  • Size: 44.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for workspace_graph-0.3.17-py3-none-any.whl
Algorithm Hash digest
SHA256 11bec3c45de385d430c904d5f7cb2f1c67d98a399c2d429c2fdb1507ba718b6a
MD5 d8d4e17c650e1c93caed1c7088b4c836
BLAKE2b-256 852497b950daea0f0d34b9612fac465c9c6c5a576ffc3009ef5eb3ad4cd5e452

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