indxr CLAUDE.md

indxr

A fast Rust codebase indexer for AI agents. Extracts structural maps (declarations, imports, tree) using tree-sitter and regex parsing across 27 languages.

Codebase Navigation — MUST USE indxr MCP tools

An MCP server called indxr is available. Always use indxr tools before the Read tool. Do NOT read full source files as a first step — use the MCP tools to explore, then read only what you need.

Token savings reference

The MCP server defaults to 3 compound tools (find, summarize, read). All 26 tools (3 compound + 23 granular) are available with --all-tools. With --features wiki, 9 additional wiki tools are available.

Action	Approx tokens	When to use
find(query)	~100-400	Find files/symbols by concept, name, callers, or signature pattern
summarize(path)	~200-600	Understand a file, batch of files, or symbol without reading source
read(path, symbol?)	~50-300	Read one function/struct. Supports symbols array and collapse.
Read (full file)	500-10000+	ONLY when editing or need exact formatting

Typical exploration: ~500 tokens vs ~3000+ for reading a full file (6x reduction).

Exploration workflow (follow this order)

The default 3 compound tools cover the most common exploration patterns:

1. find(query) — find files/symbols by concept, partial name, or type pattern. Start here when you know what you're looking for but not where it is.
   • Default mode (relevant): multi-signal relevance search across paths, names, signatures, and docs. Supports kind filter.
   • mode: "symbol": find declarations by name (case-insensitive substring).
   • mode: "callers": find who references a symbol (imports + signatures).
   • mode: "signature": find functions by signature pattern (e.g., "-> Result<").
2. summarize(path) — understand files and symbols without reading source code.
   • File path (e.g., "src/main.rs"): complete file overview (declarations, imports, counts).
   • Glob pattern (e.g., "src/mcp/*.rs"): batch summaries for multiple files.
   • Symbol name (no /, e.g., "Cache"): full interface details (signature, doc comment, relationships).
   • scope: "public": show only public API surface.
3. read(path, symbol?) — read source code by symbol name or explicit line range. Cap: 200 lines. Use symbols array to read multiple in one call (500 line cap). Use collapse: true to fold nested bodies.