mcp-vcr 0.1.0__tar.gz

mcp_vcr-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 mcp-vcr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mcp_vcr-0.1.0/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: mcp-vcr
+Version: 0.1.0
+Summary: A deterministic, replayable, human-readable MCP transcript format and proxy.
+Author: mcp-vcr contributors
+Requires-Python: >=3.12
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: click>=8.1.0
+Requires-Dist: jsonschema>=4.20.0
+Dynamic: license-file

mcp_vcr-0.1.0/README.md

@@ -0,0 +1,187 @@
+# MCP-VCR 📼
+
+**Record and replay stdio MCP server conversations. Catch regressions in CI before your users do.**
+
+```bash
+# Record a live session from any client
+mcp-vcr record -- python my_server.py
+
+# Create a normalized golden snapshot
+mcp-vcr snapshot sessions/voice_session.yaml
+
+# Verify your current code against all snapshots
+mcp-vcr verify snapshots/ -- python server.py
+```
+
+---
+
+## What is MCP-VCR?
+
+`mcp-vcr` is a transparent, developer-first stdio proxy and regression testing framework for [Model Context Protocol (MCP)](https://modelcontextprotocol.org) servers. 
+
+It sits cleanly between an MCP client (such as Claude Desktop, Cursor, Windsurf, or MCP Inspector) and your server, records every JSON-RPC 2.0 exchange in both directions, and saves them as highly human-readable, git-diffable YAML transcripts.
+
+### Key Capabilities
+
+*   **Deterministic Replay**: Replay recorded client commands against your server and automatically match responses by JSON-RPC `id` values.
+*   **Golden Snapshots**: Strips out non-deterministic noise (timestamps, UUIDs, request/response IDs, page cursors, local paths) to form a reproducible, byte-identical contract test suite.
+*   **In-Flight Redaction**: Walks message payloads recursively to scrub credentials, OpenAI keys, bearer tokens, passwords, and absolute user directory paths *before* writing transcripts to your disk.
+*   **Layered Diff Engines**: Spot structural schema drift, type changes, or value regressions using `--structural`, `--semantic`, or `--strict` diffing options.
+*   **CI-Native Checking**: Verify your whole server against dozens of snapshots with a single command; exits with code `0` on success or code `1` on regression.
+
+---
+
+## The Problems It Solves
+
+| Developer Pain | How `mcp-vcr` Fixes It |
+| :--- | :--- |
+| **Flaky CI Pipelines** | Golden snapshots normalize IDs, UUIDs, and timestamps, preventing false negatives. |
+| **Invisible Stdio Streams** | Intercepts, structures, and logs bidirectional traffic with relative millisecond offsets. |
+| **Hard-to-Reproduce Bugs** | Capture a failing sequence from Claude Desktop and replay it locally in one command. |
+| **Silent API Schema Drift** | Strict structural diffs flag added/removed tools, arguments, or changed types immediately. |
+| **Credential Leaks in Git** | Built-in redaction keeps secrets and private absolute filesystem paths out of your codebase. |
+
+---
+
+## Installation
+
+Install `mcp-vcr` inside your virtual environment using poetry or pip:
+
+```bash
+# Using poetry (recommended)
+poetry add mcp-vcr
+
+# Or using pip
+pip install mcp-vcr
+```
+
+*Requires Python 3.10+. Zero databases, heavy external services, or cloud setups required.*
+
+---
+
+## Quickstart Guide
+
+### 1. Record a Live Session
+Run your server through the record proxy. Any standard stdio client interacting with this pipe will be recorded:
+
+```bash
+mcp-vcr record --name init_tools_list -- python my_server.py
+```
+This produces an auto-redacted transcript inside the default `sessions/` directory (which you should add to `.gitignore`).
+
+### 2. Create a Golden Snapshot
+Turn a raw recorded session into a normalized, stable regression baseline:
+
+```bash
+mcp-vcr snapshot sessions/session_20260518_init_tools_list.yaml
+```
+This creates a golden snapshot file under the `snapshots/` directory: `snapshots/init_tools_list_golden.yaml`. **Commit this folder to your Git repository.**
+
+### 3. Verify for Regressions in CI
+Run the verification command. It replays client traffic from all golden snapshots against your live server code:
+
+```bash
+mcp-vcr verify snapshots/ -- python my_server.py
+```
+*   **Exit code `0`**: All responses match their golden snapshots perfectly.
+*   **Exit code `1`**: Regressions or schema mismatches detected. Prints a readable diff to stderr.
+
+### 4. Overwrite Goldens After Intentional Schema Changes
+If you intentionally add a new tool or change response formatting, update your golden snapshots using the `--update` flag:
+
+```bash
+mcp-vcr verify --update snapshots/ -- python my_server.py
+```
+Review the changes using `git diff snapshots/` before committing.
+
+---
+
+## Claude Desktop Configuration
+
+To capture real interactions from the Claude Desktop app, add `mcp-vcr` as your server launcher inside `claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "my-server": {
+      "command": "mcp-vcr",
+      "args": [
+        "record",
+        "--name",
+        "desktop_session",
+        "--",
+        "python",
+        "/absolute/path/to/my_server.py"
+      ]
+    }
+  }
+}
+```
+
+> [!NOTE]
+> The `--` separator is required to clearly segregate MCP-VCR command-line flags from the command used to launch your actual server process.
+
+---
+
+## Redaction & Security
+
+`mcp-vcr` walks JSON-RPC message payloads recursively to redact known secret keys, environment paths, and pattern matches *before* writing transcripts. The client and server receive the raw streams intact; only the stored file is sanitized.
+
+*   **Field Rules**: Fields matching `api_key`, `token`, `secret`, `password`, `credential`, or `authorization` are replaced with `<REDACTED_fieldname>`.
+*   **Pattern Rules**: Regex strings (e.g., Bearer tokens, AWS keys, OpenAI `sk-` keys) are scrubbed.
+*   **Path Rules**: Absolute filesystem paths (e.g., `/home/username/...`) are replaced with `<PATH>`.
+
+Configure custom rules in your project's `.mcp-vcr.yaml` file:
+
+```yaml
+redact:
+  fields:
+    - secret_config_token
+  patterns:
+    - "custom-auth-[a-zA-Z0-9]{16}"
+  paths: true
+```
+
+---
+
+## What Lies Ahead (Roadmap)
+
+We are laser-focused on keeping our **versioned, deterministic transcript core** stable and backward-compatible. The following major capabilities are scheduled for implementation:
+
+### 1. Timing-Faithful Replay
+Optionally use the recorded `t` relative millisecond values from the transcript to insert deterministic `asyncio.sleep` pauses between client-to-server (`c2s`) messages. Crucial for verifying servers with timeout-sensitive states.
+
+### 2. Fuzz Testing Mode
+Add `mcp-vcr fuzz` to replay recorded snapshots with randomized mutations (truncated payloads, type confusion, missing required schema fields, and boundary values) to audit server error handling and crash resistance.
+
+### 3. MCP Inspector Integration
+Coordinating with the MCP community to support loading `mcp-vcr` transcripts directly into the official MCP Inspector web interface for timeline visualization, message inspection, and interactive debugging.
+
+### 4. Compatibility Matrix Report
+Record and diff identical session exchanges across major MCP client runtimes (Claude Desktop, Cursor, Windsurf, etc.) to generate a public compatibility matrix, letting authors prove their servers work flawlessly across the client ecosystem.
+
+### 5. HTTP/SSE Recording
+Extending the stdio proxy architecture to support recording and replaying **HTTP/Server-Sent Events (SSE)**, the second official MCP transport layer.
+
+---
+
+## Design Principles
+
+*   **Local-First & Offline**: Zero telemetry, zero external database integrations, and zero mandatory cloud services. Your tests run fast and offline.
+*   **Protocol-Transparent**: The proxy acts as a silent observer. It never intercepts, manipulates, or alters protocol-level capability negotiations between the client and server.
+*   **Git-Friendly Transcripts**: Structured YAML outputs with stable key ordering, deterministic naming, and deep secret scrubbing are designed to be checked in alongside your code.
+
+---
+
+## Developer Resources
+
+*   [Developer Getting Started Guide](docs/getting-started.md) (onboarding in under 10 minutes)
+*   [CI/CD Pipeline Integration Guide](docs/ci-integration.md) (setup for GitHub Actions & GitLab CI/CD)
+*   [Internal Architecture & Design Internals](Architecture.md) (deep-dive on proxy buffers and the normalization pipeline)
+*   [Pytest Integration Guide](docs/pytest-integration.md)
+
+---
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

mcp_vcr-0.1.0/mcp_vcr/__init__.py

@@ -0,0 +1,46 @@
+from .schema import Transcript, Message, Metadata, Direction
+from .validator import validate_file, validate_transcript
+from .interceptor import MessageInterceptor
+from .redactor import Redactor
+from .normalizer import (
+    Normalizer,
+    NormalizerChain,
+    TimestampNormalizer,
+    RequestIdNormalizer,
+    UuidNormalizer,
+    CursorNormalizer
+)
+from .transport import (
+    get_stdin_reader,
+    launch_server,
+    pump_c2s,
+    pump_s2c,
+    pump_stderr,
+    run_proxy
+)
+from .replay import ReplayEngine
+
+__all__ = [
+    "Transcript",
+    "Message",
+    "Metadata",
+    "Direction",
+    "validate_file",
+    "validate_transcript",
+    "MessageInterceptor",
+    "Redactor",
+    "Normalizer",
+    "NormalizerChain",
+    "TimestampNormalizer",
+    "RequestIdNormalizer",
+    "UuidNormalizer",
+    "CursorNormalizer",
+    "get_stdin_reader",
+    "launch_server",
+    "pump_c2s",
+    "pump_s2c",
+    "pump_stderr",
+    "run_proxy",
+    "ReplayEngine",
+]
+