-
Notifications
You must be signed in to change notification settings - Fork 15.4k
[lldb] Document MCP support in LLDB #145935
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # Model Context Protocol (MCP) | ||
|
|
||
| LLDB supports for the [Model Context Protocol][1] (MCP). This structured, | ||
| machine-friendly protocol allows AI models to access and interact with external | ||
| tools, such as the debugger. Using MCP, an AI agent can execute LLDB commands | ||
DavidSpickett marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| to control the debugger: set breakpoints, inspect memory, step through code. | ||
| This can range from helping you run a specific command you can't immediately | ||
JDevlieghere marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| remember to a fully agent-driven debugging experiences | ||
DavidSpickett marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## MCP Server | ||
|
|
||
| To start the MCP server in LLDB, use the `protocol-server start` command. | ||
| Specify `MCP` as the protocol and provide a URI to listen on. For example, to | ||
DavidSpickett marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| start listening for local TCP connections on port `59999`, use the following | ||
| command: | ||
|
|
||
| ``` | ||
| (lldb) protocol-server start MCP listen://localhost:59999 | ||
| MCP server started with connection listeners: connection://[::1]:59999, connection://[127.0.0.1]:59999 | ||
| ``` | ||
|
|
||
| The server will automatically stop when exiting LLDB, or it can be stopped | ||
| explicitly with the `protocol-server stop` command. | ||
DavidSpickett marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ``` | ||
| (lldb) protocol-server stop MCP | ||
JDevlieghere marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| ## MCP Client | ||
|
|
||
| MCP uses standard input/output (stdio) for communication between client and | ||
| server. The exact configuration depends on the client, but most applications | ||
| allow you to specify an MCP server as a binary and arguments. This means that | ||
| you need to use something like `netcat` to connect to LLDB's MCP server and | ||
| forward communication over stdio over the network connection. | ||
JDevlieghere marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Configuration example for [Claude Code][2]: | ||
|
|
||
| ``` | ||
JDevlieghere marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| { | ||
| "mcpServers": { | ||
| "tool": { | ||
| "command": "/usr/bin/nc", | ||
| "args": ["localhost", "59999"] | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Configuration example for [Visual Studio Code][3]: | ||
|
|
||
| ``` | ||
| { | ||
| "mcp": { | ||
| "servers": { | ||
| "lldb": { | ||
| "type": "stdio", | ||
| "command": "/usr/bin/nc", | ||
| "args": ["localhost", "59999"] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
JDevlieghere marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| [1]: https://modelcontextprotocol.io | ||
| [2]: https://modelcontextprotocol.io/quickstart/user | ||
| [3]: https://code.visualstudio.com/docs/copilot/chat/mcp-servers | ||
JDevlieghere marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.