Dap MCP

🚀 dap - mcp 说明

dap - mcp 是专为管理调试适配器协议 (DAP) 会话而实现的 模型上下文协议 (MCP) 的一个版本。MCP 提供了一个标准化框架，用于优化和扩展大型语言模型的上下文窗口，在此项目中，它被用来增强和简化调试工作流程。

🚀 快速开始

dap - mcp 是专为管理调试适配器协议 (DAP) 会话而实现的 模型上下文协议 (MCP) 的一个版本，借助 MCP 标准化框架，能增强和简化调试工作流程。

✨ 主要特性

• 调试适配器协议集成：使用标准协议与调试工具交互。
• MCP 框架：利用 MCP 优化上下文并提升调试工作流程。
• 丰富的调试工具：可设置、列出和移除断点；控制执行（继续、进入/退出/下一步）；评估表达式；切换调用栈；查看源代码。
• 灵活的配置：通过 JSON 配置文件自定义调试器设置、源目录和其他参数。

📦 安装指南

先决条件

• Python 3.10 或更高版本
• uv（可选，用于运行服务器）

安装和运行服务器

安装 dap - mcp 及其依赖项：

pip install dap-mcp
python -m dap_mcp --config config.json

# 或者，如果你已经安装了 uv
uvx dap-mcp@latest --config config.json

📚 详细文档

配置

项目使用 JSON 配置文件（例如 .config.json）指定调试器设置和源目录。配置示例如下：

{
  "type": "debugpy",
  "debuggerPath": "/path/to/python/with/debugpy",
  "debuggerArgs": [
    "-m",
    "debugpy.adapter"
  ],
  // 源代码目录，用于解析文件路径
  // 如果你总是使用绝对路径，则可以省略此配置
  "sourceDirectories": [
    "src",
    "tests"
  ],
  // 其他调试器特定的设置
  "debuggerSettings": {
    "timeout": 3000,
    ".debugLine": true
  }
}

可用调试器类型

以下调试器类型当前受支持：

工具

以下工具可通过 MCP 框架调用：

• 设置断点：在指定位置暂停程序执行。
• 列出断点：显示所有已设置的断点信息。
• 移除断点：删除指定的断点。
• 继续执行：让程序恢复执行。
• 进入调试：切换到调试模式，逐行执行代码。
• 退出调试：退出当前调试会话。
• 下一步：执行下一条指令。
• 评估表达式：在当前上下文中计算表达式的值。
• 切换调用栈：在不同的调用堆中进行切换。

扩展

要扩展支持其他 DAP 服务器，请按照以下步骤操作：

基础用法

创建一个新的调试器类，继承自 dap_base.DAPProtocol：

class MyDAP(dap_base.DAPProtocol):
    def __init__(self, ...):
        super().__init__(...)

    def on_request(self, request):
        # 处理具体请求逻辑

高级用法

# 更新配置的验证和解析部分，添加新的调试器类型
debugger_type = Schema(
    {"type": "mydap"},
    Field(..., description="自定义调试器配置")
)

# 在 main 函数中注册新的调试器实现
def main():
    ...
    if config.type == "mydap":
        dap_protocol = MyDAPProtocol(...)
    ...

贡献

欢迎贡献！要参与项目，请按照以下步骤操作：

1. Fork 仓库。
2. 为你的功能或修复创建一个新的分支。
3. 编写测试并确保所有检查通过。
4. 提交一个 Pull Request。

请遵循编码规范，并在更改中包含适当的测试。

📄 许可证

该项目使用 AGPL - 3.0 许可证。有关详细信息，请参阅 LICENSE 文件。