Codebase MCP

代码库MCP

A. 模型上下文协议（MCP） 服务器实现，提供使用以下工具检索和分析整个代码库的工具 RepoMix.

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

特性

• 📚 代码库检索：将整个代码库作为不同格式（XML、Markdown、Plain）的单个文本输出进行检索
• 🌐 远程存储库支持：直接处理远程GitHub存储库
• 💾 文件保存：将处理后的代码库保存到文件中
• 🔧 可定制选项：使用各种选项（注释、行号、文件摘要等）控制代码库的处理方式

安装

来自NPM（推荐）

# Install the package globally
npm install -g codebase-mcp

# Install RepoMix (required dependency)
codebase-mcp install

来自GitHub

# Clone the repository
git clone https://github.com/DeDeveloper23/codebase-mcp.git

# Navigate to the project directory
cd codebase-mcp

# Install dependencies
npm install

# Build the project
npm run build

# Install globally
npm install -g .

# Install RepoMix (required dependency)
codebase-mcp install

与Cursor集成

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

1. 打开光标IDE
2. 单击侧栏中的Composer图标
3. 点击顶部的“MCP服务器”按钮
4. 点击“添加新的MCP服务器”
5. 填写详细信息：

- 姓名： Codebase MCP （或您喜欢的任何名称） - 类型： command - 命令： codebase-mcp start

1. 点击“添加”保存

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

可用工具

1. getCodebase

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

1. getRemote代码库

- 目的：获取并分析任何公共GitHub存储库 - 使用时间：您想探索或了解其他项目 - 示例提示：“你能分析github.com/username/repo上的存储库吗？”

1. save贬值

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

游标用法示例

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

"Analyze my current project and explain its main components."

"Can you look at the tensorflow/tensorflow repository and explain how their testing framework works?"

"Save an analysis of my project to 'codebase-analysis.md' in markdown format."

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

光标外用法

启动MCP服务器

codebase-mcp start

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

许可证

麻省理工学院