Code Index MCP

🚀 代码索引MCP服务器

代码索引MCP服务器是一个基于MCP（模型上下文协议）的服务器，借助 Zoekt 实现本地源代码的快速搜索。

🚀 快速开始

该服务器可帮助你在本地快速搜索源代码，你可以按照以下步骤进行安装和配置。

✨ 主要特性

• 快速代码搜索：利用Zoekt基于三元组的索引技术，实现快速的子字符串和正则匹配。
• 按目录索引：每个被索引的目录都会在用户配置文件中拥有自己的索引。
• 丰富的查询语言：支持正则表达式、文件过滤、语言过滤和布尔运算符。
• 跨平台支持：可在macOS和Linux系统上运行。

📦 安装指南

此服务器可从 MCP注册表 获取。

下载预构建的MCPB包（实验性）

从 GitHub发布页面 下载适合你平台的 .mcpb 包：

• code-index-mcp-darwin-arm64.mcpb - 适用于macOS Apple Silicon
• code-index-mcp-darwin-amd64.mcpb - 适用于macOS Intel
• code-index-mcp-linux-amd64.mcpb - 适用于Linux x64
• code-index-mcp-linux-arm64.mcpb - 适用于Linux ARM64

.mcpb 文件是一个包含二进制文件和清单的ZIP存档。你可以直接在Claude Desktop中打开它以进行安装。

手动安装（推荐）

你可以通过以下方式将二进制文件安装到你的计算机上：

从发布页面下载

访问 GitHub发布页面 并下载适合你平台的文件（非mcpb文件，而是对应的tar/gzip压缩文件）。例如：

curl -sL https://github.com/trondhindenes/code-index-mcp/releases/download/1.0.13/code-index-mcp-darwin-arm64.tar.gz | tar xz
chmod +x code-index-mcp

使用Go安装

go install github.com/trondhindenes/code-index-mcp@latest

从源代码构建

git clone https://github.com/trondhindenes/code-index-mcp
cd code-index-mcp
go build -o code-index-mcp .

📚 详细文档

配置

现在你已经在本地安装了二进制文件，你可以将其注册到你选择的工具中。如果你通过mcpb包进行安装，这一步可能不是必需的，但具体情况可能会有所不同。

Claude Desktop

将以下内容添加到你的Claude Desktop配置文件中（在macOS上为 ~/Library/Application Support/Claude/claude_desktop_config.json）：

{
  "mcpServers": {
    "code-index": {
      "command": "/path/to/code-index-mcp"
    }
  }
}

Claude Code

运行以下命令：

claude mcp add --scope user --transport stdio code-index /path/to/code-index-mcp

环境变量

• CODE_INDEX_DIR：覆盖默认的索引存储位置。

默认索引位置：

• macOS：~/Library/Application Support/code-index/
• Linux：~/.local/share/code-index/ 或 $XDG_DATA_HOME/code-index/

可用工具

index_directory

对源代码目录进行索引，以便快速搜索。 参数：

• directory（必需）：要索引的目录路径。 示例：

对目录 /Users/me/projects/myapp 进行索引

search_code

在已索引的目录中搜索代码。返回紧凑的类似grep的输出，以减少上下文窗口的使用。 参数：

• query（必需）：使用Zoekt语法的搜索查询。
• directory（可选）：将搜索限制在特定的已索引目录中。
• max_files（可选）：返回的最大文件数（默认值：20）。
• max_lines_per_file（可选）：每个文件的最大匹配数（默认值：3）。
• files_only（可选）：仅返回文件路径，不返回行内容（默认值：false）。 输出格式：

/path/to/file.go:42: 此处为匹配的行内容
/path/to/file.go:58: 另一匹配行
  ... 此文件中还有5个匹配项

查询语法示例：

• func main - 简单文本搜索
• file:\.go$ func main - 仅在 .go 文件中搜索
• lang:python class.*Model - 在Python文件中搜索
• -test func main - 排除包含 "test" 的文件
• case:yes MyFunc - 区分大小写的搜索

list_indexes

列出所有已索引的目录及其位置。

delete_index

删除特定目录的索引。 参数：

• directory（必需）：要删除其索引的目录路径。

index_info

获取有关索引配置的信息，包括存储位置。

跳过的目录

在索引过程中，以下目录将自动跳过：

• 隐藏目录（以 . 开头）
• node_modules、vendor、__pycache__
• target、build、dist
• venv、.venv、env、.env

跳过的文件

二进制文件和常见的非代码文件将自动跳过，包括：

• 可执行文件（.exe、.dll、.so、.dylib）
• 存档文件（.zip、.tar、.gz）
• 图像文件（.png、.jpg、.gif）
• 文档文件（.pdf、.doc、.docx）

📄 许可证

本项目采用MIT许可证。