BaseMemory Docs

This directory is the current documentation set for the codebase indexer.

Important: treat these docs as the source of truth for current behavior.

Start Here

• MCP Clients and Tool Guide
  • How to run the MCP server
  • Which clients are supported
  • What each tool does
  • When to use which tool
• Developer Guide
  • Local development setup
  • Build/test commands
  • Indexing and reindexing
  • Eval runs for BaseMemory and external repos
  • Config reference
  • Supported embedding providers and reranker backends

Existing Deep Dives

• Evaluation Harness
• Cross-repo Benchmarking
• Adding Language Support
• Incremental Index Orchestrator Handoff

Which Doc To Read

• You use Claude Code, Cursor, Windsurf, or another MCP client:
  • read MCP Clients and Tool Guide
• You are changing code in this repo:
  • read Developer Guide
• You are tuning retrieval quality or running benchmark gates:
  • read Evaluation Harness
• You are adding another parser/chunker/call-graph language:
  • read Adding Language Support