feat(mcp): detect borrowed git worktree index and surface on read tools (#312)

When a worktree is nested inside the main checkout (e.g. agent tools that place
worktrees under .claude/worktrees/<name>/), the nearest-.codegraph walk resolves
UP to the main checkout's index and queries silently return that tree's code —
usually a different branch. Symbols changed only in the worktree are invisible,
and nothing tells the user (#155).

Two layers:

- **Detection** (src/sync/worktree.ts): detectWorktreeIndexMismatch() compares
  the caller's git working-tree root vs the resolved index root via
  'git rev-parse --show-toplevel'. Best-effort; no git / not a repo / monorepo
  subdir / plain-ancestor index → no warning.
- **Surface**: codegraph status (CLI + MCP) embeds a verbose multi-line warning;
  every MCP read tool (search/context/trace/callers/callees/impact/explore/node/
  files) prefixes a compact one-line notice naming the borrowed index and the
  fix (codegraph init -i in the worktree). Detection is cached per session per
  start path, so it costs at most a single pair of 'git rev-parse' spawns per
  project no matter how many tool calls — respects the wall-clock-latency
  invariant.

Real-git tests (no mocking) cover both layers. Validated on macOS / Linux
(Docker) / Windows (Parallels VM); 11/11 worktree tests green on all three.

Closes #155

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
신주안
2026-05-25 20:57:20 -05:00
committed by GitHub
co-authored by Claude Opus 4.7
parent 8edd6cfafd
commit 4a4a37d135
6 changed files with 424 additions and 10 deletions
+12
View File
@@ -26,6 +26,7 @@ import { Command } from 'commander';
import * as path from 'path';
import * as fs from 'fs';
import { getCodeGraphDir, isInitialized } from '../directory';
import { detectWorktreeIndexMismatch, worktreeMismatchWarning } from '../sync/worktree';
import { createShimmerProgress } from '../ui/shimmer-progress';
import { getGlyphs } from '../ui/glyphs';
@@ -692,6 +693,11 @@ program
.option('-j, --json', 'Output as JSON')
.action(async (pathArg: string | undefined, options: { json?: boolean }) => {
const projectPath = resolveProjectPath(pathArg);
// The directory the user actually ran from, before walking up to the index
// root. Used to detect when the resolved index lives in a different git
// working tree (e.g. a nested worktree borrowing the main checkout's index).
const startPath = path.resolve(pathArg || process.cwd());
const worktreeMismatch = detectWorktreeIndexMismatch(startPath, projectPath);
try {
if (!isInitialized(projectPath)) {
@@ -731,6 +737,9 @@ program
modified: changes.modified.length,
removed: changes.removed.length,
},
worktreeMismatch: worktreeMismatch
? { worktreeRoot: worktreeMismatch.worktreeRoot, indexRoot: worktreeMismatch.indexRoot }
: null,
}));
cg.destroy();
return;
@@ -740,6 +749,9 @@ program
// Project info
console.log(chalk.cyan('Project:'), projectPath);
if (worktreeMismatch) {
warn(worktreeMismatchWarning(worktreeMismatch));
}
console.log();
// Index stats
+87 -10
View File
@@ -5,6 +5,12 @@
*/
import CodeGraph, { findNearestCodeGraphRoot } from '../index';
import {
detectWorktreeIndexMismatch,
worktreeMismatchWarning,
worktreeMismatchNotice,
type WorktreeIndexMismatch,
} from '../sync/worktree';
import type { Node, Edge, SearchResult, Subgraph, TaskContext, NodeKind } from '../types';
import { createHash } from 'crypto';
import {
@@ -532,6 +538,12 @@ export class ToolHandler {
// The directory the server last searched for a default project. Surfaced in
// the "not initialized" error so users can see why detection missed.
private defaultProjectHint: string | null = null;
// Per-start-path cache of the git worktree/index mismatch (issue #155). The
// mismatch is a fixed property of (where the request came from → which
// .codegraph/ it resolves to), so the up-to-two `git rev-parse` spawns run
// once and every later tool call reuses the result — never shelling out to
// git on the hot path. `undefined` = not computed yet; `null` = no mismatch.
private worktreeMismatchCache: Map<string, WorktreeIndexMismatch | null> = new Map();
constructor(private cg: CodeGraph | null) {}
@@ -696,6 +708,7 @@ export class ToolHandler {
cg.close();
}
this.projectCache.clear();
this.worktreeMismatchCache.clear();
}
/**
@@ -742,6 +755,53 @@ export class ToolHandler {
return value;
}
/**
* Cached git worktree/index mismatch for a tool call's effective project.
*
* The "effective project" is what the request targets: an explicit
* `projectPath` arg, else the directory the server resolved its default
* project from (`defaultProjectHint`), else cwd. Memoized per start path —
* see `worktreeMismatchCache`. Best-effort: if the project can't be resolved
* (e.g. nothing initialized yet), it reports "no mismatch" so a tool is never
* broken by this check.
*/
private worktreeMismatchFor(projectPath?: string): WorktreeIndexMismatch | null {
const startPath = projectPath ?? this.defaultProjectHint ?? process.cwd();
const cached = this.worktreeMismatchCache.get(startPath);
if (cached !== undefined) return cached;
let mismatch: WorktreeIndexMismatch | null = null;
try {
mismatch = detectWorktreeIndexMismatch(startPath, this.getCodeGraph(projectPath).getProjectRoot());
} catch {
// No resolvable project (or any other resolution error) → nothing to warn.
mismatch = null;
}
this.worktreeMismatchCache.set(startPath, mismatch);
return mismatch;
}
/**
* Prefix a successful read-tool result with a compact worktree-mismatch
* notice when the resolved index belongs to a different git working tree than
* the caller's (issue #155). Without this, an agent in a nested worktree
* silently trusts main-branch results. No-op on error results and when there
* is no mismatch. `codegraph_status` is excluded — it embeds its own verbose
* warning — so it stays out of this path.
*/
private withWorktreeNotice(result: ToolResult, projectPath?: string): ToolResult {
if (result.isError) return result;
const mismatch = this.worktreeMismatchFor(projectPath);
if (!mismatch) return result;
const notice = worktreeMismatchNotice(mismatch);
const [first, ...rest] = result.content;
if (first && first.type === 'text') {
return { ...result, content: [{ type: 'text', text: `${notice}\n\n${first.text}` }, ...rest] };
}
return result;
}
/**
* Execute a tool by name
*/
@@ -771,30 +831,35 @@ export class ToolHandler {
if (typeof check === 'object' && check !== undefined) return check;
}
// Read tools resolve through a single result variable so the worktree
// mismatch notice can be prefixed in one place (issue #155). status is
// returned directly — it embeds its own verbose warning.
let result: ToolResult;
switch (toolName) {
case 'codegraph_search':
return await this.handleSearch(args);
result = await this.handleSearch(args); break;
case 'codegraph_context':
return await this.handleContext(args);
result = await this.handleContext(args); break;
case 'codegraph_callers':
return await this.handleCallers(args);
result = await this.handleCallers(args); break;
case 'codegraph_callees':
return await this.handleCallees(args);
result = await this.handleCallees(args); break;
case 'codegraph_impact':
return await this.handleImpact(args);
result = await this.handleImpact(args); break;
case 'codegraph_explore':
return await this.handleExplore(args);
result = await this.handleExplore(args); break;
case 'codegraph_node':
return await this.handleNode(args);
result = await this.handleNode(args); break;
case 'codegraph_status':
return await this.handleStatus(args);
case 'codegraph_files':
return await this.handleFiles(args);
result = await this.handleFiles(args); break;
case 'codegraph_trace':
return await this.handleTrace(args);
result = await this.handleTrace(args); break;
default:
return this.errorResult(`Unknown tool: ${toolName}`);
}
return this.withWorktreeNotice(result, args.projectPath as string | undefined);
} catch (err) {
return this.errorResult(`Tool execution failed: ${err instanceof Error ? err.message : String(err)}`);
}
@@ -1954,14 +2019,26 @@ export class ToolHandler {
const cg = this.getCodeGraph(args.projectPath as string | undefined);
const stats = cg.getStats();
// Warn when this index actually belongs to a different git working tree
// (e.g. the server resolved up from a nested worktree to the main checkout).
// Queries then reflect that tree's branch, not the worktree being edited.
// status shows the verbose, multi-line form; the read tools get the compact
// one-liner via withWorktreeNotice. Both share the cached detection.
const mismatch = this.worktreeMismatchFor(args.projectPath as string | undefined);
const lines: string[] = [
'## CodeGraph Status',
'',
];
if (mismatch) {
lines.push(`> ⚠ ${worktreeMismatchWarning(mismatch).replace(/\n/g, '\n> ')}`, '');
}
lines.push(
`**Files indexed:** ${stats.fileCount}`,
`**Total nodes:** ${stats.nodeCount}`,
`**Total edges:** ${stats.edgeCount}`,
`**Database size:** ${(stats.dbSizeBytes / 1024 / 1024).toFixed(2)} MB`,
];
);
// Surface the active SQLite backend (node:sqlite, Node's built-in real
// SQLite — full WAL + FTS5, no native build).
+8
View File
@@ -8,6 +8,7 @@
* - FileWatcher: Debounced fs.watch that auto-triggers sync on file changes
* - Watch policy: decides when the watcher must be disabled (e.g. WSL2 /mnt)
* - Git sync hooks: opt-in commit/merge/checkout hooks when watching is off
* - Git worktree awareness: detect when a query borrows another tree's index
* - Content hashing for change detection (in extraction module)
* - Incremental reindexing (in extraction module)
*/
@@ -23,3 +24,10 @@ export {
type GitHookName,
type GitHookResult,
} from './git-hooks';
export {
gitWorktreeRoot,
detectWorktreeIndexMismatch,
worktreeMismatchWarning,
worktreeMismatchNotice,
type WorktreeIndexMismatch,
} from './worktree';
+114
View File
@@ -0,0 +1,114 @@
/**
* Git Worktree Awareness
*
* A CodeGraph index lives in a `.codegraph/` directory and is resolved by
* walking up parent directories to the nearest one (see
* `findNearestCodeGraphRoot`). That walk is unaware of git worktrees: when a
* worktree is created *inside* the main checkout (e.g. some tools place them
* under `.gitignore`d paths like `.claude/worktrees/<name>/`), a command run
* from the worktree walks up and silently resolves the MAIN checkout's index.
*
* Every query then returns results from the main tree's code — usually a
* different branch — rather than the worktree the user is actually editing.
* Symbols added or changed only in the worktree are invisible. This module
* detects that "borrowed index" situation so callers can warn about it.
*
* Detection is best-effort: when git is unavailable or the path isn't a repo,
* it reports "no mismatch" and callers carry on unchanged.
*/
import * as fs from 'fs';
import * as path from 'path';
import { execFileSync } from 'child_process';
/**
* Absolute, symlink-resolved toplevel of the git working tree that `dir`
* belongs to, or null when `dir` isn't inside a git repo (or git is missing).
*
* `git rev-parse --show-toplevel` returns the per-worktree root: the main
* checkout and each linked worktree report their own distinct directory, which
* is exactly the distinction this module relies on.
*/
export function gitWorktreeRoot(dir: string): string | null {
try {
const out = execFileSync('git', ['rev-parse', '--show-toplevel'], {
cwd: dir,
encoding: 'utf8',
stdio: ['ignore', 'pipe', 'ignore'],
}).trim();
return out ? realpath(out) : null;
} catch {
return null;
}
}
export interface WorktreeIndexMismatch {
/** The git working tree the command was run from. */
worktreeRoot: string;
/** The (different) working tree whose `.codegraph` index is being used. */
indexRoot: string;
}
/**
* Detect when `startPath` lives in one git working tree but the resolved
* CodeGraph index (`indexRoot`) belongs to a *different* working tree.
*
* Returns null — meaning "nothing to warn about" — when:
* - `startPath` isn't in a git repo (or git is unavailable),
* - the index already lives in `startPath`'s own working tree, or
* - `indexRoot` isn't itself a working-tree root (an unrelated parent dir
* that merely happens to contain a `.codegraph/`), which keeps non-git
* and monorepo-subdir layouts from producing false warnings.
*/
export function detectWorktreeIndexMismatch(
startPath: string,
indexRoot: string,
): WorktreeIndexMismatch | null {
const worktreeRoot = gitWorktreeRoot(startPath);
if (!worktreeRoot) return null;
const resolvedIndexRoot = realpath(indexRoot);
if (worktreeRoot === resolvedIndexRoot) return null;
// Only flag it when the index root is itself a real working-tree root. This
// distinguishes "borrowed another worktree's index" from "index sits in a
// plain ancestor directory", and avoids warning outside git entirely.
if (gitWorktreeRoot(resolvedIndexRoot) !== resolvedIndexRoot) return null;
return { worktreeRoot, indexRoot: resolvedIndexRoot };
}
/** One-line-per-fact warning describing a detected mismatch. */
export function worktreeMismatchWarning(m: WorktreeIndexMismatch): string {
return (
`This CodeGraph index belongs to a different git working tree.\n` +
` Running in: ${m.worktreeRoot}\n` +
` Index from: ${m.indexRoot}\n` +
`Results reflect that tree's code (often a different branch), not this worktree — ` +
`symbols changed only here are missing. Run "codegraph init -i" in this worktree ` +
`for a worktree-local index.`
);
}
/**
* Compact, single-line variant for prefixing a tool's result. Read tools
* return their answer inline, so the heads-up has to ride on the same payload
* the agent is already reading — a multi-line block would bury the result.
*/
export function worktreeMismatchNotice(m: WorktreeIndexMismatch): string {
return (
`⚠ CodeGraph results below come from a different git worktree (${m.indexRoot}), ` +
`not where you're working (${m.worktreeRoot}) — they may reflect another branch, ` +
`and symbols changed only here are missing. Run "codegraph init -i" here for a ` +
`worktree-local index.`
);
}
/** Resolve symlinks where possible so tmp/realpath quirks don't break equality. */
function realpath(p: string): string {
try {
return fs.realpathSync(path.resolve(p));
} catch {
return path.resolve(p);
}
}