codebase-context-dumper MCP 服务器

一个模型上下文协议 (MCP) 服务器，旨在轻松地将您的代码库上下文转储到大型语言模型 (LLM) 中。

为什么要使用它？

LLM 中的大型上下文窗口非常强大，但手动从大型代码库中选择和格式化文件非常繁琐。此工具通过以下方式自动化该过程：

• 递归扫描您的项目目录。
• 包含来自指定目录树的文本文件，这些文件未被 .gitignore 规则排除。
• 自动跳过二进制文件。
• 使用清晰的文件路径标记连接内容。
• 支持分块以处理大于 LLM 上下文窗口的代码库。
• 与 MCP 兼容的客户端无缝集成。

用法（推荐：npx）

使用此工具的最简单方法是通过 npx，它运行最新版本，而无需本地安装。

配置您的 MCP 客户端（例如，Claude Desktop、VS Code 扩展）以使用以下命令：

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

然后，MCP 客户端将能够调用此服务器提供的 dump_codebase_context 工具。

功能 & 工具详情

工具：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。

输出: 返回连接的（并且可能分块的）文本内容。

本地安装 & 用法（高级）

如果您更喜欢运行本地版本（例如，用于开发）：

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" // 调整路径
       }
     }
   }
   

贡献

欢迎贡献！请参阅 CONTRIBUTING.md 了解有关开发、调试和发布新版本的详细信息。

许可证

该项目已获得 Apache License 2.0 许可。 有关详细信息，请参见 LICENSE 文件。