Codebase MCP

Codebase MCP

site icon
2025.03.01 15
TypeScript代码分析AI 辅助开发开发效率
Codebase MCP 是一个基于 Model Context Protocol (MCP) 的服务实现,专门用于检索和分析整个代码库。它通过 RepoMix 工具,帮助开发者和 AI 代理(如 Cursor 的 Composer Agent)快速理解和处理大型代码库,提升开发效率和代码理解能力。
View on GitHub

Overview

基本能力

产品定位

Codebase MCP 是一个专注于代码库检索和分析的工具,旨在帮助开发者和 AI 代理快速理解大型代码库的结构和内容。

核心功能

  • 代码库检索:将整个代码库以不同格式(XML、Markdown、纯文本)输出。
  • 远程仓库支持:直接处理远程 GitHub 仓库。
  • 文件保存:将处理后的代码库保存到文件。
  • 自定义选项:控制代码库的处理方式(如是否包含注释、行号、文件摘要等)。

适用场景

  • 开发者需要快速理解大型代码库的结构。
  • AI 代理需要全面了解项目上下文以提供更准确的建议。
  • 团队需要保存代码库的快照以供后续分析或分享。

工具列表

  1. getCodebase:分析当前工作区/项目代码库。
  2. getRemoteCodebase:获取并分析任何公共 GitHub 仓库。
  3. saveCodebase:将代码库分析保存到文件。

常见问题解答

  • 如何与 Cursor 集成?:在 Cursor IDE 中添加 MCP 服务器,类型选择 command,命令为 codebase-mcp start
  • 如何启动 MCP 服务器?:运行 codebase-mcp start 命令。

使用教程

使用依赖

安装 RepoMix(必需依赖):

codebase-mcp install

安装教程

从 NPM 安装(推荐)

npm install -g codebase-mcp
codebase-mcp install

从 GitHub 安装

git clone https://github.com/DeDeveloper23/codebase-mcp.git
cd codebase-mcp
npm install
npm run build
npm install -g .
codebase-mcp install

调试方式

启动 MCP 服务器:

codebase-mcp start

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。