🚀 dap - mcp

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

🚀 快速开始

dap - mcp 是为优化调试工作流程而设计的工具，它集成了调试适配器协议（DAP）和 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"
  ],
  // 源码目录，用于解析文件路径
  // 如果您始终使用绝对路径，则可以省略此配置
  "sourceDirs": [
    "/path/to/source/code"
  ],
  // 调试器特定设置从这里开始
  // debugpy 的配置参考请参见 https://debugpy.readthedocs.io/en/latest/
  // 配置选项包括：
  // - debug: 启用调试功能（默认值：true）
  // - jitter: 控制调试启动的抖动时间（范围：0 到 100 毫秒，默认值：25）
}

工具

可用工具

调试器设置

# 使用配置文件运行 dap-mcp
python -m dap_mcp --config config.json

扩展支持其他 DAP 服务器

要添加对其他 DAP 服务器的支持，请执行以下步骤：

1. 创建一个新的 Python 文件（例如 mydap_server.py），并定义一个与 DAP 协议兼容的调试器类。
2. 定义配置 schema，用于解析和验证新的调试器配置。参考 这里 了解如何定义配置模式。
3. 更新 dap_mcp/config.py 文件中的类型联合（Union）以包含新调试器类：

from typing import Union

class MyDAPServer(Debugger):
    # 定义新的调试器类

Debugger = Union[Debugpy, Vscode, Gdb, MyDAPServer]

4. 现在，当您提供一个配置文件，其中 "type": "mydapserver" 时，dap - mcp 将自动解析并使用您的新调试器实现。

贡献

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

1. 叉分仓库。
2. 为功能或修复创建一个新的分支。
3. 编写测试，并确保所有检查通过。
4. 提交拉取请求。

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

📄 许可证

此项目根据 AGPL - 3.0 许可证授权。详细信息请参阅 LICENSE 文件。