Skip to content

MCP Client Setup

Register codemap-search mcp in your client, then start the client inside the target repository.

Register across projects for your user account:

Terminal window
claude mcp add --scope user codemap-search -- codemap-search mcp

Or write a shared .mcp.json entry inside the target repository:

Terminal window
claude mcp add --scope project codemap-search -- codemap-search mcp

Omitting --scope saves a private local entry for the current repository in ~/.claude.json.

  1. Open a new session in the target repository and ask the agent to call initial_instructions or find to confirm the repository path.
  2. If indexing is warming up on first launch, wait for it to finish and ask the agent to run search on a known symbol.
  • Binary not found: Check terminal PATH in Installation Troubleshooting. For GUI clients that do not load ~/.zshrc or ~/.bashrc, set command to the full path from which codemap-search (where.exe codemap-search on Windows).
  • Wrong directory indexed: Start the client inside the target repository (codemap-search refuses to run in ~).

To automatically add a one-line codemap-search navigation reminder to your client’s global instructions file (CLAUDE.md or AGENTS.md), add this to ~/.codemap/config.toml and start a new session:

[global_instructions]
enabled = true

See Global instructions for per-client file paths.