|
| 1 | +# TypeScript MCP Debugger |
| 2 | + |
| 3 | +Enterprise-grade debugging for Node.js and TypeScript applications with 25+ specialized tools. |
| 4 | + |
| 5 | +## Documentation |
| 6 | + |
| 7 | +For complete documentation, visit: |
| 8 | +- **Main Documentation**: https://github.com/digital-defiance/ai-capabilities-suite/tree/main/packages/mcp-debugger-server#readme |
| 9 | +- **Tool Reference**: https://github.com/digital-defiance/ai-capabilities-suite/blob/main/packages/mcp-debugger-server/TOOL-REFERENCE.md |
| 10 | +- **AI Agent Integration**: https://github.com/digital-defiance/ai-capabilities-suite/blob/main/packages/mcp-debugger-server/AI-AGENT-INTEGRATION.md |
| 11 | +- **VS Code Integration**: https://github.com/digital-defiance/ai-capabilities-suite/blob/main/packages/mcp-debugger-server/VSCODE-INTEGRATION.md |
| 12 | + |
| 13 | +## Features |
| 14 | + |
| 15 | +### Core Debugging |
| 16 | +- **Breakpoint Management**: Set, remove, toggle, and list breakpoints with conditions, hit counts, and logpoints |
| 17 | +- **Execution Control**: Continue, step over/into/out, and pause execution |
| 18 | +- **Variable Inspection**: Inspect local/global variables, evaluate expressions, watch variables |
| 19 | +- **Call Stack Navigation**: View and navigate stack frames with context switching |
| 20 | + |
| 21 | +### Advanced Features |
| 22 | +- **Hang Detection**: Detect infinite loops and hanging processes |
| 23 | +- **TypeScript Support**: Full source map support for TypeScript debugging |
| 24 | +- **Performance Profiling**: CPU profiling, memory profiling, heap snapshots |
| 25 | +- **Test Framework Integration**: Debug Jest, Mocha, and Vitest tests |
| 26 | + |
| 27 | +### Enterprise Features |
| 28 | +- **Observability**: Structured logging, metrics, health checks, Prometheus export |
| 29 | +- **Security**: Authentication, rate limiting, data masking, audit logging |
| 30 | +- **Production Ready**: Circuit breakers, retry logic, graceful shutdown, resource limits |
| 31 | + |
| 32 | +## Quick Start |
| 33 | + |
| 34 | +### Using Docker Desktop MCP Toolkit |
| 35 | + |
| 36 | +1. Enable the server in Docker Desktop's MCP Toolkit |
| 37 | +2. Configure environment variables (optional): |
| 38 | + - `NODE_ENV`: production (default) or development |
| 39 | + - `LOG_LEVEL`: info (default), debug, warn, or error |
| 40 | +3. Start using the debugging tools in your AI agent |
| 41 | + |
| 42 | +### Using Docker CLI |
| 43 | + |
| 44 | +```bash |
| 45 | +docker run -d \ |
| 46 | + --name mcp-debugger \ |
| 47 | + -e NODE_ENV=production \ |
| 48 | + -e LOG_LEVEL=info \ |
| 49 | + digidefiance/mcp-debugger-server:latest |
| 50 | +``` |
| 51 | + |
| 52 | +### Using Docker Compose |
| 53 | + |
| 54 | +```yaml |
| 55 | +version: '3.8' |
| 56 | +services: |
| 57 | + mcp-debugger: |
| 58 | + image: digidefiance/mcp-debugger-server:latest |
| 59 | + environment: |
| 60 | + - NODE_ENV=production |
| 61 | + - LOG_LEVEL=info |
| 62 | + restart: unless-stopped |
| 63 | +``` |
| 64 | +
|
| 65 | +## Available Tools |
| 66 | +
|
| 67 | +The server provides 25 debugging tools: |
| 68 | +
|
| 69 | +### Session Management |
| 70 | +- `debugger_start` - Start a new debug session |
| 71 | +- `debugger_stop_session` - Stop a debug session |
| 72 | + |
| 73 | +### Breakpoints |
| 74 | +- `debugger_set_breakpoint` - Set a breakpoint with optional condition |
| 75 | +- `debugger_remove_breakpoint` - Remove a breakpoint |
| 76 | +- `debugger_toggle_breakpoint` - Toggle breakpoint enabled/disabled |
| 77 | +- `debugger_list_breakpoints` - List all breakpoints |
| 78 | + |
| 79 | +### Execution Control |
| 80 | +- `debugger_continue` - Resume execution |
| 81 | +- `debugger_step_over` - Step over current line |
| 82 | +- `debugger_step_into` - Step into function call |
| 83 | +- `debugger_step_out` - Step out of current function |
| 84 | +- `debugger_pause` - Pause execution |
| 85 | + |
| 86 | +### Variable Inspection |
| 87 | +- `debugger_inspect` - Evaluate an expression |
| 88 | +- `debugger_get_local_variables` - Get local variables |
| 89 | +- `debugger_get_global_variables` - Get global variables |
| 90 | +- `debugger_inspect_object` - Inspect object properties |
| 91 | +- `debugger_add_watch` - Add a watch expression |
| 92 | +- `debugger_remove_watch` - Remove a watch expression |
| 93 | +- `debugger_get_watches` - Get all watched expressions |
| 94 | + |
| 95 | +### Call Stack |
| 96 | +- `debugger_get_stack` - Get current call stack |
| 97 | +- `debugger_switch_stack_frame` - Switch to a different stack frame |
| 98 | + |
| 99 | +### Advanced Features |
| 100 | +- `debugger_detect_hang` - Detect hanging processes and infinite loops |
| 101 | +- `debugger_start_cpu_profile` - Start CPU profiling |
| 102 | +- `debugger_stop_cpu_profile` - Stop CPU profiling and get results |
| 103 | +- `debugger_take_heap_snapshot` - Take a heap snapshot |
| 104 | +- `debugger_get_performance_metrics` - Get performance metrics |
| 105 | + |
| 106 | +## Use Cases |
| 107 | + |
| 108 | +### Debugging Failing Tests |
| 109 | +``` |
| 110 | +1. Start debug session with test command |
| 111 | +2. Set breakpoints in test code |
| 112 | +3. Step through execution to find the issue |
| 113 | +4. Inspect variables to understand state |
| 114 | +5. Fix the bug and verify |
| 115 | +``` |
| 116 | +
|
| 117 | +### Performance Analysis |
| 118 | +``` |
| 119 | +1. Start debug session with your application |
| 120 | +2. Start CPU profiling |
| 121 | +3. Run performance-critical code |
| 122 | +4. Stop profiling and analyze results |
| 123 | +5. Identify bottlenecks and optimize |
| 124 | +``` |
| 125 | +
|
| 126 | +### Detecting Infinite Loops |
| 127 | +``` |
| 128 | +1. Use debugger_detect_hang with your code |
| 129 | +2. Configure timeout and sample interval |
| 130 | +3. Get hang location and call stack |
| 131 | +4. Fix the infinite loop |
| 132 | +``` |
| 133 | +
|
| 134 | +### TypeScript Debugging |
| 135 | +``` |
| 136 | +1. Start debug session with TypeScript code |
| 137 | +2. Set breakpoints in .ts files (not .js) |
| 138 | +3. Source maps automatically map locations |
| 139 | +4. Inspect variables with TypeScript names |
| 140 | +5. Debug with original source code |
| 141 | +``` |
| 142 | +
|
| 143 | +## System Requirements |
| 144 | +
|
| 145 | +- **Node.js**: >= 18.0.0 |
| 146 | +- **Docker**: Latest version recommended |
| 147 | +- **Memory**: Minimum 512MB, recommended 1GB+ |
| 148 | +- **CPU**: x64 or arm64 architecture |
| 149 | +
|
| 150 | +## Support |
| 151 | +
|
| 152 | +- **GitHub Issues**: https://github.com/digital-defiance/ai-capabilities-suite/issues |
| 153 | +- **Email**: info@digitaldefiance.org |
| 154 | +- **Documentation**: https://github.com/digital-defiance/ai-capabilities-suite/tree/main/packages/mcp-debugger-server |
| 155 | +
|
| 156 | +## License |
| 157 | +
|
| 158 | +MIT License - See [LICENSE](https://github.com/digital-defiance/ai-capabilities-suite/blob/main/LICENSE) for details. |
| 159 | +
|
| 160 | +## Author |
| 161 | +
|
| 162 | +**Digital Defiance** |
| 163 | +- Website: https://digitaldefiance.org |
| 164 | +- GitHub: https://github.com/digital-defiance |
| 165 | +- Email: info@digitaldefiance.org |
0 commit comments