Skip to content

Commit 1a6414c

Browse files
committed
docs: update for explicit check_engine install flow
1 parent 549735e commit 1a6414c

3 files changed

Lines changed: 34 additions & 12 deletions

File tree

CHANGELOG.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@
66
- Python proxy shim (paths, bootstrap, proxy, error shim).
77
- Vendored CodeGraph engine from upstream v0.9.7.
88
- Verified `build-bundle.sh` produces a working local-platform bundle.
9-
- Fixed `_launcher_path` in `bootstrap.py`: tarball extracts to
10-
`engine/codegraph-<tag>/bin/codegraph` (not `engine/bin/codegraph`);
11-
updated path to include the platform subdirectory.
12-
- End-to-end smoke test verified: shim spawns engine, tools list returns ~9
9+
- End-to-end smoke test verified: shim spawns engine, tools list returns ~10
1310
codegraph_* tools, symlink + DB materialize at expected paths.
11+
- **UX revision:** the engine binary (~45 MB) is no longer downloaded
12+
silently on first start. Instead, the shim exposes a single
13+
`codegraphagent_check_engine` tool that the agent must call first to
14+
trigger the download. Subsequent calls return immediately. This replaces
15+
a silent 30-60s stall during MCP initialize with a visible, deliberate
16+
tool call.

README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,41 @@ trace) via a vendored fork of [CodeGraph](https://github.com/colbymchenry/codegr
66

77
## What it does
88

9-
CodeGraphAgent installs into a BioRouter session and exposes 9 MCP tools
9+
CodeGraphAgent installs into a BioRouter session and exposes 10 MCP tools
1010
(`codegraph_search`, `codegraph_callers`, `codegraph_callees`,
1111
`codegraph_trace`, `codegraph_impact`, `codegraph_node`, `codegraph_explore`,
12-
`codegraph_context`, `codegraph_status`) that let the agent answer "where is X
13-
used?", "what does Y call?", and "what breaks if I change Z?" against the
14-
current project — without re-parsing the codebase on every query.
12+
`codegraph_context`, `codegraph_status`, `codegraph_files`) that let the
13+
agent answer "where is X used?", "what does Y call?", and "what breaks if I
14+
change Z?" against the current project — without re-parsing the codebase on
15+
every query.
1516

16-
The index lives at `<project>/.biorouter/codegraph/codegraph.db`. On first
17-
use the extension downloads a vendored CodeGraph engine bundle (~50 MB) from
18-
this repo's GitHub Releases.
17+
The index lives at `<project>/.biorouter/codegraph/codegraph.db`.
18+
19+
## First-time install flow
20+
21+
When you first enable CodeGraphAgent in a session, the engine binary (~45 MB)
22+
is **not** downloaded automatically. Instead, the extension exposes a single
23+
tool, `codegraphagent_check_engine`. Ask the agent to call it, or call it
24+
yourself — it'll download + verify + extract the engine, taking about
25+
30-60 seconds. After that, all the `codegraph_*` tools become available and
26+
work transparently.
27+
28+
This is intentional: the download is deliberate and visible, rather than
29+
hidden in a silent stall during MCP initialize.
1930

2031
## Install
2132

2233
Once a `.brxt` release is published, BioRouter installs the extension via:
2334
`Settings → Extensions → Install from file → codegraphagent.brxt`.
2435

36+
## Configuration (optional env vars)
37+
38+
| Variable | Purpose |
39+
| --- | --- |
40+
| `CODEGRAPH_ENGINE_PATH` | Path to an already-extracted engine bundle. Skips the on-first-use download — useful for air-gapped or CI environments. |
41+
| `CODEGRAPH_ENGINE_VERSION` | Override the pinned engine release tag. |
42+
| `CODEGRAPH_NO_WATCH` | Set to `1` to disable the file watcher (slow filesystems like WSL2). |
43+
2544
## Status
2645

2746
v0.1.0-rc1 — initial release wrapping upstream CodeGraph unchanged.

manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "codegraphagent",
33
"display_name": "CodeGraphAgent",
4-
"description": "Pre-indexed code knowledge graph (callers, callees, impact, trace) via vendored CodeGraph engine. Per-project index stored at <project>/.biorouter/codegraph/.",
4+
"description": "Pre-indexed code knowledge graph (callers, callees, impact, trace) via a vendored CodeGraph engine. First use: call codegraphagent_check_engine to download the ~45 MB engine bundle (one-time, takes 30-60s). After that, the codegraph_* tools become available. Per-project index stored at <project>/.biorouter/codegraph/.",
55
"version": "0.1.0",
66
"entry_point": "codegraphagent",
77
"repository": "https://github.com/Broccolito/CodeGraphAgent",

0 commit comments

Comments
 (0)