📖 ProofScan Documentation

Complete guide to using ProofScan - the MCP communication scanner & analyzer

What is ProofScan?

ProofScan is a comprehensive tool for scanning, monitoring, and analyzing Model Context Protocol (MCP) communications. It provides complete visibility into JSON-RPC traffic between AI systems and servers.

💡 Key Features
  • Real-time Monitoring - Watch JSON-RPC events as they happen
  • Complete Transparency - Capture all requests, responses, and notifications
  • Hierarchical Views - Visualize connector → session → RPC relationships
  • Proof Generation - Create auditable proof-of-protocol records
  • A2A Support - Monitor agent-to-agent communications

Getting Started

Follow these steps to start using ProofScan:

1. Installation

Install ProofScan using npm:

npm install -g proofscan

→ Full installation guide

2. Initialize Configuration

Set up your ProofScan configuration:

pfscan config init

3. Add a Connector

Register your first MCP server:

pfscan connectors add --id myserver --stdio "npx @modelcontextprotocol/server-example"

4. Start Scanning

Begin monitoring communications:

pfscan scan start --id myserver

→ Complete quick start guide

Documentation Sections

📚 Commands

Complete reference for all ProofScan commands

View Commands →

💡 Examples

Practical examples and use cases

View Examples →

🏗️ Architecture

Learn how ProofScan works internally

Learn More →

🔌 MCP Protocol

Understanding the Model Context Protocol

Read Guide →

Next Steps