mcp2postman 1.0.0__tar.gz

mcp2postman-1.0.0/CHANGELOG.md

@@ -0,0 +1,58 @@
+# Changelog
+
+## 1.0.0 - 2026-11-11
+
+First release published on PyPI: `pip install mcp2postman`.
+
+### Added
+- Support for MCP protocol versions `2026-07-28`, `2025-11-25` and
+  `2025-06-18`. Discovery proposes the newest one and, when a server rejects
+  it with an error instead of negotiating, retries with the next older one.
+  Connection failures are not retried. A negotiated version outside the list
+  is reported as a snapshot warning. (SA-3290)
+- New "91 Protocol versions" folder: one `initialize` per version plus an
+  unknown version (`1999-01-01`), checking the negotiation rules without
+  touching `mcpSessionId`. `--protocol-versions V1,V2` (or `none`) selects the
+  versions, and `--no-protocol-tests` also skips the folder. (SA-3290)
+- Package metadata for PyPI: project URLs, supported Python versions
+  (3.10 to 3.13) and a source distribution that includes the tests and
+  examples.
+
+### Changed
+- The tool is now called `mcp2postman`, like the repository: package on PyPI,
+  Python module (`import mcp2postman`, `python -m mcp2postman`), command,
+  MCP `clientInfo` name and `User-Agent`. Snapshots now use the format
+  `mcp2postman/snapshot@1`; regenerate snapshots saved by 0.x versions.
+- Each `tool: <name>` folder now holds one subfolder per test kind
+  ("valid", "missing required -> error", "wrong type -> error"), so a single
+  kind of test can be run or reviewed on its own. Empty kinds, for example
+  with `--no-negative-tests`, are left out. (SA-3277)
+- The README installs from PyPI and uses absolute links, so it renders on the
+  PyPI project page.
+
+### Removed
+- Python 3.9 support. It reached end of life in October 2025 and is no longer
+  available on the CI runners. Python 3.10 or later is required.
+
+## 0.2.0 - 2026-11-05
+
+### Added
+- `--body-variables`: tool and prompt argument values move from request
+  bodies into environment variables (`{{<tool>_<arg>}}`,
+  `{{prompt_<prompt>_<arg>}}`). Non-string values are inserted without quotes,
+  so their JSON type is kept. (SA-3276)
+- `--config` / `--server`: read the server and its auth from an
+  `mcp-config.json`.
+
+### Changed
+- The Postman environment file is always written, next to the collection by
+  default, and always contains `baseUrl`. `--environment-out` only sets its
+  path. (SA-3276)
+- Test scripts resolve variables before reading the JSON-RPC request id.
+- The client sends its own `User-Agent`.
+
+## 0.1.0
+
+- First release: MCP (Streamable HTTP or stdio) to Postman collection, with
+  tests for required and optional attributes, response schema validation and
+  drift checks. (SA-3275)

mcp2postman-1.0.0/LICENSE.md

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mcp2postman-1.0.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include CHANGELOG.md
+recursive-include tests *.py
+recursive-include examples *.py *.json
+global-exclude __pycache__ *.py[cod]

mcp2postman-1.0.0/PKG-INFO

