# mcp-windbg **Repository Path**: cj5035123/mcp-windbg ## Basic Information - **Project Name**: mcp-windbg - **Description**: fork from https://svnscha.github.io/mcp-windbg/ Windbg的Mcp服务 - **Primary Language**: Python - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-06-27 - **Last Updated**: 2026-06-27 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # MCP Server for WinDbg Crash Analysis [![CI](https://github.com/svnscha/mcp-windbg/actions/workflows/ci.yml/badge.svg)](https://github.com/svnscha/mcp-windbg/actions/workflows/ci.yml) [![Docs](https://github.com/svnscha/mcp-windbg/actions/workflows/pages.yml/badge.svg)](https://svnscha.github.io/mcp-windbg/) [![PyPI](https://img.shields.io/pypi/v/mcp-windbg)](https://pypi.org/project/mcp-windbg/) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) ![Platform: Windows](https://img.shields.io/badge/platform-Windows-0078D6) ![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-3776AB) A Model Context Protocol server that bridges AI models with WinDbg for crash dump analysis and remote debugging. ## Overview This MCP server integrates with [CDB](https://learn.microsoft.com/en-us/windows-hardware/drivers/debugger/opening-a-crash-dump-file-using-cdb) to enable AI models to analyze Windows crash dumps and connect to remote debugging sessions using WinDbg/CDB. ## What is this? An AI-powered tool that bridges LLMs with WinDbg for crash dump analysis and live debugging. Execute debugger commands through natural language queries like *"Show me the call stack and explain this access violation"*. ## What This is Not Not a magical auto-fix solution. It's a Python wrapper around CDB that leverages LLM knowledge to assist with debugging. ## Usage Modes - **Crash Dump Analysis**: Examine Windows crash dumps - **Live Debugging**: Connect to remote debugging targets - **Directory Analysis**: Process multiple dumps for patterns ## Quick Start ### Prerequisites - Windows with [Debugging Tools for Windows](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/) or [WinDbg from Microsoft Store](https://apps.microsoft.com/detail/9pgjgd53tn86). - Python 3.10 or higher - Any MCP-compatible client (GitHub Copilot, Claude Desktop, Cline, Cursor, Windsurf etc.) - Configure MCP server in your chosen client > [!TIP] > In enterprise environments, MCP server usage might be restricted by organizational policies. Check with your IT team about AI tool usage and ensure you have the necessary permissions before proceeding. ### Installation ```bash pip install mcp-windbg ``` ## Transport Options The MCP server supports multiple transport protocols: | Transport | Description | Use Case | |-----------|-------------|----------| | `stdio` (default) | Standard input/output | Local MCP clients like VS Code, Claude Desktop | | `streamable-http` | Streamable HTTP | Modern HTTP clients with bidirectional streaming | ### Starting with Different Transports **Standard I/O (default):** ```bash mcp-windbg # or explicitly mcp-windbg --transport stdio ``` **Streamable HTTP:** ```bash mcp-windbg --transport streamable-http --host 127.0.0.1 --port 8000 ``` Endpoint: `http://127.0.0.1:8000/mcp` ### Command Line Options ``` --transport {stdio,streamable-http} Transport protocol (default: stdio) --host HOST HTTP server host (default: 127.0.0.1) --port PORT HTTP server port (default: 8000) --cdb-path PATH Custom path to cdb.exe --symbols-path PATH Custom symbols path --filter-script PATH Python script with process_input/process_output tool text hooks --timeout SECONDS Command timeout (default: 30) --verbose Enable verbose output ``` ### Filter Script Hooks Use `--filter-script` to load a small Python helper that rewrites tool text only (for example, to redact PII) without seeing the full MCP JSON-RPC envelope: ```bash mcp-windbg --filter-script C:\filters\pii_redaction.py ``` The script defines `process_input` and/or `process_output` callbacks and runs in-process, so treat it as trusted code. See [Redact sensitive data](https://svnscha.github.io/mcp-windbg/scenarios/redaction/) for the callback contract and a worked example. ## Configuration `mcp-windbg` works with any MCP client. Two common setups are below; see the [client configuration guide](https://svnscha.github.io/mcp-windbg/reference/clients/) for Claude Desktop, Copilot CLI, HTTP, and from-source. **VS Code (GitHub Copilot)** - press `F1` and select **MCP: Open User Configuration** to enable it in every workspace: ```json { "servers": { "mcp_windbg": { "type": "stdio", "command": "python", "args": ["-m", "mcp_windbg"], "env": { "_NT_SYMBOL_PATH": "SRV*C:\\Symbols*https://msdl.microsoft.com/download/symbols" } } } } ``` **Claude Code** - register the server from the command line: ```bash claude mcp add mcp-windbg -s user -e _NT_SYMBOL_PATH="SRV*C:\Symbols*https://msdl.microsoft.com/download/symbols" -- python -m mcp_windbg ``` Prefer not to install the package? Replace `python -m mcp_windbg` with `uvx --from git+https://github.com/svnscha/mcp-windbg mcp-windbg` in either setup to fetch and run the server on demand. Once configured, restart your MCP client and start debugging: ``` Analyze the crash dump at C:\dumps\app.dmp ``` ## MCP Compatibility This server implements the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/), making it compatible with any MCP-enabled client: The beauty of MCP is that you write the server once, and it works everywhere. Choose your favorite AI assistant! ### Tools | Tool | Purpose | Use Case | |------|---------|----------| | [`list_windbg_dumps`](https://svnscha.github.io/mcp-windbg/reference/tools/#list_windbg_dumps) | List crash dump files | Discovery and batch analysis | | [`open_windbg_dump`](https://svnscha.github.io/mcp-windbg/reference/tools/#open_windbg_dump) | Analyze crash dumps | Initial crash dump analysis | | [`close_windbg_dump`](https://svnscha.github.io/mcp-windbg/reference/tools/#close_windbg_dump) | Cleanup dump sessions | Resource management | | [`open_windbg_remote`](https://svnscha.github.io/mcp-windbg/reference/tools/#open_windbg_remote) | Connect to remote debugging | Live debugging sessions | | [`close_windbg_remote`](https://svnscha.github.io/mcp-windbg/reference/tools/#close_windbg_remote) | Cleanup remote sessions | Resource management | | [`run_windbg_cmd`](https://svnscha.github.io/mcp-windbg/reference/tools/#run_windbg_cmd) | Execute WinDbg commands | Custom analysis and investigation | | [`send_ctrl_break`](https://svnscha.github.io/mcp-windbg/reference/tools/#send_ctrl_break) | Break into a running target | Interrupt execution during live debugging | ## Documentation **[Documentation](https://svnscha.github.io/mcp-windbg/)** | Topic | Description | |-------|-------------| | **[Getting Started](https://svnscha.github.io/mcp-windbg/getting-started/)** | Quick setup and first crash dump analysis | | **[Use cases](https://svnscha.github.io/mcp-windbg/scenarios/)** | Analyze a dump, debug a remote target, triage many dumps | | **[Command-line options](https://svnscha.github.io/mcp-windbg/reference/cli/)** | Every CLI flag, transports, and filter hooks | | **[Tools Reference](https://svnscha.github.io/mcp-windbg/reference/tools/)** | The MCP tools and their parameters | | **[Client configuration](https://svnscha.github.io/mcp-windbg/reference/clients/)** | VS Code, Claude Desktop, Copilot CLI, pip, and source | | **[Troubleshooting](https://svnscha.github.io/mcp-windbg/troubleshooting/)** | Common issues and solutions | ## Examples ### Crash Dump Analysis > Analyze this heap address with !heap -p -a 0xABCD1234 and check for buffer overflow" > Execute !peb and tell me if there are any environment variables that might affect this crash" > Run .ecxr followed by k and explain the exception's root cause" ### Remote Debugging > "Connect to tcp:Port=5005,Server=192.168.0.100 and show me the current thread state" > "Send CTRL+BREAK to the live session, then dump all thread stacks with ~*k" > "Check for timing issues in the thread pool with !runaway and !threads" > "Show me all threads with ~*k and identify which one is causing the hang" ## Blog Read about the development journey: [The Future of Crash Analysis: AI Meets WinDbg](https://svnscha.de/posts/ai-meets-windbg/) ### Links - [Reddit: I taught Copilot to analyze Windows Crash Dumps](https://www.reddit.com/r/programming/comments/1kes3wq/i_taught_copilot_to_analyze_windows_crash_dumps/) - [Hackernews: AI Meets WinDbg](https://news.ycombinator.com/item?id=43892096) ## Star History [![Star History Chart](https://api.star-history.com/svg?repos=svnscha/mcp-windbg&type=Date)](https://www.star-history.com/#svnscha/mcp-windbg&Date) ## License MIT