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。