Debug Adapter Protocol (DAP)

🚀 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 文件。