Code Index MCP

🚀 代碼索引 MCP

代碼索引 MCP 是一個用於代碼索引、搜索和分析的服務器，基於模型上下文協議（MCP）構建。它能讓大型語言模型與代碼倉庫交互，即時提供代碼庫洞察與導航能力。

🚀 快速開始

代碼索引 MCP 是專門針對 MCP 協議設計的服務器，能提供智能代碼索引和分析功能，使大型語言模型可與代碼倉庫交互，即時獲取代碼庫中的洞察並進行導航。該服務器集成於 模型上下文協議（MCP），這是一種讓 AI 模型與外部工具和數據源交互的標準方法。

✨ 主要特性

• 項目索引：遞歸掃描目錄以構建可搜索的代碼文件索引。
• 代碼搜索：在代碼庫中查找模式、函數定義和引用。
• 文件分析：獲取文件結構、導入和複雜度等詳細信息。
• 智能過濾：自動忽略構建目錄、依賴項和非代碼文件。
• 持久存儲：緩存索引以提高跨會話性能。

📦 安裝指南

先決條件

• Python 3.8 或更高版本。
• uv 包管理器（推薦）。

使用 uvx（推薦）

使用 uvx 安裝和運行代碼索引 MCP 是最簡單的方式：

uvx code-index-mcp

使用 pip

或者，您可以通過 pip 安裝：

pip install code-index-mcp

安裝後，可以作為模塊運行：

python -m code_index_mcp

💻 使用示例

與 Claude Desktop 集成

將以下內容添加到您的 Claude 設置（~/Library/Application Support/Claude/setting.json）中：

{
  "codeIndexMCP": {
    "enabled": true,
    "path": "/usr/local/bin/uvx"
  }
}

📚 詳細文檔

可用工具

• 設置項目路徑：指定要索引的項目根目錄。
• 搜索代碼：在項目中查找特定的代碼模式或函數。
• 分析文件：獲取文件的相關元數據和結構信息。
• 過濾結果：根據需求篩選索引結果。
• 緩存管理：維護和更新索引以保持高效性能。

支持的文件類型

服務器支持多種編程語言和文件擴展名，包括：

• Python (.py)
• JavaScript/TypeScript (.js, .ts, .jsx, .tsx)
• Java (.java)
• C/C++ (.c, .cpp, .h, .hpp)
• C# (.cs)
• Go (.go)
• Ruby (.rb)
• PHP (.php)
• Swift (.swift)
• Kotlin (.kt)
• Rust (.rs)
• Scala (.scala)
• Shell 腳本 (.sh, .bash)
• Web 文件 (.html, .css, .scss)
• 文檔/配置 (.md, .json, .xml, .yml, .yaml)

🔧 技術細節

要貢獻到這個項目，請參考 開發者文檔。

📄 許可證

本項目採用 MIT 許可證，詳情請見倉庫中的相關文件。

🌐 語言

• 繁體中文