Codebase MCP

一个 模型上下文协议 (MCP) 服务器实现，它提供使用 RepoMix 检索和分析整个代码库的工具。

此 MCP 允许像 Cursor 的 Composer Agent 这样的 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 Agent 一起使用：

1. 打开 Cursor IDE
2. 单击侧边栏中的 Composer 图标
3. 单击顶部的“MCP Servers”按钮
4. 单击“Add new MCP server”
5. 填写详细信息：
   • Name: Codebase MCP (或您喜欢的任何名称)
   • Type: command
   • Command: codebase-mcp start
6. 单击“Add”以保存

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

可用工具

1. getCodebase

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

2. getRemoteCodebase

   • 目的：获取并分析任何公共 GitHub 仓库
   • 使用时机：您想探索或理解其他项目
   • 示例提示：“你能分析一下 github.com/username/repo 的仓库吗？”

3. saveCodebase

   • 目的：将代码库分析保存到文件中以供以后使用
   • 使用时机：您想保存代码库快照或共享它
   • 示例提示：“保存此代码库的分析以供稍后查看”

在 Cursor 中的示例用法

以下是一些您可以与 Composer Agent 一起使用的示例提示：

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

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

"将我的项目分析以 markdown 格式保存到 'codebase-analysis.md'。"

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

在 Cursor 之外使用

启动 MCP 服务器

codebase-mcp start

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

许可证

MIT