Skip to content

README.md

Latest commit

 

History

History
104 lines (78 loc) · 5.78 KB

README.md

File metadata and controls

104 lines (78 loc) · 5.78 KB
layout default
title MCP Inspector Tutorial
nav_order 160
has_children true
format_version v2

MCP Inspector Tutorial: Debugging and Validating MCP Servers

Learn how to use modelcontextprotocol/inspector to test MCP servers across stdio, SSE, and streamable HTTP, with safer auth defaults and repeatable CLI automation.

GitHub Repo License Latest Release

Why This Track Matters

MCP Inspector is the primary developer surface for validating MCP server behavior before rolling changes into production clients. It combines an interactive web UI with a CLI mode so teams can run both exploratory and automated checks.

This track focuses on:

  • establishing a reliable first-run setup for local and remote MCP servers
  • understanding proxy and transport behavior to avoid false debugging signals
  • using CLI mode in automation loops for regression checks
  • hardening auth, local binding, and origin controls when running the proxy

Current Snapshot (auto-updated)

Mental Model

flowchart LR
    A[Server under test] --> B[MCP Proxy]
    B --> C[Inspector UI]
    B --> D[Inspector CLI]
    C --> E[Interactive debugging]
    D --> F[Scripted validation]
Loading

Chapter Guide

Chapter Key Question Outcome
01 - Getting Started How do I run Inspector quickly and verify connectivity? Working baseline
02 - Architecture, Transports, and Session Model How do proxy, client, and transport layers interact? Clear debugging model
03 - UI Debugging Workflows: Tools, Resources, Prompts How should I use the UI to inspect server behavior end to end? Faster issue isolation
04 - CLI Mode, Automation, and CI Loops How do I automate MCP checks without opening a browser? Repeatable command-line validation
05 - Security, Auth, and Network Hardening How do I reduce local attack surface when using the proxy? Safer local and shared environments
06 - Configuration, Timeouts, and Runtime Tuning Which settings matter most for long-running or interactive tools? Better reliability under load
07 - Inspector in Server Development Lifecycle How does Inspector fit into day-to-day MCP server development? Stable dev workflow
08 - Production Ops, Testing, and Contribution How do teams operate Inspector usage over time and contribute safely? Operational playbook

What You Will Learn

  • how to validate MCP servers consistently across UI and CLI pathways
  • how to handle transport-specific behavior without mixing concerns
  • how to tune timeout/session settings for realistic tool workloads
  • how to apply auth and origin controls to reduce remote execution risk

Source References

Related Tutorials

Start with Chapter 1: Getting Started.

Navigation & Backlinks

Full Chapter Map

  1. Chapter 1: Getting Started
  2. Chapter 2: Architecture, Transports, and Session Model
  3. Chapter 3: UI Debugging Workflows: Tools, Resources, Prompts
  4. Chapter 4: CLI Mode, Automation, and CI Loops
  5. Chapter 5: Security, Auth, and Network Hardening
  6. Chapter 6: Configuration, Timeouts, and Runtime Tuning
  7. Chapter 7: Inspector in Server Development Lifecycle
  8. Chapter 8: Production Ops, Testing, and Contribution

Generated by AI Codebase Knowledge Builder