使用说明

项目简介

Code Index MCP 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在增强大型语言模型 (LLM) 在代码理解和分析方面的能力。它通过索引项目文件结构、提供代码搜索功能、文件内容检索以及代码结构分析等工具，为 LLM 提供丰富的项目代码上下文信息，从而支持更深入的代码理解和交互。

主要功能点

代码索引和导航：自动索引项目目录中的代码文件，并以树状结构呈现，方便 LLM 理解项目的文件组织结构。
代码搜索：允许 LLM 快速搜索项目代码中特定的关键词或模式，定位代码位置。
文件分析：提供文件摘要功能，可以提取文件的关键信息，例如代码行数、函数和类定义、导入语句等。
项目结构查看：支持查看整个项目的目录结构，帮助 LLM 快速了解项目概貌。
持久化存储：索引和设置数据会被持久化存储在项目目录中，避免重复索引，提高效率。
多语言支持：支持包括 Python, JavaScript, Java, C++, Go 等多种主流编程语言。

安装步骤

安装 Python: 确保您的系统已安装 Python 3.10 或更高版本。

安装 uv: 按照仓库 README.md 中的指引安装 uv，这是一个用于 Python 环境和依赖管理的工具，可以简化项目依赖安装过程。

Windows 系统，打开 PowerShell 运行命令:

powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

macOS/Linux 系统，打开终端运行命令:

curl -LsSf https://astral.sh/uv/install.sh | sh

获取仓库代码: 使用 git 克隆 'code-index-mcp' 仓库到本地。

git clone https://github.com/johnhuang316/code-index-mcp.git

服务器配置

要将 Code Index MCP 服务器与 MCP 客户端（例如 Claude Desktop）集成，您需要在客户端的配置文件中指定服务器的启动命令和参数。以下是配置示例，您需要根据实际情况修改 “项目仓库的绝对路径” 为 'code-index-mcp' 仓库在您本地文件系统中的绝对路径。

JSON 配置示例:

{
  "mcpServers": {
    "code-indexer": {
      "command": "uv",
      "args": [
         "--directory",
         "项目仓库的绝对路径",
         "run",
         "run.py"
       ]
    }
  }
}

配置参数说明:

'"code-indexer"': 服务器名称，可以自定义，用于在客户端中标识该服务器。
'"command": "uv"': 启动服务器的命令，这里使用 'uv' 命令来运行 Python 脚本。
'"args"': 传递给 'uv' 命令的参数列表。
- '"--directory"': 指定 uv 运行的工作目录，设置为 'code-index-mcp' 仓库的绝对路径，确保 uv 在正确的项目目录下运行并加载依赖。
- '"run"': uv 的子命令，用于运行指定的 Python 脚本。
- '"run.py"': 服务器启动脚本的文件名。

请注意，您需要将 '"项目仓库的绝对路径"' 替换为 'code-index-mcp' 仓库在您本地文件系统中的实际绝对路径。例如，在 Windows 上可能是 'C:\Users\YourUsername\code-index-mcp'，在 macOS/Linux 上可能是 '/home/YourUsername/code-index-mcp'。

基本使用方法

启动服务器: 配置完成后，启动 MCP 客户端（例如 Claude Desktop），客户端会自动尝试连接并启动 Code Index MCP 服务器。
设置项目路径: 首次使用时，您需要通过客户端与 Code Index MCP 服务器交互，设置要分析的项目路径。您可以使用类似 “I need to analyze a project, help me set up the project path” 的指令引导 LLM 助手，并按照提示提供您想要分析的代码项目目录的完整路径。
代码搜索: 设置项目路径后，您可以使用类似 “Search for 'function name' in the project” 的指令进行代码搜索。
文件分析: 使用类似 “Analyze the file src/main.py” 的指令分析特定文件。
项目导航: 使用类似 “Show me the structure of this project” 的指令查看项目结构。

注意: Code Index MCP 服务器的所有操作都基于您设置的项目路径。在进行代码分析、搜索等操作前，请务必先正确设置项目路径。

关键词

使用说明

信息