Skip to content

Commit 684158a

Browse files
Update the documentation
1 parent 12b3287 commit 684158a

File tree

5 files changed

+133
-352
lines changed

5 files changed

+133
-352
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,13 @@ dotnet run --project mcp_nexus/mcp_nexus.csproj -- --http
109109
3. **Get results**:
110110
```json
111111
{
112-
"method": "resources/read",
112+
"method": "tools/call",
113113
"params": {
114-
"uri": "mcp://nexus/commands/result?sessionId=sess-123&commandId=cmd-456"
114+
"name": "nexus_read_dump_analyze_command_result",
115+
"arguments": {
116+
"sessionId": "sess-123",
117+
"commandId": "cmd-456"
118+
}
115119
}
116120
}
117121
```
@@ -215,18 +219,14 @@ MCP Nexus provides live updates during analysis:
215219
- **`nexus_enqueue_async_dump_analyze_command`**: Execute debugging commands
216220
- **`nexus_read_dump_analyze_command_result`**: Get command results
217221

218-
### Advanced Analysis Tools
219-
- **`nexus_start_remote_debug`**: Start remote debugging session
220-
- **`nexus_stop_remote_debug`**: Stop remote debugging session
221-
- **`nexus_debugger_command_cancel`**: Cancel running commands
222-
- **`nexus_list_debugger_commands`**: List available debugging commands
223222

224223
### MCP Resources
225-
- **`mcp://nexus/sessions/list`**: List all active analysis sessions
226-
- **`mcp://nexus/commands/list`**: List commands with filtering options
227-
- **`mcp://nexus/commands/result`**: Get detailed command results
228-
- **`mcp://nexus/docs/workflows`**: Access analysis workflows and patterns
229-
- **`mcp://nexus/docs/usage`**: Complete usage guide and examples
224+
- **`sessions`**: List all active analysis sessions
225+
- **`commands`**: List commands with filtering options
226+
- **`workflows`**: Access analysis workflows and patterns
227+
- **`usage`**: Complete usage guide and examples
228+
- **`metrics`**: Performance metrics and statistics
229+
- **`health`**: System health status
230230

231231
## 📊 Analysis Workflows
232232

@@ -368,7 +368,7 @@ MCP Nexus
368368

369369
### Common Issues
370370
- **Symbol Loading**: Ensure symbol path is configured correctly
371-
- **Permission Errors**: Run with administrator privileges for system dumps
371+
- **Permission Errors**: Check file access permissions
372372
- **Timeout Issues**: Increase command timeout for large dumps
373373
- **Memory Issues**: Ensure sufficient RAM for large dump analysis
374374

docs/CONFIGURATION.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
- **Windows 10/11** or **Windows Server 2016+**
1111
- **.NET 8.0** or later
1212
- **Windows Debugging Tools** (WinDBG/CDB)
13-
- **Administrator privileges** (for system dump analysis)
1413

1514
### Installation Steps
1615

@@ -382,7 +381,6 @@ set MCP_NEXUS_CDB_PATH=C:\Program Files\Windows Kits\10\Debuggers\x64\cdb.exe
382381

383382
**Dump File Access**:
384383
- Ensure MCP Nexus has read access to dump files
385-
- For system dumps, run with administrator privileges
386384
- Consider using dedicated service account for production
387385

388386
**Symbol Server Access**:
@@ -408,7 +406,6 @@ set MCP_NEXUS_CDB_PATH=C:\Program Files\Windows Kits\10\Debuggers\x64\cdb.exe
408406
- Ensure sufficient disk space for symbol cache
409407

410408
**Permission Errors**:
411-
- Run with administrator privileges
412409
- Check file access permissions
413410
- Verify service account permissions
414411

0 commit comments

Comments
 (0)