Codebase MCP

这是一个使用模型上下文协议（MCP）的服务器实现，提供了通过RepoMix检索和分析整个代码库的工具。

此MCP允许像Cursor的Composer代理这样的AI代理自动读取并理解整个代码库，使开发者更容易处理大型代码库，并让AI助手对项目有全面的理解。

特性

• 📚 代码库检索：以不同格式（XML、Markdown、纯文本）获取整个代码库作为单一文本输出
• 🌐 远程仓库支持：直接处理远程GitHub仓库
• 💾 文件保存：将处理过的代码库保存到文件中
• 🔧 可定制选项：通过各种选项控制如何处理代码库（注释、行号、文件摘要等）

安装

从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

与Cursor集成

要使用此MCP与Cursor的Composer代理：

1. 打开Cursor IDE
2. 点击侧边栏中的Composer图标
3. 点击顶部的"MCP服务器"按钮
4. 点击"添加新MCP服务器"
5. 填写详细信息：
   • 名称：Codebase MCP（或您喜欢的任何名称）
   • 类型：命令
   • 命令：codebase-mcp start
6. 点击"添加"以保存

添加后，MCP将为Composer代理提供三个强大的工具：

可用工具

1. getCodebase

   • 目的：分析您的当前工作区/项目
   • 使用场景：当您希望AI理解整个代码库时
   • 示例提示："请分析我的代码库以了解其结构"

2. getRemoteCodebase

   • 目的：获取并分析任何公开的GitHub仓库
   • 使用场景：当您想要探索或理解其他项目时
   • 示例提示："你能分析github.com/username/repo这个仓库吗？"

3. saveCodebase

   • 目的：将代码库分析结果保存到文件中以便后续使用
   • 使用场景：当您想要保留代码库快照或分享它时
   • 示例提示："将此代码库的分析保存为'markdown'格式的'codebase-analysis.md'"

在Cursor中的示例用法

这里有一些您可以与Composer代理一起使用的示例提示：

"分析我当前的项目并解释其主要组件。"

"你能查看tensorflow/tensorflow仓库并解释他们的测试框架是如何工作的吗？"

"将我对项目的分析保存为'markdown'格式的'codebase-analysis.md'以供以后审查。"

Composer代理将根据您的请求自动使用适当的工具。

在Cursor之外的使用

启动MCP服务器

codebase-mcp start

这将以stdio模式启动MCP服务器，可以被任何兼容MCP的客户端使用。

许可证

MIT