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

一个 Model Context Protocol (MCP) 服务器实现，提供工具以检索和分析整个代码库使用 RepoMix.

此 MCP 允许像 Cursor 的 Composer Agent 这样的 AI 代理自动读取和理解整个代码库一次，使开发人员更容易处理大型代码库，并使 AI 助手对项目有全面上下文。

特性

• 📚 代码库检索：以不同格式（XML、Markdown、Plain）检索整个代码库作为单个文本输出
• 🌐 远程仓库支持：直接处理远程 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 服务器”按钮
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 将自动根据你的请求使用合适的工具。

在 Cursor 外部使用

启动 MCP 服务器

codebase-mcp start

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

许可证

MIT