Github Code Index MCP Server

🚀 代碼索引 MCP

代碼索引 MCP 是一個模型上下文協議服務器，能讓大型語言模型（LLMs）對項目目錄中的代碼進行索引、搜索和分析，有效提升代碼管理與分析的效率。

🚀 快速開始

代碼索引 MCP 可使大型語言模型（LLMs）對項目代碼進行索引、搜索和分析。下面將為你介紹其安裝和使用方法。

✨ 主要特性

• 索引和導航項目文件結構
• 搜索特定代碼模式
• 獲取文件詳細摘要
• 分析代碼結構和複雜度
• 支持多種編程語言
• 項目設置的持久存儲

📦 安裝指南

該項目使用 uv 進行環境管理及依賴安裝。具體步驟如下：

1. 確保已安裝 Python 3.10 或更高版本。
2. 安裝 uv（推薦）：

   # Windows
   powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
   # macOS/Linux
   curl -LsSf https://astral.sh/uv/install.sh | sh
   

3. 獲取代碼：

   # 克隆倉庫
   git clone https://github.com/your-username/code-index-mcp.git
   

💻 使用示例

基礎用法

直接運行服務器

# 直接使用 uv - 無需額外依賴安裝
uv run run.py

UV 將自動處理所有依賴安裝，基於項目的配置。

集成到 Claude Desktop

您可以輕鬆將代碼索引 MCP 集成到 Claude Desktop：

1. 確保已安裝 UV（參見安裝部分）。
2. 找到或創建 Claude Desktop 配置文件：
   • Windows：%APPDATA%\Claude\claude_desktop_config.json
   • macOS/Linux：~/Library/Application Support/Claude/claude_desktop_config.json
3. 添加以下配置（用實際路徑替換）： 對於 Windows：

   {
     "mcpServers": {
       "code-indexer": {
         "command": "uv",
         "args": [
            "--directory",
            "C:\\Users\\username\\path\\to\\code-index-mcp",
            "run",
            "run.py"
          ]
       }
     }
   }
   

   對於 macOS/Linux：

   {
     "mcpServers": {
       "code-indexer": {
         "command": "uv",
         "args": [
            "--directory",
            "/home/username/path/to/code-index-mcp",
            "run",
            "run.py"
          ]
       }
     }
   }
   

4. 重啟 Claude Desktop 以應用更改。

高級用法

基本工作流程

1. 設置項目路徑：
   • 使用 -p 或 --path 參數指定項目根目錄。
   • 示例：code-indexer --path /your/project/path
2. 代碼搜索：
   • 使用 -s 或 --search 參數進行代碼搜索。
   • 示例：code-indexer --search "關鍵詞" --path /your/project/path
3. 文件分析：
   • 使用 -a 或 --analyze 參數分析特定文件。
   • 示例：code-indexer --analyze /your/project/path/file.js
4. 項目導航：
   • 使用 -n 或 --navigate 參數進行目錄導航。
   • 示例：code-indexer --navigate /your/project/path

🔧 技術細節

• 持久化存儲：.code_indexer 文件夾用於存儲索引數據，默認情況下會在項目根目錄創建。
• 依賴管理：使用 UV 進行環境和依賴管理，確保所有依賴項正確安裝。
• 支持的文件類型：支持以下文件類型：
  • .js, .ts, .py, .java, .cpp, .php
  • .html, .css, .scss, .sass, .less
  • .json, .yaml, .yml, .xml, .ini
  • 等等

⚠️ 安全注意事項

• 文件路徑驗證防止目錄遍歷攻擊。
• 不允許絕對路徑訪問。
• 必須顯式設置項目路徑，無默認值。
• .code_indexer 文件夾包含 .gitignore 文件，以防止索引數據被提交到版本控制。

🤝 貢獻

歡迎通過問題或拉取請求添加新功能或修復錯誤。

如需查閱中文文檔，請參見 README_zh.md。