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許可證。