项目简介

Codebase Retrieval (RepoMix) MCP 服务器是一个基于 Model Context Protocol (MCP) 实现的后端服务，旨在为 LLM 客户端（如 Cursor 的 Composer Agent）提供代码库的上下文信息。它通过集成 RepoMix 工具，实现了对本地项目和远程 GitHub 仓库代码库的全面分析和检索，使得 AI 助手能够更好地理解和处理代码相关的任务。

主要功能点

代码库检索: 允许 AI 助手以 XML, Markdown 或纯文本格式获取整个代码库的文本内容，方便 AI 理解项目全局结构。
远程仓库支持: 支持直接分析公共 GitHub 仓库，无需本地clone，即可让 AI 理解其他项目的代码。
代码库保存: 可以将代码库的分析结果保存到文件中，方便后续查阅或分享。
灵活配置选项: 提供多种选项来自定义代码库的分析方式，例如是否包含注释、行号、文件摘要、目录结构等，满足不同场景的需求。

安装步骤

本 MCP 服务器可以通过 NPM 或 GitHub 仓库进行安装。推荐使用 NPM 进行安装，步骤更简洁。

NPM 安装 (推荐)

安装 'codebase-mcp' 包:
```
npm install -g codebase-mcp
```
此命令会将 'codebase-mcp' 命令行工具安装到全局环境。
安装 RepoMix 依赖:
```
codebase-mcp install
```
由于本 MCP 服务器依赖于 'repomix' 工具进行代码库分析，此命令会自动安装 'repomix' 到全局环境。

GitHub 安装

克隆仓库:

git clone https://github.com/DeDeveloper23/codebase-mcp.git

将 GitHub 仓库克隆到本地。

进入项目目录:
```
cd codebase-mcp
```
切换到克隆的项目目录。
安装依赖:
```
npm install
```
安装项目所需的 Node.js 依赖包。
构建项目:
```
npm run build
```
编译 TypeScript 代码到 JavaScript。
全局安装:
```
npm install -g .
```
将 'codebase-mcp' 命令行工具安装到全局环境。

安装 RepoMix 依赖:

codebase-mcp install

同样需要安装 'repomix' 依赖。

服务器配置

本 MCP 服务器主要面向 MCP 客户端使用，以下是在 Cursor 编辑器中配置 'Codebase MCP' 服务器的步骤和配置信息示例。其他 MCP 客户端的配置方式类似，主要关注服务器启动命令即可。

Cursor 配置示例:

打开 Cursor 编辑器。
点击侧边栏的 Composer 图标 (通常是一个音符或类似图标)。
点击顶部的 "MCP Servers" 按钮。
点击 "Add new MCP server" 按钮。
填写以下服务器详细信息：
- Name: 'Codebase MCP' (或任何你喜欢的名称，例如 'RepoMix Server')
- Type: 'command'
- Command: 'codebase-mcp start'
无需填写 'args' 参数，因为 'codebase-mcp start' 命令本身不接受额外的启动参数。
点击 "Add" 保存配置。

配置完成后，Cursor 的 Composer Agent 即可使用 'Codebase MCP' 服务器提供的工具。

配置信息 (JSON 格式) 示例:

{
  "server name": "Codebase MCP",
  "type": "command",
  "command": "codebase-mcp start"
}

基本使用方法

启动 MCP 服务器: 在终端中运行以下命令启动 'Codebase MCP' 服务器：
```
codebase-mcp start
```
服务器默认以 stdio 模式运行，输出日志信息到控制台。
在 MCP 客户端中使用工具: 例如在 Cursor 编辑器中，配置并连接 'Codebase MCP' 服务器后，即可在 Composer Agent 中使用以下工具：
- getCodebase: 分析当前工作区/项目的代码库。
  - 示例 Prompt: "请分析我的代码库以理解其结构。"
- getRemoteCodebase: 获取并分析远程 GitHub 仓库的代码库。
  - 示例 Prompt: "你能分析一下 github.com/username/repo 这个仓库吗？"
- saveCodebase: 将代码库分析结果保存到文件。
  - 示例 Prompt: "保存一份当前代码库的分析，稍后查看。"
Composer Agent 会根据你的 Prompt 自动选择合适的工具并调用。
在 Cursor 之外使用: 任何兼容 MCP 协议的客户端都可以连接到 'Codebase MCP' 服务器。启动服务器后，客户端需要配置连接到 'codebase-mcp start' 命令所启动的 stdio 服务。具体配置方式请参考 MCP 客户端的文档。

关键词