代码索引 MCP

什么是代码索引 MCP？

代码索引 MCP 是一个专门的 MCP 服务器，提供智能代码索引和分析功能。它使大型语言模型能够与您的代码库进行交互，提供实时洞察和复杂代码库的导航。

该服务器与模型上下文协议（MCP）集成，MCP 是 AI 模型与外部工具和数据源交互的标准化方式。

主要功能

• 项目索引：递归扫描目录以构建可搜索的代码文件索引
• 代码搜索：在代码库中查找模式、函数定义和引用
• 文件分析：获取有关文件结构、导入和复杂性的详细洞察
• 智能过滤：自动忽略构建目录、依赖项和非代码文件
• 持久存储：缓存索引以提高跨会话的性能

支持的文件类型

服务器支持多种编程语言和文件扩展名，包括：

• Python (.py)
• JavaScript/TypeScript (.js, .ts, .jsx, .tsx, .mjs, .cjs)
• 前端框架 (.vue, .svelte, .astro)
• 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)
• 网页文件 (.html, .css, .scss, .less, .sass, .stylus, .styl)
• 模板引擎 (.hbs, .handlebars, .ejs, .pug)
• 数据库 & SQL：
  • SQL 文件 (.sql, .ddl, .dml)
  • 数据库特定文件 (.mysql, .postgresql, .psql, .sqlite, .mssql, .oracle, .ora, .db2)
  • 数据库对象 (.proc, .procedure, .func, .function, .view, .trigger, .index)
  • 迁移 & 工具 (.migration, .seed, .fixture, .schema, .liquibase, .flyway)
  • NoSQL & 现代数据库 (.cql, .cypher, .sparql, .gql)
• 文档/配置文件 (.md, .mdx, .json, .xml, .yml, .yaml)

安装

先决条件

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

使用 uvx（推荐）

使用 uvx 是安装和使用 code-index-mcp 的最简单方法：

uvx code-index-mcp

使用 pip

或者，您可以通过 pip 安装：

pip install code-index-mcp

安装后，您可以将其作为模块运行：

python -m code_index_mcp

与 Claude Desktop 集成

将此添加到您的 Claude 设置中（~/Library/Application Support/Claude/claude_desktop_config.json）：

{
  "mcpServers": {
    "code-index": {
      "command": "uvx",
      "args": [
        "code-index-mcp"
      ]
    }
  }
}

添加配置后，重新启动 Claude Desktop，代码索引 MCP 工具将可用。

可用工具

核心工具

• set_project_path：设置索引的基本项目路径。
• search_code：在索引文件中搜索代码匹配项。
• find_files：查找项目中匹配给定模式的文件。
• get_file_summary：获取特定文件的摘要，包括行数、函数、导入等。
• refresh_index：刷新项目索引。
• get_settings_info：获取有关项目设置的信息。

实用工具

• create_temp_directory：创建用于存储索引数据的临时目录。
• check_temp_directory：检查用于存储索引数据的临时目录。
• clear_settings：清除所有设置和缓存数据。

与 Claude 的示例用法

以下是一些如何使用代码索引 MCP 与 Claude 的示例：

设置项目路径

请将项目路径设置为 C:\Users\username\projects\my-python-project

搜索代码模式

在 Python 文件中搜索所有出现的 "def process_data"

获取文件摘要

给我一个项目中 main.py 文件的摘要

查找特定类型的所有文件

查找项目中的所有 JavaScript 文件

开发

从源代码构建

1. 克隆仓库：

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

2. 安装依赖项：

uv sync

3. 本地运行服务器：

uv run code_index_mcp

调试

您可以使用 MCP 检查器来调试服务器：

npx @modelcontextprotocol/inspector uvx code-index-mcp

许可证

MIT 许可证

贡献

欢迎贡献！请随时提交 Pull Request。

语言

• 繁體中文