MCP Code Indexer

🚀 MCP代码索引器

MCP代码索引器是一款基于模型上下文协议（Model Context Protocol）的智能代码检索工具，它能为AI大语言模型提供高效且精确的代码库检索能力，极大提升代码处理的效率与准确性。

English Version

🚀 快速开始

MCP代码索引器是专为AI大语言模型设计的代码检索工具。借助向量化索引和语义理解，它能助力AI更好地理解和分析代码库，显著提升代码相关任务的处理效率和准确性。

项目地址：https://github.com/zxfgds/mcp-code-indexer

✨ 主要特性

• 智能代码检索
  • 基于语义的代码搜索，可理解代码含义，而非仅进行关键字匹配。
  • 支持跨语言代码检索。
  • 能智能提取代码片段，自动识别完整的代码上下文。
• 代码分析能力
  • 可进行代码结构分析（类、函数、依赖关系）。
  • 能评估代码质量。
  • 可提取文档和注释。
  • 能检测相似代码。
  • 可进行代码度量统计。
  • 能分析项目依赖。
• 优化的上下文处理
  • 智能控制Token消耗，减少不必要的上下文信息。
  • 提供结构化的代码上下文。
  • 支持多项目并行索引和检索。
  • 可持久化项目识别，避免重复索引。
• 完整MCP协议支持
  • 符合MCP数据交互规范。
  • 提供丰富的工具集。
  • 支持异步操作和进度反馈。

📦 安装指南

安装依赖

pip install -r requirements.txt

安装工具

python setup.py install

📚 详细文档

配置说明

使用Claude Desktop配置

• 打开Claude Desktop，进入插件市场安装MCP代码索引器。
• 在插件设置中选择“MCP Code Indexer”并按照提示完成配置。

使用VSCode配置

1. 打开Visual Studio Code。
2. 进入Extensions（扩展） marketplace，搜索“MCP Code Indexer”并安装。
3. 安装完成后，在Settings（设置）中找到MCP相关选项进行配置。

使用说明

• 基本使用：在代码编辑器中选择代码片段后右键点击，选择“MCP代码索引器”进行检索或分析。
• 高级功能：通过命令面板输入mcp-indexer:<command>执行特定任务，如索引项目、分析依赖关系等。

💻 使用示例

基础用法

假设你想在代码编辑器中对选中的代码片段进行检索或分析，可按如下操作： 在代码编辑器中选择代码片段后右键点击，选择“MCP代码索引器”即可开始检索或分析。

高级用法

若你需要执行特定任务，如索引项目、分析依赖关系等，可通过命令面板输入mcp-indexer:<command>来实现。

🔧 技术细节

MCP代码索引器的主要价值体现在以下几个方面：

1. 提升效率：减少重复劳动，提高开发速度。
2. 优化资源：合理利用计算资源，降低Token消耗。
3. 增强协作：促进团队代码审查和知识共享。
4. 保障质量：通过自动化分析确保代码可维护性和可靠性。

📄 许可证

本项目采用MIT License。

🔗 应用场景

Claude Desktop应用

• 增强代码理解：帮助Claude更准确地理解用户的代码库，提供更精准的建议和解答。
• 智能代码导航：快速定位相关代码片段，提高问答效率。
• 代码质量改进：通过代码分析功能，提供更专业的代码优化建议。
• 项目依赖管理：帮助理解和管理项目依赖关系。
• 文档生成辅助：基于代码注释和结构分析，协助生成技术文档。

VSCode扩展

• 实时代码分析：在编辑器中直接获取代码分析结果。
• 智能代码推荐：基于项目上下文提供更准确的代码建议。
• 重构辅助：识别可优化的代码模式，辅助代码重构。
• 依赖关系可视化：直观展示代码依赖关系。
• 团队协作增强：帮助团队成员更好地理解代码库。

🤝 贡献指南

欢迎参与项目贡献。请通过Issues提交问题、建议或Pull Request。