安装后需重启编码代理,并对它说「Index this project」才会建立索引;Microsoft Defender 可能把发布二进制误报为 Trojan:Script/Wacatac.B!ml,属已知误报;Windows 若遇脚本执行策略错误,需先设 Set-ExecutionPolicy -Scope Process Bypass。
codebase-memory-mcp
DeusDataMIT活跃维护把代码、文档和基础设施连成一张持久化图谱,为开发者和 AI 代理提供本地代码智能检索,还能按改动挑选测试。
Local code intelligence for developers and AI agents. Connect code, docs and infrastructure in a persistent graph, with CBM Lens, MCP tools, agent integrations and change-aware test selection.
curl -fsSL https://raw.githubusercontent.com/DeusData/codebase-memory-mcp/main/install.sh | bash
codebase-memory-mcp daemon start --open --port=9749README 未说明显存或 CPU 要求;支持 macOS、Linux、Windows,原生后端用纯 C 实现,无需语言运行时。
本地 MCP 服务器,把代码、文档和基础设施连成持久知识图谱,供 AI 代理查询
把代码、文档和基础设施连成一张持久化图谱,为开发者和 AI 代理提供本地代码智能检索,还能按改动挑选测试。
核心能力
- 用持久本地知识图谱连接代码、文档、配置与基础设施
- 提供 17 个 MCP 工具,支持符号、文本与语义检索
- 用 Hybrid LSP 做类型解析,支持 162 种语言与文件格式
- 索引与图查询全本地运行,无需托管服务或 API 密钥
- 安装器自动配置 45 种客户端集成,含技能与钩子
容易踩的坑
用户点评
登录用户的真实使用记录,可按版本和硬件筛选还没有人点评。第一个说出真实体验的人最有价值。
- v0.12.1最新正式版2026-10-16 · 2026-10-16 23:35 UTC
v0.12.1
Every install path works again, and Helm charts join the graph.
v0.12.1 fixes v0.12.0's package installs and the other install paths we found broken while checking every channel. It also links Helm charts to what they deploy, and stops the graph from inventing a registry for container images.
Upgrading? The first index of each existing project after the upgrade is a full rebuild, once (image identities changed; see below).
Fixed: installs
- npm, PyPI and Go installs.
npm i,pnpm add,pip installand the Go wrapper could not install v0.12.0 on any platform. Each wrapper refused an archive member above 256 MiB, and every v0.12.0 binary is 331-335 MB. The size limits are gone from all three wrappers. The archive is still verified against the release'schecksums.txtbefore it is unpacked, its contents must be exactly the expected files, and the binary must answer--version. Thank you, @hydroplexus, for the precise report (#2657). - Homebrew. The formula was still at 0.10.3, and on Linux it installed the dynamically linked build, which needs glibc 2.38 (Ubuntu 22.04, Debian 12 and RHEL 9 do not have it). It now installs the current release, and on Linux the static
-portablebuild that runs on any distribution. go install. A pinnedgo install .../pkg/go/cmd/[email protected]never worked, and@latestinstalled a stale version. Releases now carrypkg/go/vX.Y.Ztags, and the wrapper installs the release matching its own version.- npm
next. Thenextdist-tag no longer points to an old release candidate; a stable release moves it. - Docs. winget and Chocolatey were listed as install channels but are not published; they are removed until they are. Windows arm64 builds ship and are now listed.
Install-path smoke tests. Every pull request and every release now installs the npm, PyPI and Go wrappers, the way a user's package manager does, against the real release archives, and runs the binary each one installed. A release is published only after these installs pass, so an installer that cannot install what we ship can no longer reach you.
Helm charts in the graph
A Helm chart used to be an isolated node. Now it links to what it deploys (#2663):
- Chart → objects (
DEPLOYS,via: chart): every Kubernetes object rendered from the chart'stemplates/(a subchart's objects belong to the subchart). - values file → Chart (
CONFIGURES):values.yamlandvalues-<x>.yamlbesideChart.yaml. - Chart → images (
DEPLOYS,ref: image): every image its objects name literally (a templated image names none).
HelmRelease → Chart → Deployment → Imageis now one traversable path. On 20 infrastructure repositories, charts with no outgoing edge dropped from 238 of 260 to 109, and 2,511 chart-to-object links appeared; every other edge stayed identical.Images keep the registry the code names
An image without a registry host used to be stored under an invented
docker.io/library/...(#2654). Docker Hub is only Docker's default: Podman and CRI-O resolve short names through a search list, mirrors rewrite them, and a local build tag may exist on no registry at all. An image now keeps its name as written, withregistry: unknownwhen no host is stated; a stated host is kept (Docker Hub's spellings becomedocker.io).FROM nginxandimage: docker.io/library/nginxare now two Image nodes. This changes image identities, which is why each project is rebuilt once after the upgrade.Upgrade notes
- The first index of each existing project after the upgrade is a full rebuild, once.
- Image nodes without a stated registry now carry
registry: unknownand the name as written, instead ofdocker.io/library/....
Security Verification
Every binary published below was scanned by VirusTotal before smoke and soak testing, and the verdict for the exact shipped bytes is linked per product (decisive eng
- npm, PyPI and Go installs.
- v0.12.02026-10-15 · 2026-10-15 22:08 UTC
查看更新说明
v0.12.0
Meet CBM Lens, and a code graph that reads your documentation.
v0.12.0 is the biggest release of codebase-memory-mcp yet: 231 merged pull requests since v0.11.0, 40 of them from the community.
Four headlines define it.
-
CBM Lens Beta: the code graph, for humans. Until now the graph's power reached people only through their agents. Lens is our new human interface. It brings the code knowledge graph to you directly. It ships inside the binary you already run and listens on loopback only. It puts source, the graph, the architecture, index coverage and a browser-local assistant side by side, and every fact it shows says where it comes from. Lens is built on the work of @BernhardJackiewicz, who now joins the project to own it.
-
Documentation joins the graph. Until now the graph stopped where the code stopped. Now doc comments, Markdown, reStructuredText, AsciiDoc and PDF documents, architecture decision records, diagrams and OpenAPI specs are part of it. Each is linked to the functions, types and files it talks about. An agent can now traverse your documentation and land on the exact code a page describes, and walk from a function back to every page that explains it. So can you, in Lens. Linking is strict by design: a reference becomes an edge only when it names exactly one definition. Link families that have not yet cleared their accuracy bar are counted and reported, never guessed into the graph.
-
Smart CI: the graph picks the tests.
detect_changescan now say which tests a change can affect. It seeds the graph from the diff, walks everything that depends on the changed code, and names the tests at the end of those paths, each with its reason. When the evidence is missing or doubtful, it answers "run everything" and says why; it never narrows silently. codebase-memory-mcp's own CI is the first user: pull requests run only the test lanes their change touches, and the graph's test selection runs beside every PR. -
Infrastructure as code in the graph. Kubernetes manifests, Helm charts, Flux and Argo CD, Compose files, Dockerfiles and the scripts, Makefiles and CI jobs that deploy them now link up. A Service can be followed through its workload, its image and its Dockerfile to the program the container runs.
The code graph itself got sharper too:
- C typedefs, macros and enumerators get identities of their own.
- Process launches become
SPAWNSedges. - Resolution fixes cover C#, C++, TypeScript, Python, PHP, Rust and Go.
Upgrading? The first index of each existing project after the upgrade is a full rebuild, once. Details are in Upgrade notes. A few identities and defaults also changed; see Breaking changes.
Welcome, @BernhardJackiewicz
@BernhardJackiewicz joins codebase-memory-mcp as the subsystem owner for the UI. @BernhardJackiewicz built the reading interface on the CBM read surface that became CBM Lens, and contributed it to the project (#2068; design and tracking in #1964). He also rewrote the README's Lens section with new walkthroughs and screenshots (#2383). From this release on he owns the UI subsystem and takes care of Lens. We are very glad to have him on board.
Highlights
- CBM Lens Beta, an interface for people. It explores a project by the file you read or the code you mark, by graph neighbourhood, and by architecture, routes and hotspots. It also explains index coverage, edits the project's architecture decision record, and answers questions about your selection with a model that runs in your browser. It is built into the binary:
codebase-memory-mcp --ui=true(#2068). - Documentation joins the graph.
- Doc-comment references become
MENTIONSedges from the documented definition to the code they name. Nine languages: C#, Go, Java, Kotlin, Rust, Perl, TypeScript/JavaScript, PHP and C (#2550, #2593). - Markdown, reStructuredText/Sphinx, AsciiDoc/Antora and PDF documents link their sections to the c
- Doc-comment references become
-
- v0.11.02026-09-15 · 2026-09-15 23:40 UTC
查看更新说明
v0.11.0
A large release, and an unusually community-heavy one: 171 pull requests merged since v0.10.8 (9 of them dependency bumps), 76 of them from contributors outside the maintainer. Thank you — this release is mostly your work. It is a minor version rather than another 0.10.x patch because the index format moves (one rebuild, below) and the tool output contract changes.
The reason v0.11.0 exists is install, uninstall and daemon-startup reliability, and memory: if cbm ever refused to install, refused to uninstall cleanly, died at startup without telling you why, or blew through the memory budget on a large repository, this is the release to take.
Two things to know before you upgrade, and one thing you will notice.
Highlights
The first run after upgrading rebuilds your index once
This is expected. It is not an error, and nothing is lost.
PR #1104 (
feb72080, by @LA-10) completes the File-node change from #1108: a File node's qualified name now keeps its file extension, soauth.pyandauth.tsin the same directory are finally distinct nodes instead of colliding on one name. That moves the on-disk index format boundary, so an index built by v0.10.8 or earlier carries the old, collided identities.Rather than migrate in place — an old collided database cannot reconstruct the siblings it lost — cbm stamps the format in
PRAGMA user_versionand takes a stale-format index through one full reindex. Your ADRs and index metadata are preserved across it (#516). After that single run, the stamp is current and incremental indexing resumes as normal.What you will see: the first
index_repository(or the first watcher/daemon-triggered index) after upgrading takes as long as a cold index of that repository instead of the usual incremental seconds. A large monorepo will feel it. Everything after that is incremental again.You may also see one
orphan_removedline on that first run — that is #2111's new sweep clearing staging files left behind by a worker that was killed under an older version. Also harmless, also once.Lean, lossless output — findability preserved, no capability removed
PR #1597 (
3909e5a0) makes CLI and MCP responses compact by default. To be explicit about what this is not: no tool was removed, no field you could query before became unreachable, and no answer got harder to find. What changed is that operational detail moved behind explicit flags and parameters, and the default response carries the graph answer itself.Kept in the default response, always:
- graph rows and node identities
- exact totals, not "about N"
- truncation state, so you always know when you are seeing a subset
- continuation cursors for everything that was omitted
Moved behind explicit opt-in: diagnostics, evidence columns, progress chatter, and JSON output.
Two companion changes complete the contract.
14c229b1adds lossless semantic pagination —max_output_tokensis enforced as a deterministic, model-neutral byte ceiling that cuts at whole semantic units instead of slicing bytes mid-record, and every omission is independently pageable. Cursors are bound to the query arguments, the result state and the index generation, so a stale cursor fails closed rather than silently paging a different snapshot.4a9fcd97adds an explicit quiet CLI mode for scripting.Measured on the same serialized MCP
tools/listfixture: 23,075 → 15,071 bytes (−34.7%), and −31.4% / −30.7% on cl100k / o200k token counts. For result tables with repeated paths, response-local directory-prefix compression cut token-shaped output by 38.3% (Unix paths) and 44.5% (Windows paths); inputs where compression would not pay are left uncompressed, so no response gets larger.Invalid UTF-8 in source is now preserved reversibly instead of being replaced, and code search is scoped to canonically indexed files with globs that stay portable to BusyBox/Alpine.
Memory: the budget is honoured, and the index needs far
- v0.10.82026-08-19 · 2026-08-19 02:42 UTC
查看更新说明
v0.10.8
Note on v0.10.7: this release supersedes v0.10.7, which was lost to a release-pipeline publishing error (published under the tag
0.10.7instead ofv0.10.7; package installers resolve the v-prefixed tag, and release immutability makes the name unrecoverable). The npm and PyPI 0.10.7 packages are deprecated/yanked for that reason — their binaries were fine, their download URLs were not. v0.10.8 carries the identical code content plus the pipeline hardening that prevents a recurrence.A community-heavy patch release: 19 pull requests merged since v0.10.6, most from contributors. Thank you all!
Graph correctness
- Cypher aggregates no longer undercount (#1196). Both truncation mechanisms are fixed:
unlabeled scans stopped collecting candidates at max_rows before aggregation ran
(#1323, @Enferlain), and relationship-expansion buffers were capped so aggregation never
saw rows beyond an internal growth limit (#1698).
count()/collect()now see the complete match set;max_rowslimits only the rows returned, as documented. - Python aliased from-imports resolve to the real definition (#1371, @Joseph-MingEn).
from .gate import execute as bridge_executenow produces a CALLS edge toexecuteitself rather than losing the call, and aliased base-class imports land on the real class node. On our django benchmark this recovered 26 INHERITS and 42 OVERRIDE edges with zero losses elsewhere, and left TypeScript graphs byte-identical. - Cross-language suffix matching for qualified-name lookups (#1647, @rudi193-cmd).
- search_graph stops returning semantic-only ghosts — results backed by nothing but a similarity edge no longer surface as if they were definite matches (#1319, @JJordan0C).
- List-valued fields extract correctly instead of collapsing to their first element (#1325, @Enferlain).
- Index responses report persisted coverage truthfully (#1326, @Enferlain): an incremental run that does not revisit a file with recorded parse gaps no longer reports those gaps as vanished — the response now composes its skipped/parse-partial summaries from the stored coverage state, falling back to per-run data only if that read fails.
Windows
- Non-ASCII search content no longer degrades to
?(#1704). The search_code raw scan pipes PowerShell output, and PowerShell 5.1 encodes that pipe in the console OEM codepage — so Cyrillic, CJK, or accented content turned into question marks depending on which console the server inherited. The pipe is now pinned to UTF-8 unconditionally. - search_code understands UTF-8 output paths and gains a context column for matches (#1253, @anfedoro).
- Code search is bounded and cancellable — abandoning a query no longer leaves an orphaned scan running (#1608, @ertankucukoglu).
Platforms & tools
- FreeBSD support (#1467, @PR9000).
- list_projects pagination: a lean default response plus offset/limit and include_details for the full view (#1181, @tmonestudio).
- Extensionless shebang scripts detect their language (#1203, @ibaldr89).
- Index-mode capability rebuild (#1263, @astandrik).
- is_test detection for tests/ directories (#1308) and a diff-aware clang-tidy hook (#1310, both @Yyunozor).
Release pipeline (the v0.10.7 lesson, hardened)
- Release gates fail closed on cancelled jobs: a timed-out gate can no longer cascade into a silently skipped test matrix (#1719).
- Malformed version inputs are refused preflight — a bare, non-v-prefixed version can never again publish an unresolvable tag (#1719).
Internal
- Test harnesses use isolated daemon runtimes so suite runs cannot touch the account daemon (#1695, @astandrik); LF checkout contracts for shell entrypoints and git hooks (#1314 @mlandolfi90, #1699 with @xumian520); the stdin-gate regression tests no longer depend on the registry shipping a zero-argument tool (#1704).
- Cypher aggregates no longer undercount (#1196). Both truncation mechanisms are fixed:
unlabeled scans stopped collecting candidates at max_rows before aggregation ran
(#1323, @Enferlain), and relationship-expansion buffers were capped so aggregation never
saw rows beyond an internal growth limit (#1698).
- 0.10.7pre-release2026-08-18 · 2026-08-18 18:22 UTC
查看更新说明
[!WARNING] Broken for npm/PyPI installs — superseded by v0.10.8. A publishing error released this under the tag
0.10.7instead ofv0.10.7. The npm/PyPI package installers resolve their downloads via the v-prefixed tag, which cannot be created retroactively (release immutability tombstones the name). Direct downloads from this page work normally — the binaries themselves are fine and fully verified. Use v0.10.8 or newer for package-manager installs, orscripts/setup.sh.What's Changed
- fix(extract): converge Function/Method is_test with the tests/ path filter by @Yyunozor in https://github.com/DeusData/codebase-memory-mcp/pull/1308
- fix(hooks): scope pre-commit clang-tidy to staged changes (#1264) by @Yyunozor in https://github.com/DeusData/codebase-memory-mcp/pull/1310
- fix(mcp): isolate semantic-only JSON search by @JJordan0C in https://github.com/DeusData/codebase-memory-mcp/pull/1319
- fix(search): preserve compound requested fields by @Enferlain in https://github.com/DeusData/codebase-memory-mcp/pull/1325
- fix(cypher): scan all unlabeled query candidates by @Enferlain in https://github.com/DeusData/codebase-memory-mcp/pull/1323
- fix(registry): drop suffix_match CALLS across language boundaries by @rudi193-cmd in https://github.com/DeusData/codebase-memory-mcp/pull/1647
- fix: rebuild index when mode adds capabilities by @astandrik in https://github.com/DeusData/codebase-memory-mcp/pull/1263
- fix(daemon): add native FreeBSD process-image identity and /home log-path alias by @PR9000 in https://github.com/DeusData/codebase-memory-mcp/pull/1467
- fix(mcp): restore scalable project discovery by @tmonestudio in https://github.com/DeusData/codebase-memory-mcp/pull/1181
- fix(discover): detect extensionless scripts by shebang by @ibaldr89 in https://github.com/DeusData/codebase-memory-mcp/pull/1203
- fix: preserve UTF-8 in search_code source by @anfedoro in https://github.com/DeusData/codebase-memory-mcp/pull/1253
- fix(build): force LF line endings for shell scripts by @mlandolfi90 in https://github.com/DeusData/codebase-memory-mcp/pull/1314
- fix: unbreak main — stdin-gate #1359 guards + Windows search_code UTF-8 pipe by @DeusData in https://github.com/DeusData/codebase-memory-mcp/pull/1704
- fix(test): isolate harness daemon runtimes by @astandrik in https://github.com/DeusData/codebase-memory-mcp/pull/1695
- fix(python): resolve aliased from-import CALLS to real def by @Joseph-MingEn in https://github.com/DeusData/codebase-memory-mcp/pull/1371
- fix(cypher): expansion materializes every matched row — the cap falsified aggregates (#1196) by @DeusData in https://github.com/DeusData/codebase-memory-mcp/pull/1698
- fix(mcp): bound and cancel Windows code search by @ertankucukoglu in https://github.com/DeusData/codebase-memory-mcp/pull/1608
- fix(build): LF contract for extensionless git hooks + a line-ending guard by @DeusData in https://github.com/DeusData/codebase-memory-mcp/pull/1699
- fix(index): preserve persisted coverage summaries by @Enferlain in https://github.com/DeusData/codebase-memory-mcp/pull/1326
New Contributors
- @Yyunozor made their first contribution in https://github.com/DeusData/codebase-memory-mcp/pull/1308
- @JJordan0C made their first contribution in https://github.com/DeusData/codebase-memory-mcp/pull/1319
- @Enferlain made their first contribution in https://github.com/DeusData/codebase-memory-mcp/pull/1325
- @rudi193-cmd made their first contribution in https://github.com/DeusData/codebase-memory-mcp/pull/1647
- @ibaldr89 made their first contribution in https://github.com/DeusData/codebase-memory-mcp/pull/1203
- @anfedoro made their first contribution in https://github.com/DeusData/codebase-memory-mcp/pull/1253
- @Joseph-MingEn made their first contribution in https://github.com/DeusData/codebase-memory-mcp/pull/1371
Full Changelog: https://github.com/DeusData/codebase-memory-mcp/compare/v0.10.6...0.10.7
Security Verif
codebase-memory-mcp: local code intelligence for AI agents via MCP
Understand your repository, from source code to the systems around it. codebase-memory-mcp is an MCP server that connects code, documentation, configuration, and infrastructure in a persistent local knowledge graph. Use it to find an unfamiliar feature, follow a call across services, trace a deployment back to its source, or assess which parts of a project a change could affect.
Give your coding agent structural context through Model Context Protocol (MCP), or query the graph directly from the CLI. The MCP server is the core of the project. Its optional visual companion, CBM Lens, is in open beta (v0.0.1), with a source reader, architecture maps, the Galaxy graph, coverage diagnostics, architecture decisions, and local code chat.
The native C backend exposes 17 MCP tools, parses languages and file formats with vendored grammars, and adds Hybrid LSP type resolution for supported languages. The installer supports 45 automatic or conditional client integrations, including client configuration, skills, agent profiles, and applicable hooks. Indexing and graph queries need no hosted service or API key. Focused graph queries can reduce repeated file reads and token use; see the measured results.
Quick start · Capabilities · Documentation · Infrastructure · Smart CI · Explore CBM Lens · Agent setup · MCP tools
Local processing: Source analysis and graph storage run on your machine. CBM Lens can optionally download a model for browser AI after you enable it; inference stays on the device. The installer writes agent configuration for the clients you select. See Security for release verification and SECURITY.md for reporting issues.
See the graph with CBM Lens (open beta v0.0.1). Folders become nested platforms, files and symbols become selectable blocks, and arrows show indexed relationships. The recording opens src/foundation in the map of this repository, selects arena.c and opens its source. Height can show source size; hotspot gravity reflects static fan-in. Still image.
Galaxy. Explore the code knowledge graph in 3D. The recording follows the outgoing relationships of cbm_arena_alloc one layer further, switches to the hierarchy and shows the two-hop call path to cbm_alloc. Edge pulses show relationship direction; they do not represent live execution. Still: two dependency layers around cbm_max_file_bytes.
Explore. Browse files in an IDE-style workspace, read syntax-highlighted source in Monaco, and keep the code graph alongside it. File impact shows what depends on the open file, and Code details shows the callers and calls of the symbol under the caret. Select code to ask the local chat about it.
The high-resolution GIFs show CBM Lens Beta on 20 October 2026; the still images were captured on 12–13 October. All show public source from this repository. See capture details for each capture's build, indexed scope and recording setup.
Why codebase-memory-mcp
- Find the right code with context: combine symbol, text, and semantic search with callers, dependencies, source snippets, and file outlines. Targeted queries and compact, paged results can reduce token use and repeated file reads; see Performance for scoped measurements.
- Connect documentation to implementation: index document sections, PDF text pages, architecture decisions, and supported references into code. Find the explanation alongside the symbol.
- Follow the system beyond source files: trace supported relationships through Docker, Kubernetes, Helm, Kustomize, Terraform/OpenTofu, Terragrunt, Ansible, scripts, Make, and CI configuration.
- Understand a change before running it: inspect affected symbols, compare indexed snapshots, and find related tests. Experimental Smart CI combines static relationships and per-test coverage for supported C/C++ test harnesses, falling back to broader runs when evidence is insufficient.
- Explore visually with CBM Lens Beta: read source, follow call paths, inspect architecture and coverage gaps, manage architecture decisions, and ask a local model about selected code.
- Equip your coding agents:
installsets up supported client configuration, durable guidance, skills, Scout/Verify/Auditor profiles, and applicable context hooks. Support varies by client; see the integration matrix. - Keep context local and reusable: indexes persist between sessions, eligible active MCP sessions can keep them synchronized, and optional graph artifacts let a team share a baseline.
- Run a native tool on your machine: standard releases include CBM Lens for macOS, Linux, and Windows. The native runtime needs no Docker or language runtime; parser grammars are included.
Quick Start
Install the latest release (macOS / Linux):
curl -fsSL https://raw.githubusercontent.com/DeusData/codebase-memory-mcp/main/install.sh | bash
The standard native release includes CBM Lens. Start it after installation with codebase-memory-mcp daemon start --open --port=9749. The Nix packages and source builds also offer builds without the UI.
Windows (PowerShell):
# 1. Download the installer
Invoke-WebRequest -Uri https://raw.githubusercontent.com/DeusData/codebase-memory-mcp/main/install.ps1 -OutFile install.ps1
# 2. (Optional but recommended) Inspect the script
notepad install.ps1
# 3. Unblock the downloaded file (removes Mark-of-the-Web restriction added by browsers/Invoke-WebRequest)
Unblock-File .\install.ps1
# 4. Run it
.\install.ps1
Note: If you see a script execution policy error, run
Set-ExecutionPolicy -Scope Process Bypassfirst, or invoke withPowerShell -ExecutionPolicy Bypass -File .\install.ps1.
Options: --skip-config (binary only, no agent setup), --dir=<path> (custom location).
Antivirus note: Microsoft Defender may flag a release binary as
Trojan:Script/Wacatac.B!ml. This is a known false positive; typically 61 of ~62 engines return clean, and the same detection family hitsgh, llama.cpp, Godot and Microsoft's own Go toolchain. See Antivirus False Positives for the evidence, how to verify the artifacts yourself, and how to report it if you think we are wrong.
Restart your coding agent. Say "Index this project": done.
-
Download the archive for your platform from the latest release:
codebase-memory-mcp-<os>-<arch>.tar.gz(macOS/Linux) or.zip(Windows)
-
Extract and install (each archive includes
install.shorinstall.ps1):macOS / Linux:
tar xzf codebase-memory-mcp-*.tar.gz ./install.shWindows (PowerShell):
Expand-Archive codebase-memory-mcp-windows-amd64.zip -DestinationPath . Unblock-File .\install.ps1 .\install.ps1 -
Restart your coding agent.
The install command automatically strips macOS quarantine attributes and ad-hoc signs the binary; no manual xattr/codesign needed.
Agent setup: skills, profiles, and hooks
Installation also equips supported coding agents to use the graph in daily work. The native install command detects clients and installs the integration pieces their documented formats support:
| Component | What it adds |
|---|---|
| MCP configuration | Connects the client to the local server and its tools. |
| Instructions and skills | Explains graph-first exploration, index freshness, coverage checks, and when to read source. |
| Scout, Verify, and Auditor profiles | Offers fast provisional lookup, task-directed verification, or bounded full verification, where custom agents are supported. |
| Session and compaction hooks | Restores graph context at supported lifecycle events. |
| Search and read hooks | Adds relevant graph context to supported searches and flags recorded coverage gaps after supported file reads. |
Hook augmentation is context-only and fail-open: it does not replace or block the requested tool call. Features vary by client and platform; some clients use durable instructions or a parent-agent handoff instead of hooks or direct subagent MCP access. Codex users review and trust installed hooks through /hooks. See Multi-Agent Support and Sessions, compaction, and subagents for exact support and activation requirements.
Hooks are enabled by default. Run codebase-memory-mcp install --no-hooks to remove CBM-managed hooks while keeping MCP registration and other integration files; the choice persists for later installs and updates. Run codebase-memory-mcp install --hooks to re-enable them, or inspect the current preference with codebase-memory-mcp config get install_hooks.
Session Coordination Daemon
CBM automatically shares one per-account coordination daemon across Claude Code, Codex, OpenCode, and every other configured client. There is no opt-in setting for MCP servers or hook clients: the first daemon-backed CBM session starts it, each session registers its own work, and a session-managed daemon stops after the final session. A daemon started with daemon start remains running until stopped. The daemon owns long-lived background services such as watchers, shared indexing jobs, and the optional UI. Closing one session cancels work owned only by that session, while work still needed by another session continues.
The detached daemon does not depend on an MCP frontend's stderr. It keeps owner-only durable records under the canonical ${CBM_CACHE_DIR}/logs directory (default ~/.cache/codebase-memory-mcp/logs):
| File | Contents |
|---|---|
cbm-daemon.log | Daemon lifecycle, watcher/indexing, UI, resource, and error events. |
daemon-conflicts.ndjson | Exact-build, coordination-ABI, and cache-root admission conflicts. |
activation-events.ndjson | Install/update/uninstall activation progress and outcomes. |
Thin frontends still write immediate startup and session-specific errors to their own stderr; MCP JSON-RPC stdout remains clean.
All active CBM processes must run the exact same version, executable build, coordination ABI, and canonical cache root. Equivalent CBM_CACHE_DIR aliases resolve to the same root; a genuinely different root is rejected while any CBM process is active. MCP servers, hooks, one-shot CLI commands, temporary index workers, and the daemon share a crash-safe OS admission barrier; starting an ordinary conflicting process fails before doing work and records an explicit conflict in ${CBM_CACHE_DIR}/logs/daemon-conflicts.ndjson.
The native install and uninstall commands are the deliberate exception to that conflict rule. For installation, download, verification, and private same-filesystem staging finish before activation so a bad candidate never disrupts active work. The native update command prints the installer command that performs the update. Activation then publishes account-wide maintenance intent, asks the daemon and every temporary local operation to cancel, and waits to a finite deadline for all coordinated CBM processes to exit. It holds the admission and lifetime barriers exclusively while changing the active binary, configuration, PATH, or indexes. New CBM work cannot enter during this window. Activation progress and results are recorded in ${CBM_CACHE_DIR}/logs/activation-events.ndjson, and a successful command tells you to restart open coding-agent sessions so they launch the activated build.
Package-manager setup (npm, PyPI, or Go) verifies and caches the native executable for that package. It does not replace the active native installation and therefore does not stop running CBM sessions. When that cached binary is executed, it still enters the same exact-build admission barrier. The shell and PowerShell installers invoke the verified candidate's native install command, so they do receive the full account-wide activation guarantee.
The ordinary cli mode runs one command locally, but it is not disconnected from the daemon above: it connects to the shared coordination daemon (starting one if none is already running) for that same admission barrier plus per-project locks on graph mutations. Its connection is a cli_session: it does not register a project watcher or open a browser, and it holds the admission lease only for the command's lifetime. The shared daemon may serve Lens according to its UI configuration and available assets. If the command's own connection is what started the daemon, that daemon exits again once the command closes and no other session is attached; if a daemon was already running, the command simply joins and leaves it exactly as found. While the command is running, a temporary monitor separately lets activation cancel that operation and its supervised worker safely; the monitor exits with the command and never becomes a standing daemon. See CLI Mode for details.
CBM Lens Beta: code visualization and source navigation
CBM Lens is an optional visual companion to the MCP server, currently in open beta (v0.0.1). Standard native releases include its browser interface, so you can launch Lens directly after installation; UI-enabled source builds include it too. It builds on CodeAtlasWeb by Bernhard Jackiewicz (design and tracking in #1964). Lens is served on loopback. Browser AI downloads its optional model only after you enable it; inference stays on-device. Each panel names where its facts come from, and what the index did not record is shown as a gap. Start the local server:
codebase-memory-mcp daemon start --open --port=9749
The browser opens at http://127.0.0.1:9749. A permanent daemon keeps the UI available after the command exits. Use daemon status to inspect it and daemon stop when you are finished. For an MCP session, --ui=true --port=9749 enables the same shared UI. Active clients must use the same executable build and cache directory.
Open your first repository
- Open the project menu and choose Add project index. You can also use
Alt+P. - Choose a local repository folder and name the index. Files stay in place.
- Start indexing and follow its reported status. You can close the dialog while it runs and reopen its activity from the project menu.
- Open the indexed project. Start with Architecture for an overview or Explore to read a file.
To bookmark a view, use ?project=<name>&workspace=architecture. Other workspace values are explore, galaxy, adr, coverage, and system.
| Workspace | What you can do |
|---|---|
| Explore | Navigate the indexed file tree and read source in Monaco. File impact shows what depends on the open file; Code details shows the callers, calls, references and related tests of the symbol under the caret. |
| Galaxy | Search and focus graph nodes, load their neighbors layer by layer, switch to hierarchy, follow a path, and open source. Back and Forward return to earlier views. The coverage shadow marks known gaps around the loaded graph. |
| Architecture | Explore the folder map, entry points, routes, hotspots, system structure, and behavior paths. Select a node or connection to inspect its evidence. |
| ADR | Read and edit the project's architecture decision record. Save explicitly; the document is stored with the index and shared with manage_adr. |
| Coverage | Check indexed, partially parsed, skipped, and excluded paths, together with available freshness information. |
| System | Inspect daemon activity, indexes, and logs. Filter logs by project, severity, or text. |
Architecture views
- Overview: move through source folders and files on a 3D map. Choose source-size or uniform height, language or kind colors, and relationship filters. Switch to Entry points to follow a static call graph from a starting symbol.
- Routes: switch between the service map and endpoint connections. Deployment metadata and indexed route evidence are shown separately; unresolved registrations remain visible.
- Hotspots: inspect symbols using measured signals such as fan-in and complexity. Gravity wells help locate frequently referenced areas. They are not a code-quality score.
- System structure: inspect component dependencies, expand groups, isolate cycles, and follow connections back to source evidence.
- Behavior: choose a source and a reachable destination to inspect static call paths and their source statements. These paths show possible relationships, not a recorded execution order. Runtime observations require separately ingested traces.
Drag a 3D view to orbit, scroll to zoom, and select a node or edge to inspect it. Edge colors distinguish relationships, and pulses indicate their direction. Reduced-motion preferences pause the pulses. Large views show their limits and omitted counts. A missing edge can reflect an indexing or display limit, so check Coverage and the source before drawing conclusions.
Chat with your codebase locally
Open Chat with the panel button at the top right to ask about the code you are looking at. In Explore it uses the open file or the exact text you have selected; in Galaxy it uses the selected node and its loaded neighbors. You can also attach graph evidence through Add context.
- Click the robot icon at the top right to open the agent configuration.
- Choose a local model. The default Qwen2.5 Coder 0.5B downloads about 567 MB; Qwen3 0.6B, LFM2.5 1.2B and Qwen3.5 2B are larger options. All need WebGPU with
shader-f16support. - Click Download & load. Model files come from Hugging Face; inference runs in your browser, with no hosted chat API or API key. A model that is already in the browser cache loads with Load model (cached, no download).
- Ask a question. The composer shows the file or selection that will accompany it. Select a smaller range when you want to focus the answer.
Questions about callers and callees, such as "Who calls cbm_pipeline_run?", are answered from the loaded graph without the model, and the answer says so. When you select a symbol, the chat lists its indexed facts and the lines of its code, and the model adds one sentence; that sentence is left out when it claims something the source does not show. Text written by the model is labelled as such.
The recording asks who calls arena_grow and what it calls, with both answers listed directly from the indexed graph beside the selected symbol. Still image of a model explanation and graph answer.
The chat history is kept for 24 hours in this browser, per project. Each new message uses the source currently open in the reader; earlier source snapshots are not silently accumulated, and messages about another file or selection are not sent along. If a prompt is too long for the model, older messages are left out first; if it still does not fit, CBM Lens asks you to select less code instead of cutting the code. This chat explains the context you give it; it cannot edit files or run tools. Check its answers against the source. The small default model words things loosely, especially in languages other than English.
Search
Cmd+K or Ctrl+K opens the Galaxy search. It finds symbols, files and folders by name or path in the whole index, also nodes that are not loaded yet. For callers and callees, ask in the chat; the answer is listed from the graph.
Architecture decisions
The ADR workspace keeps an unsaved draft per project in this browser tab. It checks whether the stored document changed before saving, but the API does not provide an atomic document lock. The editor accepts up to 8,000 UTF-8 bytes. Saving changes the indexed decision document, not a file in your repository.
The Agents workspace and activity overlays are hidden in normal builds. To include them in a source build:
VITE_EXPERIMENTAL_AGENTS=true scripts/build.sh --with-ui
Activity comes from explicitly configured tool hooks. The bundled adapter supports Claude Code PostToolUse; other clients need their own adapter. Recorded events go to the local daemon, and the reader must enable activity before the browser polls them. This does not automatically observe every agent. See the frontend setup guide.
For troubleshooting, open System logs. Frontend errors and failed requests are recorded locally. GET /api/ui-log reads frontend entries from the daemon's SQLite journal; ${CBM_CACHE_DIR}/logs/ui.log is also retained as a rotating JSONL export. See the frontend README for log scope, model setup, and development details.
Auto-Index
Enable automatic indexing on MCP session start:
codebase-memory-mcp config set auto_index true
auto_index is off by default. When enabled, new projects are indexed automatically on first connection. The configurable file limit is config set auto_index_limit 50000. Previously indexed projects can be watched through auto_watch (on by default), subject to its global setting and session ownership.
Each initialized, long-lived MCP session can register its root project when it connects and any target from a successful index_repository call, including custom project names and roots in another worktree. While auto_watch is enabled, these watches belong to the registering sessions and remain while at least one owning session is connected; closing the last owner removes the watch. Under a daemon started with daemon start a watch outlives its last owning session: the project stays watched and is re-indexed in the background when it changes, until that daemon stops, the project is deleted, its directory disappears, or auto_watch is set to false. An async index registers its target only after success and while its requesting session remains connected. CLI indexing and failed MCP indexes do not register watches. Global auto_watch controls registration and removes all watches on the next refresh or registration request when set to false. index_status reports this in its watch object: watched, and either the poll cadence and last scan time or the reason it is not watched.
Watcher registration is controlled globally by auto_watch (default true). On the next refresh or registration request, true allows MCP sessions to register their root on connect and their successful index_repository targets; false removes all watches. CLI indexing and failed MCP indexes do not add watches.
To turn the watcher off entirely, set config set watcher_enabled false (default true): the background poll thread never starts and no project is registered, while auto_index and manual index_repository keep working. Unlike auto_watch, which takes effect on the next refresh or registration request, watcher_enabled is read once when the background daemon starts, so run codebase-memory-mcp daemon stop after changing it; reconnecting your MCP client alone will not restart the daemon. See docs/CONFIGURATION.md.
The watcher follows git projects only by default: a project indexed from a directory that is not a git repository is not watched and stays at its last index until you run index_repository again. To have such roots polled too, set config set watch_non_git true (default false, read when the daemon starts): they are then checked on the same cadence with a file-tree scan that uses the indexer's own ignore rules.
Linked git worktrees are indexed as their own projects by default. Set config set ignore_worktrees true to skip them on the automatic paths — useful when short-lived git worktree add checkouts would otherwise each leave behind a permanent index of the same repository. An explicit index_repository call on a worktree is then refused unless you pass index_worktree=true. See docs/CONFIGURATION.md.
Keeping Up to Date
Updates run from the install script on every platform, not from inside the running binary. codebase-memory-mcp update validates your flags and then prints the exact command to run:
# macOS / Linux
bash "<install-dir>/install.sh"
# Windows
powershell -File "<install-dir>\install.ps1"
The install script is placed next to the binary at install time, so the printed path resolves beside the executable. It is idempotent, so re-running it is the update: it stops the daemon, retires the running binary, installs the new one, and cleans up.
Why it works this way. On Windows it is a hard requirement; a running executable cannot replace its own image, so the swap has to happen from a process that is not the binary being replaced. On macOS and Linux it is a deliberate choice: an in-process updater is structurally a downloader (fetch an archive, verify it, unpack it, mark a file executable, run it), and shipping that composite in every binary to serve a command most people run a handful of times is a poor trade. The release archives now carry no download URLs at all, and cbm makes no network request of its own accord: it does not check for new versions in the background, and nothing phones home. You find out about releases from the install script, your package manager, or GitHub.
If PowerShell refuses to run the script because the file came from the internet, Unblock-File it first.
Installed through npm or pip? Update with your package manager on every platform (npm install -g codebase-memory-mcp@latest / pip install -U codebase-memory-mcp).
Uninstall
codebase-memory-mcp uninstall
Removes owned agent config entries, skills, hooks, instructions, and the installed binary. Existing graph indexes are listed and kept by default. -y/--yes, -n/--no, and noninteractive input keep them unless --delete-indexes is explicitly given. An interactive terminal without that flag is asked separately; the default answer is to keep them.
codebase-memory-mcp uninstall -y --delete-indexes # also delete every project index
codebase-memory-mcp uninstall --dry-run --delete-indexes # preview; change nothing
--delete-indexes is explicit consent and takes precedence over --no; --dry-run always preserves the files. When indexes are kept, uninstall prints their cache directory (${CBM_CACHE_DIR:-~/.cache/codebase-memory-mcp}) and how to remove them.
The install script placed beside the binary is reported, not deleted: uninstall prints its path and the rm command for it. It is left alone on purpose: it may be your own copy, a symlink into a checkout, or managed by a package manager, and an uninstaller should not delete a file it cannot prove it owns.
Features
Graph & analysis
- Architecture overview:
get_architecturereturns a compact summary by default. Request specificaspectsfor routes, hotspots, dependencies, clusters, or cycles.system_structureprovides the projection used by CBM Lens and must be requested on its own. - Architecture Decision Records:
manage_adrpersists the project's decision record across sessions; indexing also extracts supported ADR metadata and supersession from documentation files - Louvain community detection: Discovers functional modules by clustering call edges
- Change impact:
detect_changesmaps uncommitted changes to affected symbols with risk classification and can report test impact withscope: "tests";compare_graphscompares indexed snapshots - Runtime observations:
ingest_tracesadds observed call relationships from separately collected traces alongside static analysis; static call paths alone do not show what ran - Call graph: Resolves function calls across files and packages (import-aware, type-inferred)
- Dead code candidates: find functions with no indexed callers, excluding entry points. Check dynamic dispatch, coverage gaps, and framework conventions before removing code.
- Cypher-like queries:
MATCH (f:Function)-[:CALLS]->(g) WHERE f.name = 'main' RETURN g.name
Search
- Semantic search (the
semantic_queryparameter ofsearch_graph, not a separate tool): vector search across the entire graph, powered by bundled Nomicnomic-embed-codeembeddings (40K tokens, 768d int8) compiled into the binary; no API key, no Ollama, no Docker. 11-signal combined scoring (TF-IDF, RRI, API/Type/Decorator signatures, AST profiles, data flow, Halstead-lite, MinHash, module proximity, graph diffusion). - BM25 full-text search via SQLite FTS5 with
cbm_camel_splittokenizer (camelCase / snake_case aware) - Structural search (
search_graph): regex name patterns, label filters, min/max degree, file scoping - Code search (
search_code): graph-augmented grep over indexed files only
Documentation connected to code
Find the explanation behind a symbol and follow supported references back to its implementation. Documentation participates in the graph alongside source files:
- Markdown, reStructuredText, and AsciiDoc become navigable document sections; PDFs with text layers become searchable text pages. PDF extraction does not perform OCR.
- Document-to-code references and supported language doc-comment references create
MENTIONSrelationships when the target can be resolved. - Architecture decision records contribute metadata such as status, deciders, and supersession, so decisions can be explored with the code they describe.
- Supported diagrams and OpenAPI descriptions contribute structured entities. Extraction and reference resolution differ by format; not every textual mention becomes a graph edge.
Use graph and text search to locate the relevant section, follow its recorded relationships, and open the source evidence. Check check_index_coverage before treating a missing result as proof that the repository has no such documentation or reference.
Infrastructure and deployment
Ask "What deploys this service?", "Which image runs it?", or "Where does this configuration reach code?" CBM connects supported infrastructure forms to the source they build, configure, and run:
- Containers and clusters: Dockerfiles, Compose services, Kubernetes resources, Helm charts and releases, and Kustomize overlays and patches.
- Provisioning and configuration: Terraform/OpenTofu resources and modules, tfvars overrides, Terragrunt dependencies, Ansible tasks and handlers, and supported configuration keys and environment-variable access.
- Build and delivery: shell commands, Make targets, and supported CI steps that build images, invoke repository scripts, or deploy resources.
For resolvable inputs, a trace can follow Service → workload → image → Dockerfile → program, or follow deployment and configuration relationships. Use trace_path modes for topology, deployment, and run paths. These are static relationships from supported source forms; dynamic values and unresolved templates can leave gaps. See Edge types for the exact relationship rules and limitations.
Cross-service linking
- HTTP route ↔ call-site matching with confidence scoring
- gRPC, GraphQL, tRPC service detection with protobuf Route extraction
- Channel detection (
EMITS/LISTENS_ON) for Socket.IO, EventEmitter, and generic pub-sub patterns across 8 languages with constant resolution
Cross-repo intelligence
CROSS_*edges link nodes across multiple repos indexed under the same store- Cross-repo architecture summary combining services, routes, and dependencies across the indexed fleet
- Run status:
index_status(and the UI layout next tolinked_projects) carries across_repoobject,{"status":"never_run"}untilindex_repository(mode="cross-repo-intelligence")has run with that project as the source, then"ran"withlast_run_at,outcome,targets,projects_scanned,total_cross_edgesandskipped_projects. That is how you tell "never linked" apart from "linked, nothing matched". The status is stored in the project's own index next to itsCROSS_*edges, so a reindex that rebuilds the index drops both at once and the status goes back tonever_run. - Skipped stores:
target_projects: ["*"]skips an index built before the #768 schema change rather than failing the whole run. The response lists each one asskipped_projects: [{"name", "reason": "pre_768_schema", "hint": "reindex this project"}].
Smart CI and test impact
Use the graph to explain which tests a change reaches, and use that evidence to focus supported CI runs. Smart CI is experimental and has two layers:
| Layer | What it does | What you supply |
|---|---|---|
| CI job selection | Chooses jobs from the changed-file list. | Repository-specific path and job rules; this repository's selector is an example. |
| Test selection | Combines static reachability, changed tests, and admitted per-test coverage to select suites or tests. | A supported C/C++ test harness, configuration, a coverage map, and a runner that accepts named selections. |
codebase-memory-mcp test-impact select produces a selection with reasons; test-impact publish produces the graph-and-coverage bundle used as its baseline. For agent-assisted investigation, detect_changes with scope: "tests" exposes test impact through MCP.
Narrowing currently supports C/C++ family code with this repository's test conventions or declared equivalents. It is not general test selection for every language CBM indexes. Missing, stale, incompatible, or incomplete evidence broadens the selection or returns run_all; static reachability without admitted coverage never omits a suite. Begin with report-only shadow mode and validate your harness before enabling gating.
In this repository, test narrowing is wired to the Linux x86_64 test leg when TEST_IMPACT_MODE=gate; release and dry-run workflows retain full execution. See the Smart CI guide for supported conventions, coverage admission, setup, version requirements, and fallback behavior.
Edge types (selected)
CALLS: a callable is invoked at the source siteCALL_REFERENCE: a callable is used at a supported reference site (for example, a direct value argument) and resolves to one exact targetUSAGE: an identifier is used, but a unique callable target is not proven (including ambiguous or complex expressions)IMPORTS,DEFINES,IMPLEMENTS,INHERITSHTTP_CALLS,ASYNC_CALLS(cross-service); a shell script, Make recipe or CI step runningcurl/wgeton a URL it states (constant words resolved, unknown parts{}) to itsRoutewith the method its flags give: a Kubernetes Service of the repository by the path, as code clients do, any other host (a download, localhost) with the host kept; the edge keepsvia,method,url_path,host, never the user info or the querySPAWNS: the caller starts another program (subprocess.run,exec.Command,posix_spawn,Process.Start, a shell command or Make recipe running a program by path, ...); the target is aProcessnode named after the program, or<dynamic>when the program is not a literal. When a shell script, Make recipe, GitHub Actions step or Prow job runs a script of the repository (./hack/x.sh,bash hack/x.sh), the target is that script'sModule(else itsFile);make TARGET(also$(MAKE),-C,-f) targets the rule of that target, followed through included makefiles; edges from CI carryciandjob. A Dockerfile's last stageENTRYPOINT(elseCMD) spawns what the container runs (api: dockerfile): the repository script or source copied into the image, the Gomainof a binary a stage builds withgo build -o, else aProcessINFRA_MAPS: a Kubernetes Service to each workload whose pod labels carry everykey: valueof the Service's selector, within one namespaceCONNECTS_TO: a Kubernetes workload or compose service to the Service its containers' environment addresses (PRODUCT_CATALOG_SERVICE_ADDR: productcatalogservice:3550, a URL's host,<svc>.<ns>.svc..., a bare name on an*_ADDR/*_HOST/*_URL/ ... key; compose: the project's.envinterpolated): a Kubernetes Service of the same bundle and namespace, or a compose service of the same file. The edge keepsvia: env,keyandcontainer, never the valueUSAGEwithref: image: a Kubernetes workload (any pod template: containers, initContainers, CronJobs, custom resources) or a docker compose service to theImageit runs- Helm templates are rendered for their images: with the chart's values (the
ChartDEPLOYSthem,default_of: the values keys read) and with each release's (a Flux HelmRelease, a kustomizehelmChartsentry, a Terraformhelm_release:override_of). An image the render cannot know is left out, never guessed: after a change of values it does not run exactly, atplor include it cannot look into, a release value it cannot read, or a work budget it runs past. Known limit: each template file renders on its own, while Helm renders a chart's files with one shared.Values(a subchart's is its parent's.Values.<alias>), so a chart that changes.Valuesin one file and reads it in another can still show a wrong image DEPLOYS: what puts manifests, kustomizations or charts on a cluster, to what it puts there: a Flux Kustomization or Argo Application to the kustomizations / manifests / chart of its path, a Flux HelmRelease to its chart (spec.chartorchartRef→ OCIRepository), a shell command or Make recipe (kubectl apply -f/-k,kustomize build | kubectl apply,helm install/upgrade/template), a Go installer loading a chart with the Helm SDK, a Terraformhelm_release, a Terraformkubernetes_*resource the object it declares (aResourcelike a manifest's,ecosystem: terraform, when its name is a literal), a kustomization inflating a chart (helmCharts; its values file anIMPORTS). A chart outside the repository is an externalChart, keyed by its publisher when its repository URL is stated (__chart__<repository>/<name>, the same node in every project, the URL inrepository), else one per project and name; the edge saysvia(flux,argo,helmrelease,kubectl,kustomize,helm,helm-sdk,terraform,helmcharts, ...)DEPENDS_ON: a Helm chart to the charts it declares (the local chart for a resolvablefile://repository, otherwise an externalChart; the edge keepsrepository), and ago.mod/requirements.txtfile to an externalPackage; a Dockerfile to theImages it builds on (via: from,copy-from); anImageto the Dockerfile it is built from (via: build;tool:skaffold,compose,docker-buildfordocker/podman/nerdctl/buildahbuild commands in scripts, Make and CI); a compose service to the services itsdepends_on/linksnameCONFIGURES: code reading an environment variable to the sharedEnvVarof that name (strategy: env_access); a Kubernetes container, compose service or Dockerfile (ENVof the image) setting one to that container's ownEnvVar(strategy: env_set, withsource:value,configMapKeyRef,secretKeyRef,fieldRef, ...,compose,dockerfile; values are never stored); and that container'sEnvVarto the code reading the name inside the files its image is built from (strategy: env_read, withdockerfile): the image's files are the sources its Dockerfile'sCOPY/ADDput into it, less the context's.dockerignoreCONFIGURESwithstrategy: key_symbol: a code symbol to the config key it names (config_key). A YAML, JSON, HCL (Terraform, OpenTofu, tfvars), TOML or INI key links by exact name (maxRetryCount=max_retry_count) and only to code inside the config file's component: its directory, or the one around aconfig/,configs/,conf/,settings/oretc/directory. A.envor.propertieskey also links by substring (confidence 0.75)OVERRIDEwithvia: patch: a Kustomize patch to each object of its kustomization's build it changes (child → base): a patch file's documents to the object of the same kind and name; an inline patch (from the kustomization) or a JSON6902 operation file to what itstargetselects (group, version, kind, name, namespace, label selector); a component's in the build of each kustomization including it. The edge keepskustomization,patchandline; a patch file is anIMPORTS(local_name: patches) of its kustomization, never a member of the buildOVERRIDEwithvia: namePrefix/nameSuffix: an object a kustomization renames, from its variant: aResourcenamed with the deployed name (capi-+controller-manager; the prefixes of nested kustomizations outermost first, suffixes innermost first) in the namespace that build gives it,ecosystem: kustomize, which the kustomization's fileDEFINES. CRDs, Namespaces and API services keep their names, as kustomize does. The edge keepskustomizationandlineUSAGEwithvia: terraform: a Terraform / OpenTofu reference (var.X,local.X,module.X,data.T.N,T.N) from the top-level block holding it to the block of its module (the.tf/.tofufiles of its directory) that declares it (alocalsentry: itslocalsblock); an entry of the block'sdepends_onlist is aDEPENDS_ONinstead. The edge keepsref(var,local,module,data,resource) andline; a name only mentioned in string text is no reference. A module call with a local source (module "net" { source = "./modules/net" })IMPORTS(local_name: the module's name) theFolderof that directory (the root directory: theProject), andmodule.net.id(alsomodule.net[0].id,module.net[*].id)USAGEs (ref: output) theoutput "id"there, besidemodule.netOVERRIDEwithvia: tfvars: a.tfvarsassignment to a variable the module of its own directory declares, from the file'sVariableto thatvariableblock (the edge keepsline); a.tfvarsfile whose own directory declares none of its names sets the nearest ancestor module's that does, the edge markedinferred(such a file is applied by a-var-filethe repository does not state)- Terragrunt (
via: terragrunt): a unit (terragrunt.hcl), evaluated in its own context: anincludeIMPORTS(local_name) the file itspathnames; aread_terragrunt_configIMPORTS(read: the file holding the call) the file it names, from the block holding the call or, for a call in an included file, from the unit'sincludeblock that brings it in; adependencyDEPENDS_ONthe other unit; a localterraformsourceIMPORTSitsFolder. Paths may usefind_in_parent_folders,dirnameandget_terragrunt_dir; anything else is unknown and links nothing - Ansible (
via: ansible): a playbook or task file (a YAML file whose top level is a sequence)IMPORTS(local_name: the directive) what its directives name:import_playbooka playbook,include_tasks/import_tasks/includea task file (from its directory, else its role'stasks/),roles:items andinclude_role/import_rolea role'sFolder(roles/<name>at or above its directory). A templated target links nothing. Each task and handler is aFunction(named by itsname:, else its module;source: ansible,kind,module) that its fileDEFINES: in a playbook's plays, a role'stasks/andhandlers/files, and the files those include; a block's tasks, not the block. AnotifyCALLS(via: notify) each handler of that name orlistentopic in the task's own role (else its file). Akube(kubespray's module) orkubernetes.core.k8staskDEPLOYS(via: ansible,module) the repository file its play rendered the applied manifest from: thetemplate(in the role'stemplates/) orcopy(itsfiles/) task whosedestis the task'sfilename, item by item throughregister/with_items/looplists the play states (a literal list, aset_fact, the role'sdefaults/vars), or ak8stemplate:argument EMITS,LISTENS_ON(channels)DATA_FLOWSwith arg-to-param mapping + field access chainsSIMILAR_TO(MinHash + LSH near-clone detection, Jaccard scored)SEMANTICALLY_RELATED(vocabulary-mismatch, same-language, score ≥ 0.80)
Indexing pipeline
- 162 vendored tree-sitter grammars compiled into the binary
- Generic package / module resolution: bare specifiers like
@myorg/pkg,github.com/foo/bar,use my_crate::fooresolved via manifest scanning (package.json,go.mod,Cargo.toml,pyproject.toml,composer.json,pubspec.yaml,pom.xml,build.gradle,mix.exs,*.gemspec) - Infrastructure-as-code indexing: Dockerfiles (
Dockerfile.*,*.Dockerfile,Containerfile: bases, what the container runs,ENV), container images (Image: the normalised repository, tag and digest on the edges; a repository built from several Dockerfiles, one per component tag, gets anImageper component), docker compose services (Resource), Kubernetes manifests (Resource, withgroup,version,kind,namespace,labelsask=v,k2=v2), Kustomize overlays (IMPORTSto their entries and patch files,OVERRIDEfrom their patches), Helm charts (Chart,DEPENDS_ON), Terraform / OpenTofu (.tf,.tofu,.tfvars) as graph nodes. A Service walks to the code it runs: Service → workload →Image→ Dockerfile →main - Hybrid LSP semantic type resolution for Python, TypeScript / JavaScript / JSX / TSX, PHP, C#, Go, C, C++, Java, Kotlin, Rust, and Perl; a lightweight C implementation of language type-resolution algorithms, structurally inspired by and compatible with major language servers including tsserver / typescript-go, pyright, gopls, Roslyn, Eclipse JDT, and rust-analyzer (parameter binding, return-type inference, generic substitution, JSX component dispatch, JSDoc inference for plain JS files, namespace + trait + late-static-binding resolution for PHP, file-scoped namespaces + records + LINQ method syntax for C#, class-hierarchy + overload + lambda resolution for Java, extension-function + scope-function resolution for Kotlin, trait-method + UFCS resolution for Rust)
- RAM-first pipeline: LZ4 compression, in-memory SQLite, single dump at end. Memory released after.
Distribution & operation
- Native runtime set, zero infrastructure services: SQLite-backed, persists to
~/.cache/codebase-memory-mcp/ - Auto-sync: Background watcher detects file changes in projects registered by active MCP sessions, including successful explicit
index_repositorytargets, and re-indexes them automatically. - Route nodes: REST endpoints are first-class graph entities
- CLI mode:
codebase-memory-mcp cli search_graph --project my-project --name-pattern ".*Handler.*" - Available on: npm, PyPI, Homebrew, Scoop, AUR,
go install
Indexing modes
| Mode | Use it for |
|---|---|
full | Full indexing with semantic analysis. This is the default. |
moderate | A filtered index with semantic analysis. |
fast | A filtered index without semantic analysis. |
cross-repo-intelligence | Link services across indexed projects, optionally limited by target_projects. |
Team-Shared Graph Artifact
Share a compressed graph snapshot so teammates can reuse an indexed baseline.
.codebase-memory/graph.db.zst is a zstd-compressed snapshot of the knowledge graph that lives next to your source. The artifact is opt-in: index_repository writes it only with persistence: true (the default is false), and once it exists later indexes refresh it. Local indexes persist regardless. When a teammate indexes a clone with an existing artifact, CBM imports that baseline and applies their local changes incrementally.
- Format: SQLite database, indexes stripped,
VACUUM INTOcompacted, then zstd 1.5.7 compressed (8 to 13:1 ratio typical) - Two tiers:
- Best (
zstd -9+ index strip +VACUUM INTO); written byindex_repositorywithpersistence: true - Fast (
zstd -3); refreshes an existing artifact on every other index, including the watcher's low-latency incremental updates
- Best (
- Bootstrap: when no local DB exists but the artifact is present,
index_repositoryimports the artifact first, then runs incremental indexing, reusing the shared baseline where possible - Merge policy: the first export creates
.codebase-memory/.gitattributeswithmerge=ours. Check your repository's Git merge-driver setup before relying on it for concurrent artifact updates. - Commit it deliberately: the artifact is rewritten on every index, including the watcher's Fast tier, and git stores each rewrite as a full new blob. Committing every refresh is what turns a 20 MB file into gigabytes of history; one team reached ~6 GB across ~350 commits of this single path. Pick a cadence (a release, a milestone, a nightly job) rather than committing every save.
- Git LFS, if it must move on every commit: track it from the repo-root
.gitattributesand leave the auto-created.codebase-memory/.gitattributesin place; the nearer file goes on supplyingmerge=ours, and onlyfiltercomes from the root:
Track only the.codebase-memory/graph.db.zst filter=lfs diff=lfs merge=lfs -text.zst;artifact.jsonis small and carries the schema version. The attribute applies to future commits only. Removing existing blobs requires a separate history migration. Two costs to weigh before adopting it: GitHub meters LFS storage and bandwidth, and its objects cannot be pruned without contacting support; and every teammate needsgit lfs install; without it their checkout leaves a pointer file where the artifact should be, the integrity-checked import refuses it, and they fall back to a full reindex. - Optional: shared export is opt-in, and Git commits remain your choice. Add
.codebase-memory/to.gitignoreif you prefer everyone to reindex from scratch.
The artifact provides a shared baseline while each developer keeps a local query database.
How It Works
codebase-memory-mcp is a structural analysis backend: it builds and queries the knowledge graph. The backend does not require a generative model. It relies on your MCP client (Claude Code, or any MCP-compatible agent) to be the intelligence layer.
You: "what calls ProcessOrder?"
Agent calls: trace_path(function_name="ProcessOrder", direction="inbound")
codebase-memory-mcp: executes graph query, returns structured results
Agent: presents the call chain in plain English
With MCP, your coding agent translates a question into tool calls. CBM Lens can also use an optional browser model for explanations; this does not change how the backend indexes or queries code.
Performance
Published backend benchmarks on Apple M3 Pro. These are separate from the CBM Lens checks:
| Operation | Time | Notes |
|---|---|---|
| Linux kernel full index | 3 min | 28M LOC, 75K files → 4.81M nodes, 7.72M edges |
| Linux kernel fast index | 1m 12s | 1.88M nodes |
| Django full index | ~6s | 49K nodes, 196K edges |
| Cypher query | <1ms | Relationship traversal |
| Name search (regex) | <10ms | SQL LIKE pre-filtering |
| Dead code detection | ~150ms | Full graph scan with degree filtering |
| Trace call path (depth=5) | <10ms | BFS traversal |
Memory-aware pipeline: Indexing keeps hot data in memory and can spill extraction results to disk when needed. Memory is released back to the OS after indexing completes.
More focused context, fewer tokens: The project's 31-repository preprint reports 10× lower token use and 2.1× fewer tool calls compared with file-by-file exploration. These March 2026 backend measurements cover the study's workloads and agent setup; the paper documents the full evaluation. An earlier five-query comparison reported ~3,400 versus ~412,000 tokens for structural queries. The study's system-performance measurements include the Linux indexing and Cypher timings above.
Explore the measurement guide to evaluate quality, latency and token use on your own workload.
Troubleshooting & Diagnostics
codebase-memory-mcp indexes and queries locally and collects no telemetry. When you hit something we can't reproduce on our side (a slow memory climb over hours, a performance regression, a leak that only appears after days of real use), we have no diagnostic data unless you choose to send it. Here is how to capture it yourself.
Capture a diagnostics log
Set CBM_DIAGNOSTICS=1 before the first daemon-backed MCP session starts, then reproduce the problem (let it run as long as it takes; a slow leak needs time to show in the trend). The shared daemon captures this setting from the session that starts it. If it is already running, close all daemon-backed sessions so it exits before changing the setting. The daemon creates a fresh owner-private cbm-diagnostics-<pid>-<random> directory below the system temp directory ($TMPDIR or /tmp on macOS/Linux, %TEMP% on Windows). The exact paths are recorded by the diagnostics.start event in ${CBM_CACHE_DIR}/logs/cbm-daemon.log:
| File | What it is |
|---|---|
trajectory.ndjson | The memory trajectory: one JSON line every 5 s with rss, committed (Windows commit charge), peak_*, page_faults, fd, and queries. This is the file we need for memory/leak reports: the trend over time is what pinpoints a leak. It is kept on disk after the server exits (so you can grab it post-mortem) and rotates to trajectory.ndjson.1 past ~8 MB. |
snapshot.json | The latest snapshot only; handy for a quick live check. Removed on clean exit. |
The private randomized directory prevents another local account from pre-placing a link or special file at a predictable diagnostics path. Its <pid> component is the shared daemon's process ID, also recorded by the daemon.start event. Set the variable consistently in the env block of each agent's MCP server config, or export it before launching the first session.
What to share
When you open a memory/performance issue, attach the .ndjson trajectory: it contains no source code or query text, only resource counters. If you'd rather not attach a file, paste it (or an agent's summary of it) into the issue: your assistant can read the NDJSON directly and report whether rss/committed grow monotonically, how fast, and relative to query count; which is exactly what we need to find the cause.
Installation
Pre-built Binaries
| Platform | Archive |
|---|---|
| macOS (Apple Silicon) | codebase-memory-mcp-darwin-arm64.tar.gz |
| macOS (Intel) | codebase-memory-mcp-darwin-amd64.tar.gz |
| Linux (x86_64) | codebase-memory-mcp-linux-amd64.tar.gz |
| Linux (ARM64) | codebase-memory-mcp-linux-arm64.tar.gz |
| Windows (x86_64) | codebase-memory-mcp-windows-amd64.zip |
Every release includes checksums.txt with SHA-256 hashes. The executable is self-contained; no adjacent data file is required. Linux -portable archives contain the fully