MCP Debug

🚀 MCP Debug

A debugging and development tool for Model Context Protocol (MCP) servers, enabling rapid development and testing with features like hot-swapping, session recording, and automated playback testing.

✨ Features

Hot-Swap Development

• Replace server binaries without disconnecting MCP clients.
• Dynamically add or remove servers during development.
• Preserve the tool name, maintaining the same interface with a new implementation.
• Implement a graceful disconnect/reconnect workflow for binary replacement.

Session Recording & Playback

• Record JSON-RPC traffic for debugging and documentation purposes.
• Support playback client mode to replay requests and test servers.
• Support playback server mode to replay responses and test clients.
• Conduct regression testing using recorded sessions.

Development Proxy

• Aggregate multiple servers with tool prefixing.
• Monitor connections in real-time.
• Provide a management API for server lifecycle control.
• Offer comprehensive logging.

📦 Installation

# Using uvx (Python - recommended)
uvx mcp-debug --help

# Using npx (Node.js)
npx @standardbeagle/mcp-debug --help

# Or install globally
pip install mcp-debug              # Python
npm install -g @standardbeagle/mcp-debug  # Node.js

# Or build from source
go install github.com/standardbeagle/mcp-debug@latest

🚀 Quick Start

# Start proxy with a config file
uvx mcp-debug --proxy --config config.yaml

# Or with mcp-tui for interactive testing
mcp-tui uvx mcp-debug --proxy --config config.yaml

💻 Usage Examples

Proxy Mode

# Basic proxy
uvx mcp-debug --proxy --config config.yaml

# With recording
uvx mcp-debug --proxy --config config.yaml --record session.jsonl

# With custom log file
uvx mcp-debug --proxy --config config.yaml --log /tmp/debug.log

Management Tools:

• server_add - Add a server: {name: "fs", command: "npx -y @mcp/filesystem /path"}
• server_remove - Remove a server completely.
• server_disconnect - Disconnect a server (tools return errors).
• server_reconnect - Reconnect with a new command.
• server_list - Show all servers and their status.

Playback Modes

# Replay recorded requests to test a server
uvx mcp-debug --playback-client session.jsonl | ./your-mcp-server

# Replay recorded responses to test a client
mcp-tui uvx mcp-debug --playback-server session.jsonl

📚 Documentation

Configuration

# config.yaml
servers:
  - name: "filesystem"
    prefix: "fs"
    transport: "stdio"
    command: "npx"
    args: ["-y", "@modelcontextprotocol/filesystem", "/home/user"]
    timeout: "30s"

proxy:
  healthCheckInterval: "30s"
  connectionTimeout: "10s"
  maxRetries: 3

Environment Variables

MCP_LOG_FILE="/tmp/mcp-debug.log"  # Log location
MCP_DEBUG=1                         # Enable debug logging
MCP_RECORD_FILE="session.jsonl"     # Auto-record sessions
MCP_CONFIG_PATH="./config.yaml"     # Default config

Development Workflow

# 1. Start with an empty config
mcp-tui uvx mcp-debug --proxy --config empty-config.yaml

# 2. Add your server dynamically
server_add: {name: myserver, command: ./my-server-v1}

# 3. Test tools: myserver_read_file, myserver_process, etc.

# 4. Make changes and rebuild
go build -o my-server-v2

# 5. Hot-swap the server
server_disconnect: {name: myserver}
server_reconnect: {name: myserver, command: ./my-server-v2}

# 6. The same tools work immediately with the new implementation!

CLI Commands

uvx mcp-debug --help              # Show help
uvx mcp-debug --version           # Show version
uvx mcp-debug config init         # Create default config
uvx mcp-debug config show         # Show current config
uvx mcp-debug config validate     # Validate config file
uvx mcp-debug env list            # List environment variables
uvx mcp-debug env check           # Check required env vars
uvx mcp-debug tools list          # List tools with details

Project Structure

mcp-debug/
├── main.go              # CLI entry point
├── config/              # Configuration loading
├── client/              # MCP client implementation
├── integration/         # Proxy server and wrapper
├── discovery/           # Tool discovery
├── proxy/               # Request forwarding
├── playback/            # Recording and playback
└── test-servers/        # Example MCP servers

Building

# Development build
go build -o mcp-debug .

# Production build with version info
go build -ldflags "-X main.BuildTime=$(date -u +%Y-%m-%dT%H:%M:%SZ) -X main.GitCommit=$(git rev-parse HEAD)" -o mcp-debug .

# Run tests
go test ./...

📄 License

This project is under the MIT License. See LICENSE for details.

👥 Contributing

See CONTRIBUTING.md for guidelines on how to contribute to this project.