A fast codebase indexer and knowledge wiki for AI agents.
indxr gives AI agents a persistent, self-updating wiki about your codebase backed by a fast structural index. Architecture decisions, module responsibilities, failure patterns — stuff that normally lives in people's heads — gets written down and stays current.
A fast codebase indexer and knowledge wiki for AI agents.
星數
73
工具
—
可用率
—
Features
Codebase knowledge wiki — persistent wiki with architecture pages, module overviews, failure pattern recording, contradiction tracking, and knowledge compounding. Agents query it, learn from it, and write back to it
Composable filters — path, kind, symbol name, visibility, language
Install
cargo install indxr --features wiki
This installs indxr with the full wiki system. For additional transports:
cargo install indxr --features wiki,http # + Streamable HTTP transport
Or build from source:
git clone https://github.com/bahdotsh/indxr.git
cd indxr && cargo build --release --features wiki
You can also install without the wiki feature (cargo install indxr) if you only need structural indexing.
Usage
# Wiki — the core workflow
indxr wiki generate # generate codebase knowledge wiki
indxr wiki update # update wiki after code changes
indxr wiki status # check wiki health
indxr wiki compound notes.txt # compound knowledge from file
# MCP server — live queries + wiki tools for AI agents
indxr serve ./my-project --watch --wiki-auto-update # recommended: full setup
indxr serve ./my-project # start MCP server (structural only)
indxr serve ./my-project --watch # MCP server with auto-reindex
# Structural indexing
indxr # index cwd → stdout
indxr ./my-project -o INDEX.md # index project → file
indxr -f json -l rust,python -o index.json # JSON, filter by language
# Setup
indxr init # set up all agent configs
indxr members # list workspace members (monorepo)
Codebase Knowledge Wiki
The structural index tells agents what exists in your codebase. The wiki tells them why. Architecture decisions, module responsibilities, failure patterns — things that usually get lost when someone leaves the team.
indxr wiki generate # generate wiki from scratch
indxr wiki update # update after code changes
indxr wiki status # check wiki health
indxr wiki compound notes.txt # compound knowledge from file
echo "synthesis" | indxr wiki compound - # compound from stdin
Wiki pages are stored in .indxr/wiki/ as Markdown with YAML frontmatter. Page types: architecture, module, entity, topic. Pages support [[page-id]] cross-references, contradiction tracking, and failure pattern recording.
How agents use the wiki
Generate:wiki_generate → agent plans pages from structural context, writes each via wiki_contribute
Query:wiki_search to understand modules and design decisions before reading source
Learn:wiki_compound persists synthesized insights after cross-page analysis
Record failures:wiki_record_failure so future agents don't repeat mistakes
Update:wiki_update identifies stale pages after code changes, agent rewrites via wiki_contribute
Wiki MCP tools (9 tools)
Tool
Description
wiki_generate
Initialize a new wiki and return structural context for page planning
wiki_search
Search wiki by keyword or concept; returns matching pages with excerpts
wiki_read
Read a wiki page by ID; returns full content with metadata
wiki_status
Check wiki health: page count, staleness, source file coverage
wiki_contribute
Write knowledge back to the wiki (create or update pages)
wiki_update
Analyze code changes and return affected pages with diff context
wiki_suggest_contribution
Suggest which page to update for a given synthesis (no LLM call)
wiki_compound
Auto-route synthesized knowledge to the best matching page
wiki_record_failure
Record a failed fix attempt for future agents to learn from
wiki_generate is always listed; the remaining 8 tools appear once a wiki exists. Wiki tools support contradiction tracking and failure pattern recording.
Auto-updating wiki
The MCP server keeps the wiki in sync with your code automatically:
indxr serve --watch --wiki-auto-update
Triggers wiki page updates when source files change. Set ANTHROPIC_API_KEY, OPENAI_API_KEY, or use --exec for a custom LLM backend.
See Wiki docs for full details on page structure, LLM configuration, and disk layout.
Agent Setup
indxr init # set up for all agents
indxr init --claude # Claude Code only
indxr init --cursor # Cursor only
indxr init --windsurf # Windsurf only
indxr init --codex # OpenAI Codex CLI only
indxr init --global # install globally for all projects
indxr init --global --cursor # global Cursor only
indxr init --no-rtk # skip RTK hook setup
Agents don't always pick MCP tools over file reads on their own. indxr init sets up PreToolUse hooks that intercept Read/Bash calls and instruction files that teach the exploration workflow.
MCP Server
JSON-RPC 2.0 over stdin/stdout (or Streamable HTTP with --features http). 3 compound tools listed by default; --all-tools exposes all 26. Wiki tools (9) are available when a wiki exists.
Default tools (3 compound)
Tool
Description
find
Find files/symbols by concept, name, callers, or signature pattern. Modes: relevant (default), symbol, callers, signature
summarize
Understand files/symbols without reading source. Auto-detects: glob -> batch, no "/" -> symbol name, file path -> file summary. Scope: all (default), public
read
Read source by symbol name or line range (same as read_source)
Granular tools (23 — requires --all-tools)
Tool
Description
search_relevant
Multi-signal relevance search across paths, names, signatures, and docs
lookup_symbol
Find declarations by name (case-insensitive substring)
explain_symbol
Signature, doc comment, relationships, metadata — no body
get_file_summary
Complete file overview without reading it
batch_file_summaries
Summarize multiple files in one call
get_file_context
File summary + reverse dependencies + related files
get_public_api
Public declarations with signatures for a file or directory
get_callers
Find who references a symbol across all files
list_declarations
List declarations in a file with optional filters
search_signatures
Search functions by signature pattern
read_source
Read source by symbol name or line range
get_tree
Directory/file tree
get_stats
File count, line count, language breakdown
get_imports
Import statements for a file
get_related_tests
Find test functions by naming convention
get_hotspots
Most complex functions ranked by composite score
get_health
Codebase health summary with aggregate complexity metrics
get_type_flow
Track which functions produce/consume a given type across the codebase
get_dependency_graph
File and symbol dependency graph (DOT, Mermaid, JSON)
get_diff_summary
Structural changes since a git ref or GitHub PR
get_token_estimate
Estimate tokens before reading
list_workspace_members
List monorepo workspace members (Cargo, npm, Go)
regenerate_index
Re-index and update INDEX.md
Granular tools are always callable even when not listed — --all-tools only controls whether they appear in tools/list.
Wiki tools (9) are also available when a wiki exists. See Wiki section.
In workspace mode, tools gain a member param to scope queries. List tools support compact mode. See MCP Server docs for details.
Output
Default format is Markdown at signatures detail level: