mcp-probe
A Model Context Protocol (MCP) client library and debugging toolkit in Rust. This foundation provides both a production-ready SDK for building MCP integrations and the core architecture for an interactive debugger.
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Badge for your README
Markdown
[](/listings/conikeec--mcp-probe)HTML
<a href="/listings/conikeec--mcp-probe"><img src="/api/listings/conikeec--mcp-probe/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
These steps run a script from the network that findsafeskills does not scan.
MCP Probe offers multiple installation methods for your convenience:
๐ฅ Pre-built Binaries (Recommended)
Download the latest binary for your platform from [GitHub Releases](https://github.com/conikeec/mcp-probe/releases/latest):
- **Linux (x86_64)**: `mcp-probe-x86_64-unknown-linux-gnu.tar.gz` - **Linux (ARM64)**: `mcp-probe-aarch64-unknown-linux-gnu.tar.gz` - **macOS (Intel)**: `mcp-probe-x86_64-apple-darwin.tar.gz` - **macOS (Apple Silicon)**: `mcp-probe-aarch64-apple-darwin.tar.gz` - **Windows (x86_64)**: `mcp-probe-x86_64-pc-windows-msvc.zip`
๐ One-liner Install (Linux/macOS)
curl -fsSL https://raw.githubusercontent.com/conikeec/mcp-probe/master/install.sh | bash
**Custom installation directory:**
curl -fsSL https://raw.githubusercontent.com/conikeec/mcp-probe/master/install.sh | INSTALL_DIR=~/.local/bin bash
**Install specific version:**
curl -fsSL https://raw.githubusercontent.com/conikeec/mcp-probe/master/install.sh | VERSION=v0.1.55 bash
๐บ Homebrew (macOS/Linux)
# Add the tap brew tap conikeec/tap # Install mcp-probe brew install mcp-probe # Or in one command brew install conikeec/tap/mcp-probe
**Update:**
brew upgrade mcp-probe
๐ฆ Cargo Install
cargo install mcp-cli
**Note**: The binary will be named `mcp-probe` even though the crate is `mcp-cli`.
๐จ From Source
# Clone the repository git clone https://github.com/conikeec/mcp-probe.git cd mcp-probe # Build and install cargo build --release cargo install --path . # Or run directly cargo run -- --help
๐ก๏ธ Verification
All binaries are provided with SHA256 checksums. You can verify your download:
# Download checksum file curl -LO https://github.com/conikeec/mcp-probe/releases/latest/download/mcp-probe-x86_64-unknown-linux-gnu.tar.gz.sha256 # Verify (Linux/macOS) sha256sum -c mcp-probe-x86_64-unknown-linux-gnu.tar.gz.sha256 # Verify (macOS alternative) shasum -a 256 -c mcp-probe-x86_64-apple-darwin.tar.gz.sha256
Quick Start
# Test with a local MCP server cargo run -- debug --http-sse http://localhost:3000 # Connect to remote server cargo run -- debug --http-sse https://api.example.com/mcp # Use WebSocket transport cargo run -- debug --websocket ws://localhost:8080/mcp # STDIO mode for local development cargo run -- debug --stdio python my_mcp_server.py
---
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md ยท README ยท 1,197 lines ยท 1 finding marked
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
- [](https://terminaltrove.com/mcp-probe/)
- # ๐ MCP Probe - Advanced MCP Protocol Debugger & Interactive Client
- [](https://www.rust-lang.org)
- [](LICENSE)
- [](Cargo.toml)
- 
- **MCP Probe** is a powerful Terminal User Interface (TUI) for debugging, testing, and interacting with Model Context Protocol (MCP) servers. It provides an intuitive, feature-rich alternative to command-line MCP inspectors with real-time protocol analysis, capability discovery, and interactive tool execution.
- ```
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- โ ๐ MCP PROBE ARCHITECTURE โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
- โ โ
- โ โโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโ โ
- โ โ ๐ฅ๏ธ TUI โ โ ๐ Transport โ โ ๐ง MCP Server โ โ
- โ โ Interface โโโโโบโ Layer โโโโโบโ (Any impl.) โ โ
- โ โ โ โ โ โ โ โ
- โ โ โข Capabilities โ โ โข HTTP/SSE โ โ โข Tools (373+) โ โ
- โ โ โข Search โ โ โข WebSocket โ โ โข Resources โ โ
- โ โ โข Response View โ โ โข STDIO โ โ โข Prompts โ โ
- โ โ โข Debugging โ โ โข TCP โ โ โ โ
- โ โโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโ โ
- โ โ โ โ โ
- โ โผ โผ โผ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
- โ โ ๐ REAL-TIME PROTOCOL ANALYSIS โ
- โ โ โข Message Tracing โข Session Management โข Error Detection โ
- โ โ โข JSON Validation โข Response Formatting โข Performance Metrics โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- โ โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- ```
- ## ๐ Why MCP Probe?
- ### vs. Traditional MCP Inspector Tools
- | Feature | Traditional CLI Tools | MCP Probe TUI |
- | ------------------------ | ---------------------- | ---------------------------------------------- |
- | **Capability Discovery** | Manual JSON parsing | ๐ฏ Interactive browsing with search |
- | **Tool Execution** | Complex curl commands | ๐ฑ๏ธ Point-and-click with parameter forms |
- | **Response Analysis** | Raw JSON dumps | ๐ Multi-format viewer (Tree/Summary/Raw) |
- | **Error Debugging** | Scattered logs | ๐ Centralized error tracking with suggestions |
- | **Session Management** | Stateless commands | ๐พ Persistent sessions with history |
- | **Multi-Transport** | Single transport focus | ๐ HTTP/SSE, WebSocket, STDIO, TCP support |
- | **Real-time Monitoring** | Snapshot-based | โก Live protocol stream analysis |
- ### Key Advantages
- - **๐ฎ Interactive**: Navigate 373+ tools with fuzzy search and auto-completion
- - **๐ Visual**: Color-coded responses, scrollable viewers, progress indicators
- - **๐ Analytical**: Built-in protocol validation, message correlation, timing analysis
- - **๐ ๏ธ Developer-Friendly**: Session export, parameter templates, debugging hints
- - **๐ Fast**: Rust-powered performance with async I/O and efficient TUI rendering
- ---
- ## ๐ฆ Installation
- MCP Probe offers multiple installation methods for your convenience:
- ### ๐ฅ Pre-built Binaries (Recommended)
- Download the latest binary for your platform from [GitHub Releases](https://github.com/conikeec/mcp-probe/releases/latest):
- - **Linux (x86_64)**: `mcp-probe-x86_64-unknown-linux-gnu.tar.gz`
- - **Linux (ARM64)**: `mcp-probe-aarch64-unknown-linux-gnu.tar.gz`
- - **macOS (Intel)**: `mcp-probe-x86_64-apple-darwin.tar.gz`
- - **macOS (Apple Silicon)**: `mcp-probe-aarch64-apple-darwin.tar.gz`
- - **Windows (x86_64)**: `mcp-probe-x86_64-pc-windows-msvc.zip`
- ### ๐ One-liner Install (Linux/macOS)
- ```bash
- curl -fsSL https://raw.githubusercontent.com/conikeec/mcp-probe/master/install.sh | bash
- Note: Pipes a downloaded script directly into a shell (curl | sh / wget | bash)
- Line 81 on GitHub
- ```
- **Custom installation directory:**
- ```bash
- curl -fsSL https://raw.githubusercontent.com/conikeec/mcp-probe/master/install.sh | INSTALL_DIR=~/.local/bin bash
- ```
- **Install specific version:**
- ```bash
- curl -fsSL https://raw.githubusercontent.com/conikeec/mcp-probe/master/install.sh | VERSION=v0.1.55 bash
- ```
- ### ๐บ Homebrew (macOS/Linux)
- ```bash
- # Add the tap
- brew tap conikeec/tap
- # Install mcp-probe
- brew install mcp-probe
- # Or in one command
- brew install conikeec/tap/mcp-probe
- ```
- **Update:**
- ```bash
- brew upgrade mcp-probe
- ```
- ### ๐ฆ Cargo Install
- ```bash
- cargo install mcp-cli
- ```
- **Note**: The binary will be named `mcp-probe` even though the crate is `mcp-cli`.
- ### ๐จ From Source
- ```bash
- # Clone the repository
- git clone https://github.com/conikeec/mcp-probe.git
- cd mcp-probe
- # Build and install
- cargo build --release
- cargo install --path .
- # Or run directly
- cargo run -- --help
- ```
- ### ๐ก๏ธ Verification
- All binaries are provided with SHA256 checksums. You can verify your download:
- ```bash
- # Download checksum file
- curl -LO https://github.com/conikeec/mcp-probe/releases/latest/download/mcp-probe-x86_64-unknown-linux-gnu.tar.gz.sha256
- # Verify (Linux/macOS)
- sha256sum -c mcp-probe-x86_64-unknown-linux-gnu.tar.gz.sha256
- # Verify (macOS alternative)
- shasum -a 256 -c mcp-probe-x86_64-apple-darwin.tar.gz.sha256
- ```
- ### Quick Start
- ```bash
- # Test with a local MCP server
- cargo run -- debug --http-sse http://localhost:3000
- # Connect to remote server
- cargo run -- debug --http-sse https://api.example.com/mcp
- # Use WebSocket transport
- cargo run -- debug --websocket ws://localhost:8080/mcp
- # STDIO mode for local development
- cargo run -- debug --stdio python my_mcp_server.py
- ```
- ---
- ## ๐ฏ Section 1: MCP Client Usage
- MCP Probe serves as a comprehensive MCP client for developers and integrators who need to interact with MCP servers programmatically or interactively.
- ### ๐ง Client Configuration
- ```bash
- # Basic connection with default settings
- mcp-probe debug --http-sse http://localhost:3000
- # Advanced configuration
- mcp-probe debug \
- --http-sse http://localhost:3000 \
- --timeout 30 \
- --max-retries 3 \
- --session-file my_session.json
- ```
- ### ๐ก Interactive Workflow
- ```
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- โ ๐ฎ INTERACTIVE CLIENT WORKFLOW โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
- โ โ
- โ 1๏ธโฃ DISCOVERY PHASE โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ โโ Connection โโ โโ Capabilities โโ โโ Search & Filter โโ โ โ
- โ โ โโข Auto-detect โ โโข Tools: 373 โ โโข Fuzzy matching โ โ โ
- โ โ โโข Protocol โ โโข Resources: 1 โ โโข Category filter โ โ โ
- โ โ โโข Session ID โ โโข Prompts: 3 โ โโข Real-time index โ โ โ
- โ โ โโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโ โ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โผ โ
- โ 2๏ธโฃ INTERACTION PHASE โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ โโ Parameter Input โโ โโ Execution โโ โโ Response Analysis โโ โ โ
- โ โ โโข Smart forms โ โโข Real-time โ โโข Multi-format view โ โ โ
- โ โ โโข Type validation โ โโข Progress โ โโข Error highlighting โ โ โ
- โ โ โโข Auto-completion โ โโข Correlation โ โโข Export options โ โ โ
- โ โ โโโโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโ โ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โผ โ
- โ 3๏ธโฃ ANALYSIS PHASE โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ โโ Session Review โโ โโ Error Analysis โโ โโ Export & Share โโ โ โ
- โ โ โโข Message history โ โโข Root cause hints โ โโข JSON export โ โ โ
- โ โ โโข Timing metrics โ โโข Fix suggestions โ โโข Session replay โ โ โ
- โ โ โโข Protocol trace โ โโข Debug logs โ โโข Report sharing โ โ โ
- โ โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโ โ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- ```
- ### ๐ Smart Capability Discovery
- **Fuzzy Search Engine**: Find tools instantly among hundreds of capabilities
- ```bash
- # Search examples (press '/' to activate)
- /github # Find GitHub-related tools
- /repo list # Find repository listing functions
- /add_numbers # Direct tool name match
- ```
- **Auto-Parameter Detection**: Intelligent form generation from JSON schemas
- ```bash
- # Example: GitHub repo listing tool
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- โ ๐ org (REQUIRED) [string] โ
- โ ๐ก The organization name... โ
- โ > myorganization โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
- โ ๐ per_page (optional) [integer] โ
- โ ๐ก Results per page (max 100) โ
- โ > 50 โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- ```
- ### ๐ Execution Patterns
- **Direct Command Mode**:
- ```bash
- # Syntax: category.name {"param": "value"}
- tools.add_numbers {"a": 10, "b": 20}
- resources.readme_content
- prompts.generate_docs {"style": "technical"}
- ```
- **Interactive Mode**: Use TUI navigation for guided execution
- **Batch Mode**: Execute multiple operations with session scripts
- ---
- ## ๐ Section 2: Advanced Protocol Discovery & Session Management
- MCP Probe features a sophisticated protocol discovery system that automatically detects and adapts to different MCP protocol versions, providing seamless connectivity across the evolving MCP ecosystem.
- ### ๐ Intelligent Protocol Discovery
- **Automatic Protocol Detection**: MCP Probe automatically detects the protocol version based on endpoint patterns and server behavior, eliminating manual configuration.
- ```bash
- # MCP Probe automatically detects the protocol version from these patterns:
- mcp-probe debug --http-sse http://localhost:8931/mcp # Modern Streamable HTTP
- mcp-probe debug --http-sse http://localhost:8931/sse # Legacy HTTP+SSE
- mcp-probe debug --stdio python server.py # Standard Transport
- ```
- ### ๐ Protocol Version Matrix
- | Protocol Version | Spec Date | Endpoints | Session Management | Transport Method | Status |
- |------------------|-----------|-----------|-------------------|------------------|---------|
- | **Modern Streamable HTTP** | 2025-03-26 | `/mcp` | `Mcp-Session-Id` header | HTTP/SSE Streaming | โ Current |
- | **Legacy HTTP+SSE** | 2024-11-05 | `/sse`, `/events` | `sessionId` query param | HTTP + Server-Sent Events | โ Supported |
- | **Standard Transport** | 2025-03-26 | `stdio` | N/A (process-based) | Process I/O | โ Supported |
- | **WebSocket** | 2025-03-26 | `/ws`, `/websocket` | Connection-based | WebSocket frames | ๐ Planned |
- | **TCP** | 2025-03-26 | Raw socket | Connection-based | TCP stream | ๐ Planned |
- ### ๐ง Session Negotiation Workflows
- #### Modern Streamable HTTP (Recommended)
- ```
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- โ ๐ MODERN STREAMABLE HTTP WORKFLOW โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
- โ โ
- โ Client MCP Probe Server โ
- โ โ โ โ โ
- โ โ โ โ โ
- โ โโโโโ 1. Connection โโโโโโโบโโโโโโโ POST /mcp โโโโโโโโโโโบโ โ
- โ โ โ Mcp-Session-Id: [auto] โ โ
- โ โ โ โ โ
- โ โโโโโ Session Created โโโโโโโโโโโโ 200 + Session โโโโโโโโ โ
- โ โ โ Mcp-Session-Id: abc123 โ โ
- โ โ โ โ โ
- โ โโโโโ 2. Initialize โโโโโโโบโโโโโโโ POST /mcp โโโโโโโโโโโบโ โ
- โ โ โ Mcp-Session-Id: abc123 โ โ
- โ โ โ {"method": "initialize"} โ โ
- โ โ โ โ โ
- โ โโโโโ Capabilities โโโโโโโโโโโโโโโ 200 OK โโโโโโโโโโโโโโโ โ
- โ โ โ Server capabilities โ โ
- โ โ โ โ โ
- โ โโโโโ 3. Ready State โโโโโโบโโโโโโโโโ Persistent โโโโโโโโโบโ โ
- โ โ โ Session Active โ โ
- โ โ
- โ โ Single endpoint simplicity ๐ Header-based security โ
- โ โ Built-in session management โก Automatic resumability โ
- โ โ Firewall-friendly ๐ Full streaming support โ
- โ โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- ```
- #### Legacy HTTP+SSE (Backward Compatibility)
- ```
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- โ ๐ก LEGACY HTTP+SSE WORKFLOW โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
- โ โ
- โ Client MCP Probe Server โ
- โ โ โ โ โ
- โ โ โ โ โ
- โ โโโโโ 1. Discover โโโโโโโโโบโโโโโโโ GET /events โโโโโโโโโบโ โ
- โ โ โ Accept: text/event-stream โ โ
- โ โ โ โ โ
- โ โโโโโ Session Info โโโโโโโโโโโโโโโ SSE Stream โโโโโโโโโโโ โ
- โ โ โ data: {"sessionId": "xyz"}โ โ
- โ โ โ โ โ
- โ โโโโโ 2. Initialize โโโโโโโบโโโโ POST /sse?sessionId=xyzโโบโ โ
- โ โ โ {"method": "initialize"} โ โ
- โ โ โ โ โ
- โ โโโโโ Capabilities โโโโโโโโโโโโโโโ 200 OK โโโโโโโโโโโโโโโ โ
- โ โ โ Server capabilities โ โ
- โ โ โ โ โ
- โ โโโโโ 3. SSE Listen โโโโโโโบโโโโ GET /sse?sessionId=xyzโโโบโ โ
- โ โ โ Accept: text/event-stream โ โ
- โ โ โ โ โ
- โ โโโโโ Event Stream โโโโโโโโโโโโโโ SSE Messages โโโโโโโโโโ โ
- โ โ โ Continuous updates โ โ
- โ โ
- โ ๐ Dual-endpoint architecture ๐ก Query-based sessions โ
- โ ๐ Separate discovery phase โก Event-driven updates โ
- โ ๐ Legacy compatibility ๐ SSE streaming support โ
- โ โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- ```
- #### Standard Transport (Development)
- ```
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- โ ๐ง STANDARD TRANSPORT WORKFLOW โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
- โ โ
- โ Client MCP Probe Process โ
- โ โ โ โ โ
- โ โ โ โ โ
- โ โโโโโ 1. Spawn Process โโโโบโโโโโโโ exec/spawn โโโโโโโโโโบโ โ
- โ โ โ python server.py โ โ
- โ โ โ โ โ
- โ โโโโโ Process Ready โโโโโโโโโโโโโโ stdin/stdout โโโโโโโโโ โ
- โ โ โ Process initialization โ โ
- โ โ โ โ โ
- โ โโโโโ 2. Initialize โโโโโโโบโโโโโโโ JSON-RPC โโโโโโโโโโโโบโ โ
- โ โ โ via stdin โ โ
- โ โ โ โ โ
- โ โโโโโ Capabilities โโโโโโโโโโโโโโโ JSON-RPC โโโโโโโโโโโโโ โ
- โ โ โ via stdout โ โ
- โ โ โ โ โ
- โ โโโโโ 3. Bidirectional โโโโบโโโโโ stdin/stdout pipes โโโโโบโ โ
- โ โ โ Full-duplex communication โ โ
- โ โ
- โ ๐ Direct process control ๐ง Perfect for development โ
- โ ๐ No network complexity โก Immediate debugging โ
- โ ๐ Local filesystem access ๐ Full protocol support โ
- โ โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- ```
- ### ๐ฏ Interactive vs Non-Interactive Command Sequences
- #### Interactive Mode (TUI) - Guided Discovery
- ```
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- โ ๐ฅ๏ธ INTERACTIVE TUI WORKFLOW โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
- โ โ
- โ Phase 1: CONNECTION & DISCOVERY โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ ๐ Auto-detect Protocol โ ๐ก Establish Session โ ๐ Discover Tools โ โ
- โ โ โข Parse endpoint URL โข Header/query sessions โข Fuzzy search โ โ
- โ โ โข Detect /mcp vs /sse โข Auto-resume capability โข Category filter โ โ
- โ โ โข Security validation โข Background monitoring โข Real-time index โ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โผ โ
- โ Phase 2: INTERACTIVE EXECUTION โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ ๐ Parameter Forms โ โก Real-time Execution โ ๐ Response Analysisโ โ
- โ โ โข Smart type detection โข Progress indicators โข Multi-format view โ โ
- โ โ โข Schema-driven hints โข Error correlation โข Error highlighting โ โ
- โ โ โข Auto-completion โข Session persistence โข Export options โ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โผ โ
- โ Phase 3: ANALYSIS & DEBUGGING โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ ๐ Session Review โ ๐ง Error Investigation โ ๐ค Export & Share โ โ
- โ โ โข Message history โข Root cause analysis โข JSON export โ โ
- โ โ โข Timing metrics โข Fix suggestions โข Session replay โ โ
- โ โ โข Protocol trace โข Debug logs โข Report generation โ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ
- โ ๐ฎ User Experience: Visual, guided, exploratory โ
- โ โจ๏ธ Hotkeys: Tab navigation, / search, Enter execute โ
- โ ๐ Features: Fuzzy search, parameter forms, real-time feedback โ
- โ โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- ```
- **Interactive Mode Commands:**
- ```bash
- # Launch TUI with automatic protocol detection
- mcp-probe debug --http-sse http://localhost:8931/mcp
- # TUI Navigation Flow:
- # 1. Tab โ Navigate between panels
- # 2. / โ Activate fuzzy search
- # 3. โโ โ Browse capabilities
- # 4. Enter โ Open parameter form
- # 5. Tab โ Execute with parameters
- # 6. V โ Cycle response views
- # 7. F2 โ Save session
- # Smart Parameter Forms:
- # โข Auto-detects field types from JSON Schema
- # โข Provides contextual hints and validation
- # โข Supports environment variable injection
- # โข Real-time syntax validation
- ```
- #### Non-Interactive Mode (CLI) - Automation-Friendly
- ```
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- โ โก NON-INTERACTIVE CLI WORKFLOW โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
- โ โ
- โ Phase 1: RAPID CONNECTION โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ ๐ Direct Connect โ ๐ Quick Capability Dump โ โ
- โ โ โข Protocol auto-detection โข Structured output โ โ
- โ โ โข No user interaction โข Machine-readable format โ โ
- โ โ โข CI/CD friendly โข Error codes for automation โ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โผ โ
- โ Phase 2: BATCH EXECUTION โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ ๐ Command Scripts โ โ๏ธ Automated Testing โ ๐ Report Output โ โ
- โ โ โข Direct tool execution โข Comprehensive test suite โข JSON/CSV export โ โ
- โ โ โข Parameter validation โข Protocol compliance โข CI integration โ โ
- โ โ โข Bulk operations โข Performance monitoring โข Success/fail codesโ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โผ โ
- โ Phase 3: PRODUCTION VALIDATION โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ ๐ Health Checks โ ๐ Performance Analysis โ ๐จ Alert Integrationโ โ
- โ โ โข Endpoint discovery โข Response time metrics โข Monitoring systems โ โ
- โ โ โข Protocol compliance โข Memory usage tracking โข Automated alerts โ โ
- โ โ โข Schema validation โข Error rate analysis โข Report webhooks โ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ
- โ ๐ค Use Cases: CI/CD pipelines, monitoring, automation โ
- โ โก Features: Zero interaction, structured output, exit codes โ
- โ ๐ง Integration: Scripts, Docker, Kubernetes health checks โ
- โ โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- ```
- **Non-Interactive Mode Commands:**
- ```bash
- # Quick capability overview
- mcp-probe debug --http-sse http://localhost:8931/mcp --non-interactive
- # Automated testing with reports
- mcp-probe test --http-sse http://localhost:8931/mcp --report --output-dir ./reports
- # Endpoint discovery for load balancers
- mcp-probe test --discover http://api.company.com --report
- # CI/CD integration examples
- mcp-probe test --http-sse $MCP_SERVER_URL --fail-fast --timeout 30
- if [ $? -eq 0 ]; then echo "โ MCP server healthy"; else echo "โ MCP server failed"; fi
- # Batch operations for monitoring
- mcp-probe validate --http-sse http://prod-server/mcp --suite compliance
- ```
- ### ๐ Advanced Endpoint Discovery
- **Multi-Endpoint Discovery**: MCP Probe can discover and test multiple MCP endpoints from a base URL, perfect for load balancers and multi-service deployments.
- ```bash
- # Discover all MCP endpoints under a domain
- mcp-probe test --discover https://api.company.com
- # Discovery automatically tests these patterns:
- # โข https://api.company.com/mcp (Modern)
- # โข https://api.company.com/sse (Legacy)
- # โข https://api.company.com/events (Discovery)
- # โข https://api.company.com/v1/mcp (Versioned)
- # โข https://api.company.com/api/mcp (Nested)
- # Output shows availability and capabilities:
- โ Modern Streamable HTTP - 47 tools, 3 resources, 2 prompts
- โ Legacy HTTP+SSE - 47 tools, 3 resources, 2 prompts
- โ Versioned API - Connection failed
- โ ๏ธ Nested API - Invalid response format
- ```
- ### ๐ก๏ธ Security & Session Management
- #### Automatic Security Validation
- ```
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- โ ๐ SECURITY VALIDATION โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
- โ โ
- โ ๐ก๏ธ Connection Security โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ โข HTTPS enforcement for production URLs โ โ
- โ โ โข Origin validation to prevent DNS rebinding โ โ
- โ โ โข Session ID format validation (cryptographic strength) โ โ
- โ โ โข Certificate verification for remote servers โ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ
- โ ๐ Session Management โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ โข Automatic session discovery and renewal โ โ
- โ โ โข Secure session ID generation and tracking โ โ
- โ โ โข Background session monitoring for ephemeral servers โ โ
- โ โ โข Session resumption after network interruptions โ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ
- โ โก Performance & Reliability โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ โข Connection pooling and keep-alive โ โ
- โ โ โข Automatic retry with exponential backoff โ โ
- โ โ โข Request timeout and circuit breaker patterns โ โ
- โ โ โข Memory-efficient streaming for large responses โ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- ```
- ### ๐ Protocol Compliance Testing
- **Comprehensive Test Suites**: MCP Probe includes extensive test suites for validating protocol compliance across different versions.
- ```bash
- # Full protocol compliance testing
- mcp-probe validate --http-sse http://localhost:8931/mcp --suite all
- # Specific compliance areas:
- mcp-probe validate --suite initialization # Connection & handshake
- mcp-probe validate --suite capabilities # Tool/resource discovery
- mcp-probe validate --suite schema # JSON Schema validation
- mcp-probe validate --suite security # Security best practices
- mcp-probe validate --suite performance # Response time & throughput
- # Generate detailed compliance reports
- mcp-probe validate --suite all --report --output-dir ./compliance-reports
- ```
- ---
- ## ๐ง Section 3: MCP Deployment Troubleshooting
- MCP Probe excels as a diagnostic tool for MCP deployments, providing deep insights into protocol behavior, performance bottlenecks, and integration issues.
- ### ๐จ Diagnostic Features
- ```
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- โ ๐ TROUBLESHOOTING DASHBOARD โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
- โ โ
- โ ๐ด CONNECTION DIAGNOSTICS ๐ก PROTOCOL ANALYSIS โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ โข Transport validation โ โ โข Message correlation โ โ
- โ โ โข Authentication checks โ โ โข Response time analysis โ โ
- โ โ โข Firewall/proxy detection โ โ โข Error pattern recognition โ โ
- โ โ โข SSL/TLS verification โ โ โข Capability compatibility โ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ
- โ ๐ข PERFORMANCE MONITORING ๐ฃ ERROR INVESTIGATION โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ โข Request/response latency โ โ โข Stack trace analysis โ โ
- โ โ โข Throughput measurement โ โ โข JSON schema validation โ โ
- โ โ โข Memory usage tracking โ โ โข Serialization debugging โ โ
- โ โ โข Connection stability โ โ โข Integration compatibility โ โ
- โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
- โ โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- ```
- ### ๐ ๏ธ Common Issues & Solutions
- #### Issue 1: Connection Failures
- **Symptoms**: "Transport connection failed", "Connection refused"
- **Diagnosis with MCP Probe**:
- ```bash
- # 1. Test basic connectivity
- mcp-probe debug --http-sse http://localhost:3000
- # 2. Check different transports
- mcp-probe debug --websocket ws://localhost:8080/mcp
- mcp-probe debug --stdio python server.py
- # 3. Monitor protocol flow
- # Look for: Connection status, SSL handshake, authentication
- ```
- **Troubleshooting Guide**:
- - โ Server is running and listening on correct port
- - โ Firewall rules allow connections
- - โ SSL certificates are valid (for HTTPS)
- - โ Authentication credentials are correct
- #### Issue 2: Tool Execution Failures
- **Symptoms**: "Serialization error", "Invalid parameters", "Tool not found"
- **Diagnosis with MCP Probe**:
- ```bash
- # 1. Verify tool discovery
- # Navigate to Tools section, check tool list
- # 2. Inspect parameter schemas
- # Select tool -> Parameter form should show required fields
- # 3. Check raw response data
- # Use 'V' key to cycle through response formats
- ```
- **Common Root Causes**:
- - ๐ง **Parameter Mismatch**: Use Parameter Form to validate inputs
- - ๐ง **Tool Name Prefix Issues**: Check clean vs. full tool names
- - ๐ง **JSON Format Errors**: Validate JSON in response viewer
- - ๐ง **Server-Side Errors**: Review error messages in message history
- #### Issue 3: Performance Problems
- **Symptoms**: Slow responses, timeouts, memory issues
- **Diagnosis with MCP Probe**:
- ```bash
- # 1. Monitor timing metrics
- # Check message history for response times
- # 2. Analyze message sizes
- # Use Raw JSON view to inspect payload sizes
- # 3. Track connection stability
- # Watch for reconnection attempts in logs
- ```
- ### ๐ Protocol Debugging
- **Message Flow Analysis**:
- ```
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- โ ๐ PROTOCOL MESSAGE FLOW โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
- โ โ
- โ Client MCP Probe Server โ
- โ โ โ โ โ
- โ โโโโโ initialize โโโโโโโโโบโโโโโโโ HTTP/POST โโโโโโโโโโโบโ โ
- โ โ โ โ โ
- โ โโโโโ init_response โโโโโโโโโโโโโ 200 OK โโโโโโโโโโโโโโโ โ
- โ โ โ โ โ
- โ โโโโโ tools/list โโโโโโโโโบโโโโโโโ HTTP/POST โโโโโโโโโโโบโ โ
- โ โ โ โ โ
- โ โโโโโ tools_response โโโโโโโโโโโโ 200 OK โโโโโโโโโโโโโโโ โ
- โ โ โ โ โ
- โ โโโโโ tools/call โโโโโโโโโบโโโโโโโ HTTP/POST โโโโโโโโโโโบโ โ
- โ โ โ (params) โ โ
- โ โ โ โ โ
- โ โโโโโ result/error โโโโโโโโโโโโโโ 200/400/500 โโโโโโโโโโ โ
- โ โ โ โ โ
- โ โ
- โ ๐ MCP Probe captures and analyzes each step: โ
- โ โข Request correlation (session ID tracking) โ
- โ โข Response time measurement โ
- โ โข Error classification and suggestions โ
- โ โข JSON schema validation โ
- โ โ
- โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
- ```
- ### ๐ฏ Environment Validation
- **Development Environment Checklist**:
- ```bash
- # 1. Server Implementation Validation
- โ Server responds to initialize request
- โ Capabilities are properly declared
- โ Tool schemas are valid JSON Schema
- โ Error responses include helpful messages
- # 2. Integration Testing
- โ Authentication flow works correctly
- โ Session management is stable
- โ All transport types are supported
- โ Error handling is graceful
- # 3. Performance Validation
- โ Response times are within SLA
- โ Memory usage is reasonable
- โ Concurrent requests are handled
- โ Rate limiting is implemented correctly
- ```
- ---
- ## ๐ Command Cheat Sheet
- ### ๐ง Basic Commands
- ```bash
- # Connection
- mcp-probe debug --http-sse <url> # HTTP Server-Sent Events
- mcp-probe debug --websocket <url> # WebSocket connection
- mcp-probe debug --stdio <command> # STDIO transport
- mcp-probe debug --tcp <host:port> # Raw TCP connection
- # Configuration
- mcp-probe debug <transport> --timeout 30 # Request timeout
- mcp-probe debug <transport> --max-retries 3 # Retry attempts
- mcp-probe debug <transport> --session-file <f> # Session persistence
- ```
- ### โจ๏ธ TUI Navigation Hotkeys
- #### Global Navigation
- | Key | Action | Description |
- | ----- | ------------- | ------------------------- |
- | `Tab` | Cycle Focus | Move between panels |
- | `F1` | Help | Show/hide help dialog |
- | `F2` | Save Session | Export current session |
- | `F3` | Toggle JSON | Switch JSON view mode |
- | `F4` | Clear History | Reset message history |
- | `F5` | Environment | Set environment variables |
- | `Q` | Quit | Exit application |
- #### Capability Browser
- | Key | Action | Description |
- | ------- | -------- | ----------------------------- |
- | `Enter` | Select | Open capability details |
- | `โ/โ` | Navigate | Move through categories/items |
- | `โ/โ` | Page | Previous/next page |
- | `/` | Search | Activate fuzzy search |
- | `Esc` | Back | Return to categories |
- #### Search Interface
- | Key | Action | Description |
- | ------- | -------- | --------------------- |
- | `/` | Activate | Open search dialog |
- | `Type` | Query | Enter search terms |
- | `โ/โ` | Navigate | Browse search results |
- | `Enter` | Select | Choose result |
- | `Esc` | Cancel | Close search |
- #### Parameter Forms
- | Key | Action | Description |
- | ------- | -------- | ------------------------------- |
- | `โ/โ` | Navigate | Move between fields (auto-edit) |
- | `Type` | Edit | Enter parameter values |
- | `Enter` | Save | Save field and move to next |
- | `Tab` | Execute | Run with current parameters |
- | `Esc` | Cancel | Close parameter form |
- #### Response Viewer
- | Key | Action | Description |
- | ----------- | ----------- | ------------------------------------------ |
- | `R` | Open | View selected response |
- | `V` | View Mode | Cycle formats (Formatted/Raw/Tree/Summary) |
- | `โ/โ` | Scroll V | Vertical scrolling |
- | `โ/โ` | Scroll H | Horizontal scrolling |
- | `PgUp/PgDn` | Fast Scroll | Page up/down |
- | `Home/End` | Jump | Go to top/bottom |
- | `Esc` | Close | Exit response viewer |
- ### ๐ฎ Interactive Commands
- #### Direct Tool Execution
- ```bash
- # Syntax: category.name {json_params}
- tools.add_numbers {"a": 10, "b": 20}
- tools.github_list_repos {"org": "microsoft", "per_page": 10}
- resources.readme_content
- prompts.code_review {"language": "rust", "style": "detailed"}
- ```
- #### Environment Variables
- ```bash
- # Set variables for tool injection
- KEY=value,API_TOKEN=secret123,ORG=myorg
- # Variables automatically injected into tool calls
- tools.api_call {} # Will include ORG=myorg if tool expects it
- ```
- ---
- ## ๐ File System Organization
- MCP Probe automatically organizes all generated files in a clean, structured directory hierarchy in your home directory.
- ### ๐ Directory Structure
- ```
- ~/.mcp-probe/
- โโโ logs/ # All log files with timestamps
- โ โโโ mcp-probe-debug.log # TUI mode debug log
- โ โโโ mcp-probe-YYYYMMDD_HHMMSS.log # CLI mode logs
- โโโ reports/ # All generated reports with date prefixes
- โ โโโ YYYYMMDD-test-report-HHMMSS.json
- โ โโโ YYYYMMDD-validation-report-HHMMSS.json
- โ โโโ YYYYMMDD-discovery-report-HHMMSS.json
- โโโ sessions/ # Saved session files
- โ โโโ debug-session-YYYYMMDD_HHMMSS.json
- โโโ config/ # Configuration files
- โโโ mcp-probe.toml
- ```
- ### ๐๏ธ Path Management Commands
- ```bash
- # Show directory structure and usage
- mcp-probe paths show
- # Clean up old files (dry run)
- mcp-probe paths cleanup --days 30
- # Actually clean up files older than 7 days
- mcp-probe paths cleanup --days 7 --force
- # Open MCP Probe directory in file manager
- mcp-probe paths open
- ```
- ### ๐ Automatic Date Prefixing
- All reports are automatically prefixed with dates for easy organization:
- - **Format**: `YYYYMMDD-report-name-HHMMSS.extension`
- - **Example**: `20250622-test-report-143052.json`
- - **Benefits**: Chronological sorting, easy cleanup, no file conflicts
- ### ๐งน Automated Cleanup
- MCP Probe includes intelligent cleanup features:
- ```bash
- # Show what would be cleaned up
- mcp-probe paths cleanup --days 30
- # Clean files older than 30 days
- mcp-probe paths cleanup --days 30 --force
- # The paths show command gives cleanup recommendations
- mcp-probe paths show
- ```
- ---
- ## ๐ Advanced Features
- ### ๐ Response Analysis Modes
- #### 1. **Formatted View** (Default)
- - โจ Syntax highlighting for JSON
- - ๐ Structured analysis with field breakdown
- - ๐ Error highlighting and suggestions
- - ๐ Content statistics and metadata
- #### 2. **Raw JSON View**
- - ๐ Pretty-printed JSON output
- - ๐ Full response data visibility
- - ๐ Copy-friendly format
- - ๐ ๏ธ Debug-oriented display
- #### 3. **Tree View**
- - ๐ณ Hierarchical data visualization
- - ๐ Collapsible object/array nodes
- - ๐ Type indicators for each field
- - ๐ฏ Easy navigation of nested structures
- #### 4. **Summary View**
- - ๐ High-level response overview
- - ๐ Key metrics and statistics
- - โก Quick status assessment
- - ๐ฏ Action-oriented insights
- ### ๐ Session Management
- ```bash
- # Auto-save sessions
- mcp-probe debug --http-sse http://localhost:3000 --session-file debug.json
- # Session contains:
- # โข Connection parameters
- # โข Message history with timing
- # โข Error logs and diagnostics
- # โข Environment variables
- # โข Response cache for offline analysis
- ```
- ### ๐ Multi-Transport Support
- #### HTTP Server-Sent Events (Recommended)
- ```bash
- mcp-probe debug --http-sse http://localhost:3000
- # โ Most compatible with web servers
- # โ Firewall-friendly
- # โ Built-in error handling
- ```
- #### WebSocket
- ```bash
- mcp-probe debug --websocket ws://localhost:8080/mcp
- # โ Real-time bidirectional communication
- # โ Lower latency
- # โ ๏ธ May require proxy configuration
- ```
- #### STDIO (Development)
- ```bash
- mcp-probe debug --stdio python my_server.py
- # โ Perfect for local testing
- # โ Direct process communication
- # โ ๏ธ Limited to local development
- ```
- #### TCP (Advanced)
- ```bash
- mcp-probe debug --tcp localhost:9000
- # โ Low-level protocol access
- # โ Custom transport implementations
- # โ ๏ธ Requires manual protocol handling
- ```
- ---
- ## ๐ ๏ธ Development & Contributing
- ### Project Structure
- ```
- mcp-probe/
- โโโ crates/
- โ โโโ mcp-core/ # Core MCP protocol implementation
- โ โ โโโ src/
- โ โ โ โโโ client.rs # High-level MCP client
- โ โ โ โโโ transport/ # Transport layer abstractions
- โ โ โ โโโ messages/ # Protocol message definitions
- โ โ โโโ Cargo.toml
- โ โโโ mcp-cli/ # TUI application
- โ โโโ src/
- โ โ โโโ tui.rs # Terminal UI implementation
- โ โ โโโ search.rs # Capability search engine
- โ โ โโโ main.rs # CLI entry point
- โ โโโ Cargo.toml
- โโโ target/ # Build artifacts
- โโโ Cargo.toml # Workspace configuration
- โโโ README.md
- ```
- ### Building from Source
- ```bash
- # Debug build
- cargo build
- # Release build (recommended for performance)
- cargo build --release
- # Run tests
- cargo test
- # Run with logging
- RUST_LOG=debug cargo run -- debug --http-sse http://localhost:3000
- ```
- ### Contributing Guidelines
- 1. ๐ด Fork the repository
- 2. ๐ฟ Create a feature branch
- 3. โ Add tests for new functionality
- 4. ๐ Update documentation
- 5. ๐ Submit a pull request
- ---
- ## ๐ License
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
- ---
- ## ๐ค Support & Community
- - **๐ Documentation**: [docs.example.com/mcp-probe](docs.example.com/mcp-probe)
- - **๐ Issues**: [GitHub Issues](https://github.com/your-org/mcp-probe/issues)
- - **๐ฌ Discussions**: [GitHub Discussions](https://github.com/your-org/mcp-probe/discussions)
- - **๐ง Contributing**: See [CONTRIBUTING.md](CONTRIBUTING.md)
- ---
- ## ๐ Quick Examples
- ### Example 1: Debug API Integration
- ```bash
- # Connect to your MCP server
- mcp-probe debug --http-sse https://api.yourservice.com/mcp
- # 1. Verify connection and capabilities
- # 2. Search for relevant tools: /api or /user
- # 3. Test tool execution with real parameters
- # 4. Analyze responses for integration issues
- # 5. Export session for team sharing
- ```
- ### Example 2: Performance Testing
- ```bash
- # Set up performance monitoring
- mcp-probe debug --http-sse http://localhost:3000 --session-file perf_test.json
- # 1. Execute high-frequency tool calls
- # 2. Monitor response times in message history
- # 3. Check for memory leaks or connection issues
- # 4. Review session file for timing analysis
- ```
- ### Example 3: Development Workflow
- ```bash
- # Local development testing
- mcp-probe debug --stdio python my_mcp_server.py
- # 1. Rapid iteration on server code
- # 2. Test tool schemas and validation
- # 3. Debug parameter handling
- # 4. Verify error response formats
- ```
- ---
- ## ๐ง Development Automation & CI/CD
- ### ๐ Automated Quality Checks
- MCP Probe includes comprehensive automation for code quality and CI/CD:
- #### Development Scripts
- ```bash
- # Run all checks (formatting, clippy, tests)
- ./scripts/check.sh
- # Auto-fix formatting and clippy issues
- ./scripts/fix.sh
- # Publish to crates.io (with all checks)
- ./scripts/release.sh
- ```
- #### Continuous Integration
- Our GitHub Actions CI pipeline automatically runs:
- - โ **Code Formatting**: `rustfmt` ensures consistent code style
- - โ **Linting**: `clippy` with warnings as errors for code quality
- - โ **Testing**: Full test suite across Linux, macOS, and Windows
- - โ **Security Audit**: `cargo audit` for vulnerability scanning
- - โ **Code Coverage**: Coverage reporting with codecov.io
- - โ **Documentation**: Automatic docs.rs generation
- #### Publishing Workflow
- Releases to crates.io are fully automated:
- 1. **Trigger**: Create a GitHub release
- 2. **Checks**: All CI checks must pass
- 3. **Publish**:
- - `mcp-core` published first (dependency)
- - `mcp-cli` published second
- 4. **Tagging**: Git tag created automatically
- #### Local Development Setup
- ```bash
- # Install development tools
- cargo install cargo-audit cargo-tarpaulin
- # Set up git hooks (optional)
- cargo install cargo-husky
- ```
- #### Code Quality Standards
- - **Formatting**: Enforced via `rustfmt.toml` configuration
- - **Linting**: Zero tolerance for clippy warnings
- - **Testing**: Comprehensive test coverage required
- - **Documentation**: All public APIs must be documented
- ### ๐ฆ Crate Publishing
- Both crates are available on crates.io:
- - **[mcp-core](https://crates.io/crates/mcp-core)**: Core MCP protocol implementation
- - **[mcp-cli](https://crates.io/crates/mcp-cli)**: Interactive TUI debugger
- #### Installation
- ```bash
- # Install the CLI tool
- cargo install mcp-cli
- # Add core library to your project
- [dependencies]
- mcp-core = "0.1.0"
- ```
- ---
- ## ๐ Credits & Acknowledgments
- **Made with โค๏ธ in Rust**
- This project wouldn't be possible without:
- - ๐ฆ **[Rust Programming Language](https://rust-lang.org/)** - For memory safety, performance, and the amazing ecosystem that makes systems programming a joy
- - ๐ค **[Anthropic](https://anthropic.com/)** - For creating the Model Context Protocol (MCP) specification and advancing the field of AI collaboration tools
- - ๐ **The Rust Community** - For the incredible crates that power MCP Probe: Ratatui, Tokio, Serde, Clap, and countless others
- - ๐ ๏ธ **Open Source Contributors** - Every bug report, feature suggestion, and pull request makes this tool better
- Special thanks to the Ratatui team for creating the foundation that makes our beautiful TUI possible! ๐จ
- ---
- **๐ฏ MCP Probe: Making MCP protocol debugging as intuitive as it should be.**
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If itโs helped, pass it on.