Codebase Context Dumper

🚀 codebase-context-dumper MCP Server

codebase-context-dumper MCP Server 是一款模型上下文協議（MCP）服務器，旨在輕鬆地將代碼庫上下文導入到大語言模型（LLM）中。

🚀 快速開始

使用此工具的最簡單方法是通過 npx，它可以運行最新版本，而無需進行本地安裝。將 MCP 客戶端（例如 Claude Desktop、VS Code 擴展）配置為使用以下命令：

{
  "mcpServers": {
    "codebase-context-dumper": {
      "command": "npx",
      "args": [
        "-y",
        "@lex-tools/codebase-context-dumper"
      ]
    }
  }
}

之後，MCP 客戶端就可以調用此服務器提供的 dump_codebase_context 工具。

✨ 主要特性

大語言模型中的大上下文窗口功能強大，但從大型代碼庫中手動選擇和格式化文件非常繁瑣。此工具通過以下方式實現自動化處理：

• 遞歸掃描項目目錄。
• 包含指定目錄樹中未被 .gitignore 規則排除的文本文件。
• 自動跳過二進制文件。
• 使用清晰的文件路徑標記連接內容。
• 支持分塊處理，以處理大於大語言模型上下文窗口的代碼庫。
• 與 MCP 兼容的客戶端無縫集成。

📦 安裝指南

推薦方式：使用 npx

使用 npx 可以直接運行最新版本，無需本地安裝，具體配置命令見上文“快速開始”部分。

本地安裝（高級用法）

如果你想運行本地版本（例如用於開發），可以按照以下步驟操作：

1. 克隆倉庫：

git clone git@github.com:lex-tools/codebase-context-dumper.git
cd codebase-context-dumper

2. 安裝依賴：

npm install

3. 構建服務器：

npm run build

4. 配置 MCP 客戶端指向本地構建輸出：

{
  "mcpServers": {
    "codebase-context-dumper": {
      "command": "/path/to/your/local/codebase-context-dumper/build/index.js" // 調整路徑
    }
  }
}

📚 詳細文檔

工具：dump_codebase_context

該工具遞歸讀取指定目錄中的文本文件，遵循 .gitignore 規則並跳過二進制文件，將內容與文件路徑的頁眉/頁腳連接起來，支持對大型代碼庫的輸出進行分塊處理。

功能

• 掃描 base_path 中提供的目錄。
• 遵循各級別的 .gitignore 文件（包括嵌套文件，默認包含 .git）。
• 檢測並跳過二進制文件。
• 讀取每個有效文本文件的內容。
• 在每個文件的內容前添加頁眉（--- START: relative/path/to/file ---），並在後面添加頁腳（--- END: relative/path/to/file ---）。
• 將所有處理後的文件內容連接成一個字符串。

輸入參數

• base_path（字符串，必需）：要掃描的項目目錄的絕對路徑。
• num_chunks（整數，可選，默認值：1）：要將輸出分成的總塊數，必須 >= 1。
• chunk_index（整數，可選，默認值：1）：要返回的塊的基於 1 的索引，要求 num_chunks > 1 且 chunk_index <= num_chunks。

輸出

返回連接後的（可能已分塊的）文本內容。

🤝 貢獻代碼

歡迎貢獻代碼！有關開發、調試和發佈新版本的詳細信息，請參閱 CONTRIBUTING.md。

📄 許可證

本項目採用 Apache 許可證 2.0。有關詳細信息，請參閱 LICENSE 文件。

項目徽章