Codebase MCP

🚀 代碼庫 MCP

代碼庫 MCP 是一個 模型上下文協議 (MCP) 服務器實現。它藉助 RepoMix 提供代碼庫檢索和分析工具，能讓像 Cursor 的 Composer Agent 這樣的 AI 代理自動讀取和理解整個代碼庫，降低開發人員處理大型代碼庫的難度，使 AI 助手對項目有全面的上下文認知。

🚀 快速開始

代碼庫 MCP 可與 Cursor 的 Composer Agent 集成，也能在 Cursor 外部使用。若要使用，需先完成安裝步驟。

✨ 主要特性

• 📚 代碼庫檢索：可將整個代碼庫作為單個文本輸出進行檢索，支持 XML、Markdown、純文本等不同格式。
• 🌐 遠程倉庫支持：能直接處理公共 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' 文件中。"

Composer Agent 將自動根據請求使用適當的工具。

在 Cursor 外部的使用

啟動 MCP 服務器

codebase-mcp start

這將啟動以標準輸入輸出模式運行的 MCP 服務器，可被任何兼容的 MCP 客戶端使用。

📄 許可證

本項目採用 MIT 許可證。