mcptest documentation

mcptest is an open-source Rust CLI for testing Model Context Protocol (MCP) servers. You write YAML tests, point them at any MCP server, and run them locally or in CI. These docs collect the reference material, guides, and operational notes that did not fit in the repo README. Start there for a one-page overview, then come back here when you need depth.

Getting started

• Quickstart YAML and mcptest run invocation: see the README quickstart.
• Step-by-step first-test walkthrough: getting-started.md

Reference

• YAML format reference: yaml-reference.md
• JSON Schema: schemas/v1.json. Point your editor at the schema with a # yaml-language-server: $schema=... directive at the top of your YAML file for inline validation.
• CLI reference: cli-reference.md
• Concepts: concepts.md
• Cassettes (record/replay): cassettes.md
• Agent and model testing: models.md

Guides

• CI integration: guides/ci-integration.md
• Docker and package runners: docker-and-package-runners.md
• Variables and interpolation: see the variables block and variable interpolation sections of yaml-reference.md
• URL targets and auth: url-targets.md

Operations

• Release process: release-process.md
• Troubleshooting: troubleshooting.md
• CHANGELOG: ../CHANGELOG.md

Research

• Research grounding: research-references.md

For contributors

• Contributor rulebook (AGENTS.md, mirrored by CLAUDE.md): ../AGENTS.md

Roadmap items and bug reports live on GitHub Issues. This index lags the issue tracker by design: changes land first, docs follow.