@@ -0,0 +1,406 @@
+Metadata-Version: 2.4
+Name: mcp2postman
+Version: 1.0.0
+Summary: Convert an MCP server (Streamable HTTP or stdio) into a Postman collection with contract, required and optional attribute tests.
+Author-email: APIAddicts <devrel@apiaddicts.org>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/apiaddicts/mcp2postman
+Project-URL: Repository, https://github.com/apiaddicts/mcp2postman
+Project-URL: Issues, https://github.com/apiaddicts/mcp2postman/issues
+Project-URL: Changelog, https://github.com/apiaddicts/mcp2postman/blob/main/CHANGELOG.md
+Keywords: mcp,model-context-protocol,postman,testing,json-rpc,cli
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Dynamic: license-file
+
+# mcp2postman
+
+[![PyPI version](https://img.shields.io/pypi/v/mcp2postman.svg)](https://pypi.org/project/mcp2postman/)
+[![Python versions](https://img.shields.io/pypi/pyversions/mcp2postman.svg)](https://pypi.org/project/mcp2postman/)
+[![Downloads](https://static.pepy.tech/badge/mcp2postman/month)](https://pepy.tech/project/mcp2postman)
+[![CI](https://github.com/apiaddicts/mcp2postman/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/apiaddicts/mcp2postman/actions/workflows/ci.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/apiaddicts/mcp2postman/blob/main/LICENSE.md)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+Turn an **MCP server** (Model Context Protocol) into a **Postman collection** that
+initializes a session, calls every tool, resource and prompt, and **tests the
+responses**. The tests check that responses follow the MCP schema, that the
+server still matches the contract it published, and that required and optional
+attributes behave as declared.
+
+```
+MCP server ──(initialize, tools/list, resources/list, prompts/list)──▶ snapshot ──▶ Postman collection
+ (HTTP or stdio)                                                                    + environment
+```
+
+* Works with **Streamable HTTP** servers (`--url`) and **stdio** servers (`--stdio`).
+* Handles both `application/json` and `text/event-stream` (SSE) responses, in
+  the CLI and in the generated Postman scripts.
+* Builds **positive and negative tests** for each tool, based on its `inputSchema`:
+  * valid call with all attributes,
+  * valid call with required attributes only,
+  * valid call with the required attributes plus one optional attribute, for each optional attribute,
+  * call without each required attribute, which must be rejected,
+  * call with a wrong type for each attribute, which must be rejected.
+* **Validates responses** with JSON Schema: `InitializeResult`, `CallToolResult`,
+  `structuredContent` against the tool's `outputSchema`, `ReadResourceResult`,
+  `GetPromptResult`, and the JSON-RPC error shape.
+* **Always writes a Postman environment** next to the collection, with
+  `baseUrl` and the header variables. With `--body-variables`, the tool and
+  prompt argument values move from the request bodies into that environment.
+* **Detects drift.** `tools/list` and `prompts/list` fail when a tool or prompt
+  disappears or its input schema changes after the collection was generated.
+* Has no runtime dependencies (Python ≥ 3.10 standard library only).
+* Licensed under Apache 2.0.
+
+## Installation
+
+```bash
+pip install mcp2postman
+```
+
+This installs the `mcp2postman` command. You can also run it with
+`python -m mcp2postman`.
+
+To install the latest development version from GitHub, or from a local clone:
+
+```bash
+pip install git+https://github.com/apiaddicts/mcp2postman.git
+# or, from a clone
+pip install -e .
+```
+
+## Quick start
+
+Try it with the bundled demo server:
+
+```bash
+python examples/demo_server.py --http --port 8765 &
+
+mcp2postman inspect  --url http://localhost:8765/mcp
+mcp2postman generate --url http://localhost:8765/mcp -o demo.postman_collection.json
+# -> demo.postman_collection.json + demo.postman_environment.json
+
+# run it (any of these)
+postman collection run demo.postman_collection.json -e demo.postman_environment.json
+newman run demo.postman_collection.json -e demo.postman_environment.json
+```
+
+Output of `inspect`:
+
+```
+Demo MCP Server 1.0.0
+  protocol:     2025-06-18
+  capabilities: prompts, resources, tools
+
+Tools (3):
+  - add(a*, b*)
+  - greet(name*, language, excited)
+  - search_items(query*, limit, tags, filters)
+...
+(* = required)
+```
+
+With the demo server, the generated collection has 42 requests and 176
+assertions, and all of them pass. `examples/demo.postman_collection.json` is
+an example of the output.
+
+You can also import the collection into the Postman app (*Import → File*).
+**Run the `00 Lifecycle` folder first.** It opens the MCP session and stores
+`Mcp-Session-Id` and the negotiated protocol version, and the other requests
+use those values.
+
+## Usage
+
+### `generate`
+
+```text
+mcp2postman generate (--url URL | --stdio COMMAND | --config FILE | --from-snapshot FILE) [options]
+```
+
+| Option | Description |
+|---|---|
+| `--url URL` | Streamable HTTP endpoint, for example `http://localhost:3000/mcp` |
+| `--stdio "CMD"` | Command that starts a stdio server, for example `"npx -y @modelcontextprotocol/server-everything"` |
+| `--config FILE` | Read the server (URL or command, args, env, cwd) and its auth headers from an `mcp-config.json`. See [MCP config files](#mcp-config-files) |
+| `--server NAME` | Server to use when the config file defines several |
+| `--from-snapshot FILE` | Generate offline from a snapshot saved earlier |
+| `-H 'Name: value'` | Extra HTTP header (repeatable). Typical use: `-H 'Authorization: Bearer …'`. Overrides a config header with the same name |
+| `--env KEY=VALUE` | Environment variable for the stdio server (repeatable). Overrides the config `env` |
+| `-o FILE` | Collection output file (`-` for stdout). The default is `<server>.postman_collection.json` |
+| `--environment-out FILE` | Path of the Postman environment, which is always written. It holds `baseUrl`, the header variables and, with `--body-variables`, the argument values. The default is the collection path with `.postman_environment.json` (`<server>.postman_environment.json` when `-o -`) |
+| `--body-variables` | Put tool and prompt argument values in environment variables (`{{tool_arg}}`) instead of writing them into the request bodies. See [Body variables](#body-variables) |
+| `--snapshot-out FILE` | Also save the discovered server snapshot |
+| `--base-url URL` | Value of `{{baseUrl}}`. The default is `--url`, or `http://localhost:3000/mcp` for stdio |
+| `--name NAME` | Collection name |
+| `--embed-header-values` | Write `-H` values into the collection and environment (see [Secrets](#secrets)) |
+| `--include-tool GLOB` / `--exclude-tool GLOB` | Choose which tools get requests (repeatable) |
+| `--values FILE` | Argument values for each tool, which replace the generated samples |
+| `--no-negative-tests` | Do not generate the *missing required* and *wrong type* requests |
+| `--no-wrong-type-tests` | Do not generate the *wrong type* requests |
+| `--no-optional-variants` | Do not generate one request per optional attribute |
+| `--no-protocol-tests` | Do not generate the generic JSON-RPC checks (unknown method, unknown tool) or the protocol version checks |
+| `--protocol-versions V1,V2` | Protocol versions checked in the `91 Protocol versions` folder. The default is every supported version (`2026-07-28,2025-11-25,2025-06-18`), and `none` leaves the folder out |
+| `--no-resources` / `--no-prompts` / `--no-teardown` | Leave out those folders |
+| `--protocol-version V` | Protocol version proposed in `initialize`. By default the newest supported version (`2026-07-28`) is proposed. If the server rejects it instead of negotiating, discovery retries with `2025-11-25`, then `2025-06-18` |
+| `--timeout S` | Seconds to wait for each response during discovery |
+
+### `inspect`
+
+```text
+mcp2postman inspect (--url URL | --stdio COMMAND | --config FILE [--server NAME]) [-H ...] [--json]
+```
+
+Prints the server's tools (required attributes are marked with `*`), resources
+and prompts. With `--json`, it prints the full snapshot instead.
+
+### Realistic argument values
+
+The generator creates sample values from each JSON schema. It uses `const`,
+`default`, `examples`, `enum`, `format`, bounds, `pattern`, `$ref`, `anyOf`,
+`oneOf` and `allOf`. When a tool needs real data, such as an existing ID, put
+it in a values file:
+
+```json
+{
+  "add":   { "a": 40, "b": 2 },
+  "greet": { "name": "Ada", "language": "es" }
+}
+```
+
+```bash
+mcp2postman generate --url … --values examples/values.json
+```
+
+### Body variables
+
+By default, argument values are written straight into each request body. With
+`--body-variables`, every top-level tool argument becomes the variable
+`{{<tool>_<argument>}}`, and every prompt argument becomes
+`{{prompt_<prompt>_<argument>}}`. The values go into the environment file, so
+you can change test data without regenerating the collection or editing
+requests.
+
+```bash
+mcp2postman generate --url http://localhost:8765/mcp --body-variables \
+    --values examples/values.json -o demo.postman_collection.json
+```
+
+Request body:
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 4,
+  "method": "tools/call",
+  "params": {
+    "name": "add",
+    "arguments": {
+      "a": {{add_a}},
+      "b": {{add_b}}
+    }
+  }
+}
+```
+
+Environment (`demo.postman_environment.json`):
+
+| key | value |
+|---|---|
+| `baseUrl` | `http://localhost:8765/mcp` |
+| `add_a` | `40` |
+| `add_b` | `2` |
+| `greet_name` | `Ada` |
+| `search_items_filters` | `{"inStock": true}` |
+| `prompt_summarize_text` | `example-text` |
+
+How values are stored:
+
+* **Strings** are used inside quotes (`"{{greet_name}}"`). The environment
+  holds the text with JSON escaping, so `"` becomes `\"`.
+* **Numbers, booleans, null, arrays and objects** are used without quotes
+  (`{{add_a}}`) and stored as JSON literals (`40`, `true`, `["a"]`,
+  `{"inStock": true}`), so the server still receives the right JSON type.
+* The valid variants of a tool (all attributes, required only, one per
+  optional attribute) and its *missing required* requests share the same
+  variables. *Wrong type* requests keep their deliberately invalid value as a
+  literal.
+* `--values` sets the initial values in the environment.
+
+Raw bodies containing unquoted `{{…}}` aren't valid JSON until Postman
+substitutes the variables, so **always run the collection with its
+environment** (`-e`).
+
+### MCP config files
+
+Reuse the `mcp-config.json` you already give to Claude Desktop, Claude Code
+(`.mcp.json`), Cursor or VS Code (`.vscode/mcp.json`) instead of repeating the
+URL, command and credentials on the command line:
+
+```json
+{
+  "mcpServers": {
+    "corecast": {
+      "type": "http",
+      "url": "https://aigw-wso2.apiquality.io/mcp-corecast/1/mcp",
+      "headers": { "Authorization": "Bearer ${CORECAST_TOKEN}" }
+    },
+    "local": {
+      "command": "python",
+      "args": ["examples/demo_server.py", "--stdio"],
+      "env": { "API_KEY": "${API_KEY}" }
+    }
+  }
+}
+```
+
+```bash
+export CORECAST_TOKEN=…
+mcp2postman generate --config mcp-config.json --server corecast -o corecast.postman_collection.json
+```
+
+* Accepted layouts: `{"mcpServers": {…}}`, VS Code's `{"servers": {…}, "inputs": […]}`,
+  or a single server object. `--server` is only needed when there are several.
+* HTTP servers use `url`, `headers` and an optional `type` (`http` or
+  `streamable-http`). The legacy `sse` type is rejected. stdio servers use
+  `command`, `args`, `env` and `cwd` (relative to the config file).
+* Keep secrets out of the file with `${VAR}`, `${env:VAR}` or `${VAR:-default}`
+  (read from the environment, and an unset variable is an error). VS Code
+  `${input:id}` values are prompted for on the terminal, hidden when the input
+  has `"password": true`.
+* Config headers are handled like `-H` headers: they're sent during discovery
+  and become empty `{{header_…}}` variables in the collection (see
+  [Secrets](#secrets)). The snapshot only records the file and server name,
+  never the header or env values.
+
+### stdio servers
+
+Postman can only send HTTP requests. For a stdio server, the CLI starts the
+process to discover what it exposes, but the collection targets `{{baseUrl}}`.
+To run the collection, expose the server over Streamable HTTP, for example with
+a stdio-to-HTTP bridge, and pass `--base-url` or edit the variable:
+
+```bash
+mcp2postman generate --stdio "python examples/demo_server.py --stdio" \
+    --base-url http://localhost:8000/mcp
+```
+
+### Secrets
+
+By default, every `-H` header is sent to the server during discovery. In the
+collection, it becomes a reference to an **empty** variable (`Authorization:
+{{header_authorization}}`), so you don't commit credentials by accident. Supply
+the value when you run the collection:
+
+```bash
+postman collection run c.json --env-var "header_authorization=Bearer $TOKEN"
+newman run c.json --env-var "header_authorization=Bearer $TOKEN"
+```
+
+To store the values in the collection and environment files, use
+`--embed-header-values`.
+
+### Snapshots and CI
+
+```bash
+# once: discover and store the contract
+mcp2postman generate --url $MCP_URL --snapshot-out mcp.snapshot.json -o mcp.postman_collection.json
+git add mcp.snapshot.json mcp.postman_collection.json mcp.postman_environment.json
+
+# in CI: run the collection against the deployed server
+postman collection run mcp.postman_collection.json -e mcp.postman_environment.json --env-var "baseUrl=$MCP_URL"
+```
+
+If someone removes a tool or changes its `inputSchema`, the `tools/list`
+drift tests fail.
+
+## What the collection contains
+
+```
+<Server> (MCP)
+├── 00 Lifecycle
+│   ├── initialize                       → stores Mcp-Session-Id + protocolVersion
+│   ├── notifications/initialized        → 202 Accepted
+│   └── ping
+├── 01 Tools
+│   ├── tools/list                       → schema + drift checks
+│   ├── tool: <name>
+│   │   ├── valid
+│   │   │   ├── <name> - valid, all attributes
+│   │   │   ├── <name> - valid, required attributes only
+│   │   │   └── <name> - valid, required + optional '<opt>'  (one per optional attribute)
+│   │   ├── missing required -> error
+│   │   │   └── <name> - missing required '<req>' -> error   (one per required attribute)
+│   │   └── wrong type -> error
+│   │       └── <name> - wrong type for required|optional '<attr>' -> error
+│   └── tools/call unknown tool -> error
+├── 02 Resources        resources/list, resources/templates/list, resources/read <each>, missing uri -> error
+├── 03 Prompts          prompts/list, prompts/get (all / required only / missing required -> error)
+├── 90 Protocol         unknown method -> -32601
+├── 91 Protocol versions initialize with <each version> + an unknown version (negotiation rules)
+└── 99 Teardown         DELETE session
+```
+
+**Valid calls** pass when the HTTP status is 200, the body contains a JSON-RPC
+2.0 response with the request's `id`, there is no `error`, the `result` matches
+the MCP schema, `isError` is not `true`, and `structuredContent` matches the
+tool's `outputSchema` when the tool declares one.
+
+**Invalid calls** pass when the server rejects them, either with a JSON-RPC
+`error` or with a tool result that has `isError: true`. The MCP specification
+allows both. The error payload must also be well formed, and the server must
+not answer with a 5xx status.
+
+**Protocol version checks** (`91 Protocol versions`) send one `initialize` per
+version. The server must answer with a version mcp2postman supports, must
+keep the version that discovery negotiated, and must not echo the unknown
+version `1999-01-01`. Each request opens its own session and doesn't change
+`{{mcpSessionId}}`.
+
+> ⚠️ The collection **really calls every tool**, several times. Don't run it
+> against tools with side effects (sending email, payments, deletes) on a
+> production server. Use `--exclude-tool` or `--values`, or point it at a test
+> environment.
+
+## Development
+
+```bash
+python -m venv .venv && . .venv/bin/activate
+pip install -e '.[dev]'
+pytest              # unit + integration tests (end-to-end tests run when newman or postman CLI is installed)
+ruff check .
+```
+
+See [ARCHITECTURE.md](https://github.com/apiaddicts/mcp2postman/blob/main/ARCHITECTURE.md) for how the code is organized.
+
+## Limitations
+
+* The legacy HTTP+SSE transport (protocol 2024-11-05, separate `/sse` and
+  `/messages` endpoints) isn't supported. Use Streamable HTTP or stdio.
+* OAuth flows aren't automated (an `oauth` block in a config file is ignored).
+  Get a token yourself and pass it with `-H` or a `${VAR}` config header.
+* Generated values satisfy common JSON Schema constraints. A complex `pattern`
+  or semantic constraints, such as an ID that has to exist, may need `--values`.
+* The `tools/list` drift checks only look at the first page when the server
+  paginates.
+
+## License
+
+Apache License 2.0. See [LICENSE.md](https://github.com/apiaddicts/mcp2postman/blob/main/LICENSE.md).
+
+Changes between versions are listed in the [changelog](https://github.com/apiaddicts/mcp2postman/blob/main/CHANGELOG.md).