Debug Adapter Protocol (DAP)

🚀 dap-mcp

dap-mcp is a Model Context Protocol (MCP) implementation customized for managing Debug Adapter Protocol (DAP) sessions. MCP provides a standardized framework for optimizing and extending the context window of large language models. In this project, it is used to enhance and simplify the debugging workflow.

🚀 Quick Start

dap-mcp combines the Debug Adapter Protocol (DAP) with the Model Context Protocol (MCP) to offer a streamlined debugging experience. It allows users to interact with debuggers using a standardized protocol and leverages MCP to optimize the debugging context.

✨ Features

• Debug Adapter Protocol Integration: Interact with debuggers using a standardized protocol.
• MCP Framework: Utilize MCP to optimize the context and enhance the debugging workflow.
• Rich Debugging Tools: Set, list, and remove breakpoints; control execution (continue, step into/out/over); evaluate expressions; switch call stacks; view source code.
• Flexible Configuration: Customize debugger settings, source code directories, and other parameters through a JSON configuration file.

📦 Installation

Prerequisites

• Python 3.10 or higher
• uv (optional, for running the server)

Install and Run the Server

Install dap-mcp and its dependencies:

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

# Or, if you have uv installed
uvx dap-mcp@latest --config config.json

📚 Documentation

Configuration

The project uses a JSON configuration file (e.g., .config.json) to specify debugger settings and source code directories. Example configuration:

{
  "type": "debugpy",
  "debuggerPath": "/path/to/python/with/debugpy",
  "debuggerArgs": [
    "-m",
    "debugpy.adapter"
  ],
  // Source code directories for resolving file paths
  // You can omit this configuration if you always use absolute paths
  "sourceDirs": [
    "/path/to/source/code"
  ],
  // Debugger-specific settings start here
  // See https://debugpy.readthedocs.io/en/latest/ for debugpy configuration reference
  // Configuration options include:
  // - debug: Enable debugging features (default: true)
  // - jitter: Control the jitter time for debugging startup (range: 0 to 100 ms, default: 25)
}

Tools

Available Tools

• dap-mcp
  • Version: v1.0.0
  • Description: dap-mcp is an MCP implementation for the Debug Adapter Protocol (DAP) sessions.

Debugger Settings

# Run dap-mcp with a configuration file
python -m dap_mcp --config config.json

Extending Support for Other DAP Servers

To add support for other DAP servers, follow these steps:

1. Create a new Python file (e.g., mydap_server.py) and define a debugger class compatible with the DAP protocol.
2. Define a configuration schema for parsing and validating the new debugger configuration. Refer to here for how to define the configuration schema.
3. Update the type union (Union) in the dap_mcp/config.py file to include the new debugger class:

from typing import Union

class MyDAPServer(Debugger):
    # Define the new debugger class

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

4. Now, when you provide a configuration file with "type": "mydapserver", dap-mcp will automatically parse and use your new debugger implementation.

🤝 Contribution

Contributions are welcome! To contribute, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or fix.
3. Write tests and ensure all checks pass.
4. Submit a pull request.

Please follow the coding standards and include appropriate tests in your changes.

📄 License

This project is licensed under the AGPL-3.0 License. See the LICENSE file for details.