Zoekt MCP

🚀 Zoekt MCP 服務器

Zoekt MCP 服務器是一個模型上下文協議（MCP）服務器，藉助 Zoekt 提供代碼搜索功能。Zoekt 是 Sourcegraph 使用的索引代碼搜索引擎。

🚀 快速開始

Zoekt MCP 服務器集成了專為代碼倉庫優化的文本搜索引擎 Zoekt。Zoekt 為跨大型代碼庫的搜索提供基於三元組的索引，非常適合需要查找和理解代碼模式的 AI 助手。

✨ 主要特性

• 代碼搜索：使用 Zoekt 的三元組索引在代碼庫中進行搜索。
• 高級查詢語言：支持正則表達式模式、文件過濾器、語言過濾器和布爾運算符。
• 倉庫發現：按名稱查找倉庫並探索其結構。
• 內容獲取：瀏覽倉庫文件和目錄。
• AI 集成：專為大語言模型（LLM）集成設計，提供引導式搜索提示。

📦 安裝指南

前置條件

• Zoekt 實例：你需要訪問一個正在運行的 Zoekt 搜索服務器。有關設置說明，請參閱 Zoekt 文檔。
• Python 3.10+：運行 MCP 服務器所需。
• UV（可選）：現代 Python 包管理器，便於進行依賴管理。

使用 UV（推薦）

# 安裝依賴項
uv sync

# 運行服務器
uv run zoekt-mcp

使用 pip

# 創建虛擬環境
python -m venv venv
source venv/bin/activate  # 在 Windows 上：venv\Scripts\activate

# 安裝包
pip install -e .

# 運行服務器
python -m src.main

使用 Docker

# 構建鏡像
docker build -t zoekt-mcp .

# 使用默認端口運行容器
docker run -p 8000:8000 -p 8080:8080 \
  -e ZOEKT_API_URL=http://your-zoekt-instance \
  zoekt-mcp

# 或者使用自定義端口運行
docker run -p 9000:9000 -p 9080:9080 \
  -e ZOEKT_API_URL=http://your-zoekt-instance \
  -e MCP_SSE_PORT=9000 \
  -e MCP_STREAMABLE_HTTP_PORT=9080 \
  zoekt-mcp

📚 詳細文檔

配置

必需的環境變量

• ZOEKT_API_URL：你的 Zoekt 搜索實例的 URL。

可選的環境變量

• MCP_SSE_PORT：SSE 服務器端口（默認：8000）。
• MCP_STREAMABLE_HTTP_PORT：HTTP 服務器端口（默認：8080）。

與 AI 工具一起使用

Cursor

運行 MCP 服務器後，將以下內容添加到你的 .cursor/mcp.json 文件中：

{
  "mcpServers": {
    "zoekt": {
      "url": "http://localhost:8080/zoekt/mcp/"
    }
  }
}

MCP 工具

此服務器為 AI 助手提供了三個強大的工具：

🔍 search

使用 Zoekt 的高級查詢語法在索引代碼庫中進行搜索，支持正則表達式、語言過濾器和布爾運算符。

📖 search_prompt_guide

根據你的特定目標生成上下文感知的指南，用於構建有效的搜索查詢。

📂 fetch_content

從索引倉庫中檢索文件內容或探索目錄結構。

開發

代碼檢查和格式化

# 檢查代碼風格
uv run ruff check src/

# 格式化代碼
uv run ruff format src/