Sourcerer MCP

🚀 Sourcerer MCP 🧙

Sourcerer MCP是一個用於語義代碼搜索和導航的MCP服務器，它能幫助AI代理高效工作，避免消耗大量昂貴的令牌。藉助它，AI代理無需讀取整個文件，就能進行概念性搜索，並直接跳轉到所需的特定函數、類和代碼塊。

🚀 快速開始

若想快速體驗Sourcerer MCP的功能，可參考以下各部分的操作說明。

✨ 主要特性

• 語義代碼搜索與導航，幫助AI代理高效工作，減少令牌消耗。
• 支持概念性搜索，可直接跳轉到特定代碼塊。
• 支持文件系統監控，自動重新索引更改的文件。
• 提供多種MCP工具，如語義搜索、獲取源代碼等。

📦 安裝指南

Go安裝

go install github.com/st3v3nmw/sourcerer-mcp/cmd/sourcerer@latest

Homebrew安裝

brew tap st3v3nmw/tap
brew install st3v3nmw/tap/sourcerer

📚 詳細文檔

配置說明

Claude Code配置

claude mcp add sourcerer -e OPENAI_API_KEY=your-openai-api-key -e SOURCERER_WORKSPACE_ROOT=$(pwd) -- sourcerer

mcp.json配置

{
  "mcpServers": {
    "sourcerer": {
      "command": "sourcerer",
      "env": {
        "OPENAI_API_KEY": "your-openai-api-key",
        "SOURCERER_WORKSPACE_ROOT": "/path/to/your/project"
      }
    }
  }
}

工作原理

Sourcerer會為你的代碼庫構建一個語義搜索索引，具體步驟如下：

1. 代碼解析與分塊

• 使用 Tree-sitter 將源文件解析為抽象語法樹（AST）。
• 提取有意義的代碼塊（函數、類、方法、類型），併為其分配穩定的ID。
• 每個代碼塊包含源代碼、位置信息和上下文摘要。
• 代碼塊ID遵循 file.ext::TypeName::methodName 的模式。

2. 文件系統集成

• 使用 fsnotify 監控文件更改。
• 通過 git check-ignore 遵循 .gitignore 文件規則。
• 自動重新索引更改的文件。
• 存儲元數據以跟蹤修改時間。

3. 向量數據庫

• 使用 chromem-go 在 .sourcerer/db/ 中進行持久化向量存儲。
• 通過OpenAI的API生成嵌入向量，以實現語義相似度搜索。
• 支持概念性搜索，而非僅文本匹配。
• 維護代碼塊、其嵌入向量和元數據。

4. MCP工具

• semantic_search：按概念/功能查找代碼。
• get_source_code：按ID檢索特定代碼塊。
• index_workspace：手動觸發重新索引。
• get_index_status：檢查索引進度。

這種方式使AI代理無需讀取整個文件就能找到相關代碼，顯著減少了令牌使用和認知負擔。

支持的語言

語言支持需要編寫 Tree-sitter查詢 來識別每種語言的函數、類、接口和其他代碼結構。

• 已支持：Go
• 計劃支持：Python、TypeScript、JavaScript

🤝 貢獻代碼

歡迎所有形式的貢獻！

📺 演示

點擊下面的鏈接查看演示：

⚙️ 系統要求

• OpenAI API密鑰：生成嵌入向量時必需（計劃支持本地嵌入）。
• Git：必須是git倉庫（遵循 .gitignore 文件規則）。
• 將 .sourcerer/ 添加到 .gitignore：該目錄用於存儲嵌入向量數據庫。