modelcontextprotocol/conformance
Watch
1
0
Fork
You've already forked conformance
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Mirror of https://github.com/modelcontextprotocol/conformance — Conformance Tests for MCP
11 commits 1 branch 19 tags 2 MiB
  • TypeScript 98.1%
  • JavaScript 1.9%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Paul Carleton 3d7343abd8
 Merge pull request #1 from modelcontextprotocol/pcarleton-runner1 
Adjust test and allow running in interactive mode
2025-10-31 17:54:48 +00:00
.github/workflows add linting 2025-10-30 13:08:11 +00:00
examples/clients/typescript apply linting 2025-10-30 13:09:16 +00:00
src Adjust test and allow running in interactive mode 2025-10-31 17:53:52 +00:00
.gitignore wip first crack at scenario and runner 2025-10-29 14:38:11 +00:00
.prettierrc.json add linting 2025-10-30 13:08:11 +00:00
eslint.config.mjs add linting 2025-10-30 13:08:11 +00:00
jest.config.js apply linting 2025-10-30 13:09:16 +00:00
package-lock.json add linting 2025-10-30 13:08:11 +00:00
package.json add linting 2025-10-30 13:08:11 +00:00
README.md apply linting 2025-10-30 13:09:16 +00:00
tsconfig.json add linting 2025-10-30 13:08:11 +00:00

README.md

MCP Conformance Test Framework

A framework for testing MCP (Model Context Protocol) client implementations against the specification.

Quick Start

npm install
npm run start -- --command "tsx examples/clients/typescript/test1.ts" --scenario initialize

Overview

The conformance test framework validates MCP client implementations by:

  1. Starting a test server for the specified scenario
  2. Running the client implementation with the test server URL
  3. Capturing MCP protocol interactions
  4. Running conformance checks against the specification
  5. Generating detailed test results

Usage

npm run start -- --command "<client-command>" --scenario <scenario-name>
  • --command - The command to run your MCP client (can include flags)
  • --scenario - The test scenario to run (e.g., "initialize")

The framework appends the server URL as the final argument to your command.

Test Results

Results are saved to results/<scenario>-<timestamp>/:

  • checks.json - Array of conformance check results with pass/fail status
  • stdout.txt - Client stdout output
  • stderr.txt - Client stderr output

Example Clients

  • examples/clients/typescript/test1.ts - Valid MCP client (passes all checks)
  • examples/clients/typescript/test-broken.ts - Invalid client missing required fields (fails checks)

Available Scenarios

  • initialize - Tests MCP client initialization handshake
    • Validates protocol version
    • Validates clientInfo (name and version)
    • Validates server response handling

Architecture

See src/runner/DESIGN.md for detailed architecture documentation.

Key Components

  • Runner (src/runner/) - Orchestrates test execution and result generation
  • Scenarios (src/scenarios/) - Test scenarios with custom server implementations
  • Checks (src/checks.ts) - Conformance validation functions
  • Types (src/types.ts) - Shared type definitions

Adding New Scenarios

  1. Create a new directory in src/scenarios/<scenario-name>/
  2. Implement the Scenario interface with start(), stop(), and getChecks()
  3. Register the scenario in src/scenarios/index.ts

See src/scenarios/initialize/ for a reference implementation.