Codebase Retrieval (RepoMix)

🚀 代码库模型上下文协议 (MCP) 服务器

代码库模型上下文协议 (MCP) 服务器是一个 Model Context Protocol (MCP) 的实现方案。它借助 RepoMix 工具，为开发者提供了检索和分析整个代码库的能力。该协议使 Cursor 的 Composer Agent 等 AI 代理能够一次性自动读取并理解整个代码库，极大地降低了开发者处理大型代码库的难度，同时让 AI 助手能全面掌握项目上下文。

🚀 快速开始

安装

从 NPM（推荐）

# 全局安装包
npm install -g codebase-mcp

# 安装 RepoMix（必需依赖）
codebase-mcp install

从 GitHub

# 克隆仓库
git clone https://github.com/DeDeveloper23/codebase-mcp.git

# 进入项目目录
cd codebase-mcp

# 安装依赖项
npm install

# 构建项目
npm run build

# 全局安装
npm install -g .

# 安装 RepoMix（必需依赖）
codebase-mcp install

启动 MCP 服务器

codebase-mcp start

启动后，MCP 服务器将进入 stdio 模式，可供任何 MCP 兼容客户端使用。

✨ 主要特性

• 📚 代码库检索：支持以 XML、Markdown、Plain 等不同格式，将整个代码库检索为单个文本输出。
• 🌐 远程仓库支持：可直接处理远程 GitHub 仓库。
• 💾 文件保存：能将处理后的代码库保存到文件中。
• 🔧 可自定义选项：通过多种选项，灵活控制代码库的处理方式，如注释、行号、文件摘要等。

💻 使用示例

与 Cursor 的集成

要将此 MCP 与 Cursor 的 Composer Agent 一起使用，可按以下步骤操作：

1. 打开 Cursor IDE。
2. 点击侧边栏中的 Composer 图标。
3. 点击顶部的“MCP 服务器”按钮。
4. 点击“添加新的 MCP 服务器”。
5. 填写详细信息：
   • 名称：Codebase MCP（可自定义）
   • 类型：command
   • 命令：codebase-mcp start
6. 点击“添加”以保存。

添加成功后，MCP 将为 Composer Agent 提供以下三个实用工具：

可用工具

1. getCodebase
   • 目的：分析当前工作区/项目。
   • 使用场景：当需要 AI 理解整个代码库时。
   • 示例提示：“请分析我的代码库以了解其结构”。
2. getRemoteCodebase
   • 目的：获取并分析任何公共 GitHub 仓库。
   • 使用场景：当希望探索或理解其他项目时。
   • 示例提示：“你能查看 github.com/username/repo 并解释他们的测试框架如何工作吗？”
3. saveCodebase
   • 目的：将代码库分析保存到文件中，以便后续使用。
   • 使用场景：当需要保留代码库快照或进行共享时。
   • 示例提示：“将对这个代码库的分析保存为 'codebase-analysis.md' 的 Markdown 格式。”

在 Cursor 中示例用法

以下是可与 Composer Agent 配合使用的示例提示：

“分析我的当前项目并解释其主要组件。”
“你能查看 tensorflow/tensorflow 仓库并解释他们的测试框架如何工作吗？”
“将对这个代码库的分析保存为 'codebase-analysis.md' 以供 later 审查。”

Composer Agent 会根据你的请求自动选择合适的工具。

📄 许可证

本项目采用 MIT 许可证。