Skip to content

Commit fc4f627

Browse files
committed
Minor fixes to README.md.
1 parent cf330bc commit fc4f627

File tree

1 file changed

+20
-24
lines changed

1 file changed

+20
-24
lines changed

README.md

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,17 @@ This MCP server integrates with [CDB](https://learn.microsoft.com/en-us/windows-
1010

1111
## What is this?
1212

13-
**Primarily**, a tool that enables AI to interact with WinDbg for both crash dump analysis and live debugging. The "magic" is giving LLMs the ability to execute debugger commands on crash dumps or remote debugging targets.
13+
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"*.
1414

15-
This means you can:
16-
- Get immediate first-level triage analysis for categorizing crash dumps
17-
- Perform natural language-based analysis: *"Show me the call stack and explain what might be causing this access violation"*
18-
- Auto-analyze simple cases and get insights for complex debugging scenarios
19-
- Connect to live debugging sessions for real-time analysis
15+
## What This is Not
2016

21-
**What this is NOT**: A magical solution that automatically fixes all issues. It's a **simple Python wrapper around CDB** that **relies** on the **LLM's WinDbg** expertise.
17+
Not a magical auto-fix solution. It's a Python wrapper around CDB that leverages LLM knowledge to assist with debugging.
2218

23-
## MCP Compatibility
24-
25-
This server implements the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/), making it compatible with any MCP-enabled client:
19+
## Usage Modes
2620

27-
- **GitHub Copilot** - Recommended for VS Code users
28-
- **Claude Desktop** - Anthropic's desktop application
29-
- **Cline** - VS Code extension for autonomous coding
30-
- **Continue** - Open-source coding assistant
31-
- **Any other MCP client** - The protocol is open and extensible
32-
33-
The beauty of MCP is that you write the server once, and it works everywhere. Choose your favorite AI assistant!
21+
- **Crash Dump Analysis**: Examine Windows crash dumps
22+
- **Live Debugging**: Connect to remote debugging targets
23+
- **Directory Analysis**: Process multiple dumps for patterns
3424

3525
## Quick Start
3626

@@ -74,16 +64,22 @@ Once configured, restart your MCP client and start debugging:
7464
Analyze the crash dump at C:\dumps\app.dmp
7565
```
7666

77-
## Tools
67+
## MCP Compatibility
68+
69+
This server implements the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/), making it compatible with any MCP-enabled client:
70+
71+
The beauty of MCP is that you write the server once, and it works everywhere. Choose your favorite AI assistant!
72+
73+
### Tools
7874

7975
| Tool | Purpose | Use Case |
8076
|------|---------|----------|
81-
| [`list_windbg_dumps`](#list_windbg_dumps) | List crash dump files | Discovery and batch analysis |
82-
| [`open_windbg_dump`](#open_windbg_dump) | Analyze crash dumps | Initial crash dump analysis |
83-
| [`close_windbg_dump`](#close_windbg_dump) | Cleanup dump sessions | Resource management |
84-
| [`open_windbg_remote`](#open_windbg_remote) | Connect to remote debugging | Live debugging sessions |
85-
| [`close_windbg_remote`](#close_windbg_remote) | Cleanup remote sessions | Resource management |
86-
| [`run_windbg_cmd`](#run_windbg_cmd) | Execute WinDbg commands | Custom analysis and investigation |
77+
| [`list_windbg_dumps`](https://github.com/svnscha/mcp-windbg/wiki/Tools#list_windbg_dumps) | List crash dump files | Discovery and batch analysis |
78+
| [`open_windbg_dump`](https://github.com/svnscha/mcp-windbg/wiki/Tools#open_windbg_dump) | Analyze crash dumps | Initial crash dump analysis |
79+
| [`close_windbg_dump`](https://github.com/svnscha/mcp-windbg/wiki/Tools#close_windbg_dump) | Cleanup dump sessions | Resource management |
80+
| [`open_windbg_remote`](https://github.com/svnscha/mcp-windbg/wiki/Tools#open_windbg_remote) | Connect to remote debugging | Live debugging sessions |
81+
| [`close_windbg_remote`](https://github.com/svnscha/mcp-windbg/wiki/Tools#close_windbg_remote) | Cleanup remote sessions | Resource management |
82+
| [`run_windbg_cmd`](https://github.com/svnscha/mcp-windbg/wiki/Tools#run_windbg_cmd) | Execute WinDbg commands | Custom analysis and investigation |
8783

8884
## Documentation
8985

0 commit comments

Comments
 (0)