mcp-windbg


Namemcp-windbg JSON
Version 0.10.0 PyPI version JSON
download
home_pageNone
SummaryA Model Context Protocol server providing tools to analyze Windows crash dumps using WinDbg/CDB
upload_time2025-10-11 19:30:23
maintainerNone
docs_urlNone
authorsvnscha
requires_python>=3.10
licenseNone
keywords windbg cdb mcp llm crash-analysis
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # MCP Server for WinDbg Crash Analysis

A Model Context Protocol server that bridges AI models with WinDbg for crash dump analysis and remote debugging.

<!-- mcp-name: io.github.svnscha/mcp-windbg -->

## 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, 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
```

### Configuration

Create `.vscode/mcp.json` in your 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"
            }
        }
    }
}
```

> **Other MCP Clients**: Configuration for Claude Desktop, Cline, and other clients is available in the [Installation documentation](https://github.com/svnscha/mcp-windbg/wiki/Installation).

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://github.com/svnscha/mcp-windbg/wiki/Tools#list_windbg_dumps) | List crash dump files | Discovery and batch analysis |
| [`open_windbg_dump`](https://github.com/svnscha/mcp-windbg/wiki/Tools#open_windbg_dump) | Analyze crash dumps | Initial crash dump analysis |
| [`close_windbg_dump`](https://github.com/svnscha/mcp-windbg/wiki/Tools#close_windbg_dump) | Cleanup dump sessions | Resource management |
| [`open_windbg_remote`](https://github.com/svnscha/mcp-windbg/wiki/Tools#open_windbg_remote) | Connect to remote debugging | Live debugging sessions |
| [`close_windbg_remote`](https://github.com/svnscha/mcp-windbg/wiki/Tools#close_windbg_remote) | Cleanup remote sessions | Resource management |
| [`run_windbg_cmd`](https://github.com/svnscha/mcp-windbg/wiki/Tools#run_windbg_cmd) | Execute WinDbg commands | Custom analysis and investigation |

## Documentation

**[Documentation](https://github.com/svnscha/mcp-windbg/wiki)**

| Topic | Description |
|-------|-------------|
| **[Getting Started](https://github.com/svnscha/mcp-windbg/wiki/Getting-Started)** | Quick setup and first steps |
| **[Installation](https://github.com/svnscha/mcp-windbg/wiki/Installation)** | Detailed installation for pip, MCP registry, and from source |
| **[Usage](https://github.com/svnscha/mcp-windbg/wiki/Usage)** | MCP client integration, command-line usage, and workflows |
| **[Tools Reference](https://github.com/svnscha/mcp-windbg/wiki/Tools)** | Complete API reference and examples |
| **[Troubleshooting](https://github.com/svnscha/mcp-windbg/wiki/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"

> "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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mcp-windbg",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "windbg, cdb, mcp, llm, crash-analysis",
    "author": "svnscha",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/d4/9e/34e068f35d7eb6275ce393653c81a1fb118f2d2bf1827f2a56bc205d4c37/mcp_windbg-0.10.0.tar.gz",
    "platform": null,
    "description": "# MCP Server for WinDbg Crash Analysis\r\n\r\nA Model Context Protocol server that bridges AI models with WinDbg for crash dump analysis and remote debugging.\r\n\r\n<!-- mcp-name: io.github.svnscha/mcp-windbg -->\r\n\r\n## Overview\r\n\r\nThis 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.\r\n\r\n## What is this?\r\n\r\nAn 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\"*.\r\n\r\n## What This is Not\r\n\r\nNot a magical auto-fix solution. It's a Python wrapper around CDB that leverages LLM knowledge to assist with debugging.\r\n\r\n## Usage Modes\r\n\r\n- **Crash Dump Analysis**: Examine Windows crash dumps\r\n- **Live Debugging**: Connect to remote debugging targets\r\n- **Directory Analysis**: Process multiple dumps for patterns\r\n\r\n## Quick Start\r\n\r\n### Prerequisites\r\n- 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).\r\n- Python 3.10 or higher\r\n- Any MCP-compatible client (GitHub Copilot, Claude Desktop, Cline, etc.)\r\n- Configure MCP server in your chosen client\r\n\r\n> [!TIP]\r\n> 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.\r\n\r\n### Installation\r\n```bash\r\npip install mcp-windbg\r\n```\r\n\r\n### Configuration\r\n\r\nCreate `.vscode/mcp.json` in your workspace:\r\n```json\r\n{\r\n    \"servers\": {\r\n        \"mcp_windbg\": {\r\n            \"type\": \"stdio\",\r\n            \"command\": \"python\",\r\n            \"args\": [\"-m\", \"mcp_windbg\"],\r\n            \"env\": {\r\n                \"_NT_SYMBOL_PATH\": \"SRV*C:\\\\Symbols*https://msdl.microsoft.com/download/symbols\"\r\n            }\r\n        }\r\n    }\r\n}\r\n```\r\n\r\n> **Other MCP Clients**: Configuration for Claude Desktop, Cline, and other clients is available in the [Installation documentation](https://github.com/svnscha/mcp-windbg/wiki/Installation).\r\n\r\nOnce configured, restart your MCP client and start debugging:\r\n\r\n```\r\nAnalyze the crash dump at C:\\dumps\\app.dmp\r\n```\r\n\r\n## MCP Compatibility\r\n\r\nThis server implements the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/), making it compatible with any MCP-enabled client:\r\n\r\nThe beauty of MCP is that you write the server once, and it works everywhere. Choose your favorite AI assistant!\r\n\r\n### Tools\r\n\r\n| Tool | Purpose | Use Case |\r\n|------|---------|----------|\r\n| [`list_windbg_dumps`](https://github.com/svnscha/mcp-windbg/wiki/Tools#list_windbg_dumps) | List crash dump files | Discovery and batch analysis |\r\n| [`open_windbg_dump`](https://github.com/svnscha/mcp-windbg/wiki/Tools#open_windbg_dump) | Analyze crash dumps | Initial crash dump analysis |\r\n| [`close_windbg_dump`](https://github.com/svnscha/mcp-windbg/wiki/Tools#close_windbg_dump) | Cleanup dump sessions | Resource management |\r\n| [`open_windbg_remote`](https://github.com/svnscha/mcp-windbg/wiki/Tools#open_windbg_remote) | Connect to remote debugging | Live debugging sessions |\r\n| [`close_windbg_remote`](https://github.com/svnscha/mcp-windbg/wiki/Tools#close_windbg_remote) | Cleanup remote sessions | Resource management |\r\n| [`run_windbg_cmd`](https://github.com/svnscha/mcp-windbg/wiki/Tools#run_windbg_cmd) | Execute WinDbg commands | Custom analysis and investigation |\r\n\r\n## Documentation\r\n\r\n**[Documentation](https://github.com/svnscha/mcp-windbg/wiki)**\r\n\r\n| Topic | Description |\r\n|-------|-------------|\r\n| **[Getting Started](https://github.com/svnscha/mcp-windbg/wiki/Getting-Started)** | Quick setup and first steps |\r\n| **[Installation](https://github.com/svnscha/mcp-windbg/wiki/Installation)** | Detailed installation for pip, MCP registry, and from source |\r\n| **[Usage](https://github.com/svnscha/mcp-windbg/wiki/Usage)** | MCP client integration, command-line usage, and workflows |\r\n| **[Tools Reference](https://github.com/svnscha/mcp-windbg/wiki/Tools)** | Complete API reference and examples |\r\n| **[Troubleshooting](https://github.com/svnscha/mcp-windbg/wiki/Troubleshooting)** | Common issues and solutions |\r\n\r\n## Examples\r\n\r\n### Crash Dump Analysis\r\n\r\n> Analyze this heap address with !heap -p -a 0xABCD1234 and check for buffer overflow\"\r\n\r\n> Execute !peb and tell me if there are any environment variables that might affect this crash\"\r\n\r\n> Run .ecxr followed by k and explain the exception's root cause\"\r\n\r\n### Remote Debugging\r\n\r\n> \"Connect to tcp:Port=5005,Server=192.168.0.100 and show me the current thread state\"\r\n\r\n> \"Check for timing issues in the thread pool with !runaway and !threads\"\r\n\r\n> \"Show me all threads with ~*k and identify which one is causing the hang\"\r\n\r\n## Blog\r\n\r\nRead about the development journey: [The Future of Crash Analysis: AI Meets WinDbg](https://svnscha.de/posts/ai-meets-windbg/)\r\n\r\n### Links\r\n\r\n- [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/)\r\n- [Hackernews: AI Meets WinDbg](https://news.ycombinator.com/item?id=43892096)\r\n\r\n## Star History\r\n\r\n[![Star History Chart](https://api.star-history.com/svg?repos=svnscha/mcp-windbg&type=Date)](https://www.star-history.com/#svnscha/mcp-windbg&Date)\r\n\r\n## License\r\n\r\nMIT\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Model Context Protocol server providing tools to analyze Windows crash dumps using WinDbg/CDB",
    "version": "0.10.0",
    "project_urls": null,
    "split_keywords": [
        "windbg",
        " cdb",
        " mcp",
        " llm",
        " crash-analysis"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b6afb17bc73852e786b59028223a3675dc67bbdf0d7713b5470b4602bb8d9add",
                "md5": "5c21de54bebec7c15edc9d3e6570cd6d",
                "sha256": "b8dadd97e78a37131caf69c14a3eff5b8a80ecd6df2db72d099b60c0547c9853"
            },
            "downloads": -1,
            "filename": "mcp_windbg-0.10.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5c21de54bebec7c15edc9d3e6570cd6d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 16603,
            "upload_time": "2025-10-11T19:30:22",
            "upload_time_iso_8601": "2025-10-11T19:30:22.906532Z",
            "url": "https://files.pythonhosted.org/packages/b6/af/b17bc73852e786b59028223a3675dc67bbdf0d7713b5470b4602bb8d9add/mcp_windbg-0.10.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d49e34e068f35d7eb6275ce393653c81a1fb118f2d2bf1827f2a56bc205d4c37",
                "md5": "437a1e58e9c2d07a3de246c402f37c81",
                "sha256": "a5cf57f740cf1defa57cdd70c51a2c0d5bf311b4a45aaf1069fbb3e5bb426aab"
            },
            "downloads": -1,
            "filename": "mcp_windbg-0.10.0.tar.gz",
            "has_sig": false,
            "md5_digest": "437a1e58e9c2d07a3de246c402f37c81",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 16728,
            "upload_time": "2025-10-11T19:30:23",
            "upload_time_iso_8601": "2025-10-11T19:30:23.673033Z",
            "url": "https://files.pythonhosted.org/packages/d4/9e/34e068f35d7eb6275ce393653c81a1fb118f2d2bf1827f2a56bc205d4c37/mcp_windbg-0.10.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-11 19:30:23",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "mcp-windbg"
}
        
Elapsed time: 1.30399s