Codebase Retrieval (RepoMix)

🚀 代碼庫模型上下文協議 (MCP) 服務器

代碼庫模型上下文協議 (MCP) 服務器是一個基於 Model Context Protocol (MCP) 的實現。它藉助 RepoMix 工具，能讓 AI 代理（如 Cursor 的 Composer Agent）自動讀取並理解整個代碼庫，降低開發人員處理大型代碼庫的難度，為 AI 助手提供項目的全面上下文。

🚀 快速開始

此 MCP 服務器能助力開發人員更高效地處理代碼庫。你可以通過以下步驟快速開啟使用之旅：

1. 安裝：可通過 NPM 或 GitHub 進行安裝。
2. 集成到 Cursor：將其與 Cursor 的 Composer Agent 集成，使用強大的代碼庫分析工具。
3. 在外部使用：啟動 MCP 服務器，供 MCP 兼容客戶端調用。

✨ 主要特性

• 📚 代碼庫檢索：支持以 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 許可證。