mirror of
https://github.com/svnscha/mcp-windbg.git
synced 2026-10-18 21:51:54 +08:00
Sven Scharmentke
a376c7c4ce
Adds open_kd_dump, which opens a kernel crash dump with kd.exe -z as a kd session. Closes #111
166 lines
6.5 KiB
Markdown
166 lines
6.5 KiB
Markdown
# Claude Code plugins
|
|
|
|
Install the server plugin if needed, then optionally add skills, agents, or both:
|
|
|
|
| Plugin | Server | Included workflows |
|
|
| --- | --- | --- |
|
|
| `mcp-windbg-uvx` | Launches the pinned server with uvx | MCP tools only |
|
|
| `mcp-windbg-skills` | Uses the uvx plugin or your own MCP connection | Four optional skills |
|
|
| `mcp-windbg-agents` | Uses the uvx plugin or your own MCP connection | Optional `crash-analyst` agent |
|
|
|
|
!!! note "Enterprise environments"
|
|
Managed `allowedMcpServers` settings can cause Claude Code to silently skip
|
|
plugin-bundled MCP servers ([issue #32882](https://github.com/anthropics/claude-code/issues/32882)).
|
|
I recommend [manual server installation and registration](clients.md#registering-the-server-directly)
|
|
plus the optional [skills](#skills-for-an-existing-server) or [agents](#agents-for-an-existing-server) plugin.
|
|
The server must still be permitted by your organization's MCP policy.
|
|
|
|
## Install
|
|
|
|
### Server with uvx
|
|
|
|
```text
|
|
/plugin marketplace add svnscha/mcp-windbg
|
|
/plugin install mcp-windbg-uvx@mcp-windbg
|
|
```
|
|
|
|
This plugin supplies the eleven [tools](tools.md) and default symbol
|
|
settings. It needs Windows with [Debugging Tools for Windows](https://aka.ms/windbg)
|
|
and [uv](https://docs.astral.sh/uv/) on `PATH` (`winget install astral-sh.uv`).
|
|
No separate Python or package installation is required. Skills and agents are not
|
|
included; install either optional plugin below if you want them.
|
|
|
|
### Skills for an existing server
|
|
|
|
```text
|
|
/plugin marketplace add svnscha/mcp-windbg
|
|
/plugin install mcp-windbg-skills@mcp-windbg
|
|
```
|
|
|
|
First install the uvx plugin above, [register mcp-windbg directly](clients.md#registering-the-server-directly),
|
|
or use a connection you already configured. The skills work with a native executable,
|
|
Python installation, or [HTTP service](../scenarios/http-service.md) exposing the
|
|
mcp-windbg tools. Windows and CDB/KD are required on the server host; an HTTP client
|
|
can run elsewhere. uv is needed only if your own server command uses it.
|
|
|
|
The skills-only plugin adds no server, runtime, agent, or symbol settings. It resolves
|
|
its tool calls through your existing MCP connection. If tools are missing, run
|
|
`/mcp-windbg-skills:windbg-doctor` to check that connection and its actual launcher.
|
|
|
|
### Agents for an existing server
|
|
|
|
```text
|
|
/plugin marketplace add svnscha/mcp-windbg
|
|
/plugin install mcp-windbg-agents@mcp-windbg
|
|
```
|
|
|
|
This plugin adds `mcp-windbg-agents:crash-analyst` for investigating a dump and
|
|
reporting a verdict, evidence, and next steps. It uses an existing mcp-windbg
|
|
connection, from uvx or your own registration, and requires no skills plugin.
|
|
It adds no server, runtime, or symbol settings.
|
|
|
|
All three plugins can be installed together. Adding or removing skills or agents
|
|
does not affect the server. Restart Claude Code if newly installed components do not appear.
|
|
|
|
## Skills
|
|
|
|
Only `mcp-windbg-skills` provides these workflows, with the same invocation names
|
|
regardless of how the server is installed:
|
|
|
|
| Workflow | Skill |
|
|
| --- | --- |
|
|
| Triage a crash dump | `/mcp-windbg-skills:analyze-dump` |
|
|
| Debug a live user-mode process | `/mcp-windbg-skills:debug-remote` |
|
|
| Drive a live kernel target | `/mcp-windbg-skills:kernel-debug` |
|
|
| Diagnose the debugging setup | `/mcp-windbg-skills:windbg-doctor` |
|
|
|
|
For example, with an independently installed server:
|
|
|
|
```text
|
|
/mcp-windbg-skills:analyze-dump C:\dumps\app.dmp
|
|
```
|
|
|
|
The server's built-in [MCP prompts](prompts.md) remain available with or without a
|
|
plugin. They are separate from these Claude Code skills.
|
|
|
|
## Agent
|
|
|
|
With the agents plugin installed, ask:
|
|
|
|
```text
|
|
Use the mcp-windbg-agents:crash-analyst agent on C:\dumps\app.dmp
|
|
```
|
|
|
|
The agent works through the available MCP tools directly. Its report includes
|
|
the commands it ran so you can reproduce the investigation.
|
|
|
|
## Server options and symbols
|
|
|
|
The uvx bundle launches the server using its `.mcp.json`, pinned to the matching
|
|
release. uvx fetches that version from PyPI on first use and caches it. Updating
|
|
the bundle updates the pinned server too.
|
|
|
|
The bundle supplies `_NT_SYMBOL_PATH` with the Microsoft symbol server and a
|
|
`C:\Symbols` cache only when you have not set your own value. To customize it:
|
|
|
|
```powershell
|
|
setx _NT_SYMBOL_PATH "SRV*C:\Symbols*https://msdl.microsoft.com/download/symbols;C:\my\pdbs"
|
|
```
|
|
|
|
Restart the terminal and Claude Code so new processes inherit the value.
|
|
|
|
For an independently registered server, configure symbols and [command-line options](cli.md)
|
|
in that registration. Updating skills or agents does not update the server or its
|
|
configuration. Use `--symbols-path` or `_NT_SYMBOL_PATH` on the server host; the
|
|
client shell's value may differ, especially over HTTP.
|
|
|
|
For custom `--cdb-path`, `--kd-path`, `--filter-script`, or timeout settings,
|
|
[register the server directly](clients.md#registering-the-server-directly) and add
|
|
either optional plugin. Edits to the installed uvx bundle are overwritten on update.
|
|
|
|
## Upgrade from bundled skills and agent
|
|
|
|
Earlier uvx plugin versions included four skills and `crash-analyst`. After updating,
|
|
install `mcp-windbg-skills@mcp-windbg` and/or `mcp-windbg-agents@mcp-windbg` to keep them. Change
|
|
skill invocations from `/mcp-windbg:` to `/mcp-windbg-skills:`; for example,
|
|
`/mcp-windbg:analyze-dump` becomes `/mcp-windbg-skills:analyze-dump`.
|
|
The agent is now `mcp-windbg-agents:crash-analyst`. Keep the uvx plugin installed
|
|
to continue using its server.
|
|
|
|
## Switch to a manually registered server
|
|
|
|
Finish open debugging sessions, then uninstall the bundle:
|
|
|
|
```text
|
|
/plugin uninstall mcp-windbg-uvx@mcp-windbg
|
|
```
|
|
|
|
[Register your server](clients.md#registering-the-server-directly) and restart Claude Code. Confirm the server
|
|
connection with `/mcp`, then run `/mcp-windbg-skills:windbg-doctor` if you installed
|
|
the skills plugin. Existing skills and agents installations can stay in place.
|
|
|
|
## Updating and removing
|
|
|
|
For the skills-only plugin:
|
|
|
|
```text
|
|
/plugin marketplace update mcp-windbg
|
|
/plugin update mcp-windbg-skills@mcp-windbg
|
|
```
|
|
|
|
For the other plugins, substitute `mcp-windbg-uvx@mcp-windbg` or
|
|
`mcp-windbg-agents@mcp-windbg` in the update command.
|
|
|
|
To remove the skills-only plugin:
|
|
|
|
```text
|
|
/plugin uninstall mcp-windbg-skills@mcp-windbg
|
|
```
|
|
|
|
Your MCP server, whether supplied by the uvx plugin or registered independently,
|
|
remains configured. To remove only the agent, uninstall `mcp-windbg-agents@mcp-windbg`.
|
|
For the uvx plugin,
|
|
uninstall `mcp-windbg-uvx@mcp-windbg` instead; that also removes its server registration.
|
|
Remove the marketplace with `/plugin marketplace remove mcp-windbg` when none of
|
|
its plugins are needed.
|