Debug Adapter Protocol

Debug Adapter Protocol
Name	Debug Adapter Protocol
Developer	Microsoft
Released	2016
Programming language	JSON, TypeScript
Platform	Cross-platform
License	MIT

Debug Adapter Protocol

The Debug Adapter Protocol standardizes communication between development tools and debugging backends to decouple front-end debuggers from language-specific runtimes. It originated to enable editor ecosystems to share debugger implementations, improving interoperability among projects like Visual Studio Code, Atom (text editor), Eclipse (software), JetBrains, and language server initiatives such as Language Server Protocol. The protocol uses JSON-based messaging and a request/response/event model to represent breakpoints, stack traces, variables, and execution control across diverse environments like .NET, Node.js, Python (programming language), and Java (programming language).

Overview

The protocol provides a transport- and UI-agnostic abstraction so tools such as Visual Studio Code, Sublime Text, GNU Emacs, Vim, and integrated systems in Microsoft Visual Studio or Eclipse (software) can reuse adapters for runtimes including Mono (software), CLR, Node.js, Deno (software), CPython, OpenJDK, and Go (programming language). Its design mirrors message-driven standards exemplified by Language Server Protocol and draws on engineering practices from projects at Microsoft and communities around GitHub. The approach reduces duplicate work across vendor ecosystems like Red Hat, JetBrains, Canonical (company), and academic tools used at institutions such as MIT, Stanford University, and ETH Zurich.

Architecture

The architecture separates three principal components: the client (editor or IDE), the debug adapter (server-side translator), and the debug target (runtime or debug engine) used by platforms like Windows, Linux, and macOS. Clients such as Visual Studio Code and Atom (text editor) communicate with adapters that interface to engines like gdb, lldb, OpenDebugAD7, Mono Debugger, or language-specific debuggers for Python (programming language), Ruby, PHP, and JavaScript. The transport layer may use stdio, TCP, or named pipes common in Microsoft Windows, mirroring IPC patterns used by Docker, Kubernetes, and SSH (Secure Shell). This separation enabled interoperability between commercial vendors like Microsoft and open-source projects hosted on GitHub.

Protocol Specification

Messages follow a JSON-RPC-like structure with typed requests, responses, and events inspired by protocols from organizations like IETF and projects such as Language Server Protocol. Core capabilities encompass commands for setBreakpoints, stackTrace, scopes, variables, threads, configurationDone, launch, and attach—operations analogous to controls used in debuggers like gdb, lldb, and WinDbg. Extensions permit custom capabilities for frameworks like ASP.NET Core, Electron (software framework), React (JavaScript library), and Angular (application platform). The spec evolved via contributions from corporations and communities including Microsoft, Red Hat, and maintainers on GitHub with governance patterns similar to standards at W3C or ECMA International.

Implementations and Tooling

Numerous adapters and client integrations exist: official adapters such as OpenDebugAD7 for Visual Studio Code, third-party adapters for Vim, Neovim, and Emacs, plus language-specific implementations for Python (programming language) (e.g., debugpy), Java (programming language) (e.g., Eclipse JDT), Go (programming language) (delve integrations), and Rust (programming language) tooling that interfaces with gdb or lldb. Commercial IDEs from JetBrains and Microsoft Visual Studio have integrated support or adapters to interoperate with editor ecosystems. Build and CI systems like Jenkins, Travis CI, and GitHub Actions can surface debug sessions via headless adapters. Community projects on GitHub provide adapter templates in TypeScript, Python (programming language), C#, and Go (programming language).

Use Cases and Workflows

Typical workflows include launch and attach scenarios for local development, remote debugging for cloud services running on Azure (cloud computing), Amazon Web Services, or Google Cloud Platform, and embedded debugging for targets such as ARM‎ microcontrollers via tools like OpenOCD. Front-ends like Visual Studio Code and Eclipse (software) present breakpoint management, watch expressions, and variable inspection while adapters translate requests to native debugger commands used in gdb, lldb, WinDbg, or VM-level interfaces such as the Java Virtual Machine debugging wire protocol. Teams in enterprises like Microsoft, Amazon (company), Google LLC, and research groups in universities adopt the protocol to streamline toolchains and support remote collaborative debugging during events like Hackathons or in production incident response.

Adoption and History

The protocol was introduced by engineers at Microsoft to enable the Visual Studio Code ecosystem to support multiple runtimes without embedding language-specific debuggers. It gained traction through open-source contributions on GitHub, adoption by editors such as Atom (text editor), integrations by vendors like Red Hat, and extensions maintained by communities around Python (programming language), Node.js, and Java (programming language). Over time, governance and specification updates followed community-driven processes similar to those at IETF and standards bodies like ECMA International. The protocol now underpins cross-editor debugging capabilities and continues to evolve through collaboration among corporations, open-source projects, and academic contributors.

Category:Debugging