Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/workflows/mcpb-pack.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ jobs:
mv manifest-minimal.tmp.json manifest-minimal.json
jq --arg v "$pkg_version" '.version = $v' manifest-full.json > manifest-full.tmp.json
mv manifest-full.tmp.json manifest-full.json
jq --arg v "$pkg_version" '.version = $v' manifest-code.json > manifest-code.tmp.json
mv manifest-code.tmp.json manifest-code.json

- name: Build project
run: npm run build
Expand All @@ -53,9 +55,15 @@ jobs:
mcpb pack
mv "${current_dir}.mcpb" "${current_dir}-full.mcpb"

# Package code version
cp manifest-code.json manifest.json
mcpb pack
mv "${current_dir}.mcpb" "${current_dir}-code.mcpb"

# Set environment variables
echo "MCPB_MINIMAL_FILENAME=${current_dir}-minimal.mcpb" >> $GITHUB_ENV
echo "MCPB_FULL_FILENAME=${current_dir}-full.mcpb" >> $GITHUB_ENV
echo "MCPB_CODE_FILENAME=${current_dir}-code.mcpb" >> $GITHUB_ENV

- name: Upload minimal release asset
uses: svenstaro/upload-release-action@7027b7670c56b9473901daad1fb8a09ab534688e
Expand All @@ -75,6 +83,15 @@ jobs:
tag: ${{ github.ref }}
overwrite: true

- name: Upload code release asset
uses: svenstaro/upload-release-action@7027b7670c56b9473901daad1fb8a09ab534688e
with:
repo_token: ${{ secrets.GITHUB_TOKEN }}
file: ${{ env.MCPB_CODE_FILENAME }}
asset_name: ${{ env.MCPB_CODE_FILENAME }}
tag: ${{ github.ref }}
overwrite: true

publish-mcp:
needs: build-and-release
runs-on: ubuntu-latest
Expand Down
38 changes: 27 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Postman supports the following tool configurations:

* **Minimal** — (Default) Only includes essential tools for basic Postman operations This offers faster performance and simplifies use for those who only need basic Postman operations. Ideal for users who want to modify a single Postman elements, such as collections, workspaces, or environments.
* **Full** — Includes all available Postman API tools (100+ tools). This configuration is ideal for users who engage in advanced collaboration and Postman's Enterprise features.
* **Code** — Includes tools to generate high-quality, well-organized client code from public and internal API definitions. This configuration is ideal for users who need to consume APIs or simply get context about APIs to their agents.

For a complete list of the Postman MCP Server's tools, see the [Postman MCP Server collection](https://www.postman.com/postman/postman-public-workspace/collection/681dc649440b35935978b8b7). This collection offers both the remote [full](https://www.postman.com/postman/postman-public-workspace/mcp-request/6821a76b17ccb90a86df48d3) and [minimal](https://www.postman.com/postman/postman-public-workspace/mcp-request/689e1c635be722a98b723238) servers, and the [local server](https://www.postman.com/postman/postman-public-workspace/mcp-request/6866a655b36c67cc435b5033).

Expand All @@ -19,8 +20,9 @@ Postman also offers servers as an [npm package](https://www.npmjs.com/package/@p
* **Collection management** - Create and [tag](https://learning.postman.com/docs/collections/use-collections/collaborate-with-collections/#tag-a-collection) collections, update collection and request [documentation](https://learning.postman.com/docs/publishing-your-api/api-documentation-overview/), add [comments](https://learning.postman.com/docs/collaborating-in-postman/comments/), or perform actions across multiple collections without leaving your editor.
* **Workspace and environment management** - Create [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/overview/) and [environments](https://learning.postman.com/docs/sending-requests/variables/managing-environments/), plus manage your environment variables.
* **Automatic spec creation** - Create [specs](https://learning.postman.com/docs/design-apis/specifications/overview/) from your code and use them to generate collections.
* **Client code generation** - Generate production-ready client code that consumes APIs following best practices and project conventions. The `code` toolset produces code that precisely matches your API definitions, organizes it into an intuitive tree structure mirroring your Postman collections and requests, and leverages example responses to create accurate response types and error handling.

Designed for developers who want to integrate their AI tools with Postmans context and features. Supports quick natural language queries queries to advanced agent workflows.
Designed for developers who want to integrate their AI tools with Postman's context and features. Supports quick natural language queries to advanced agent workflows.

### Support for EU

Expand Down Expand Up @@ -55,6 +57,7 @@ The remote Postman MCP Server is hosted by Postman over streamable HTTP and prov
The remote server supports the following tool configurations:

* **Minimal** — (Default) Only includes essential tools for basic Postman operations, available at `https://mcp.postman.com/minimal` and `https://mcp.eu.postman.com/minimal` for EU users.
* **Code** — Includes tools for searching public and internal API definitions and generating client code, available at `https://mcp.postman.com/code` and `https://mcp.eu.postman.com/code` for EU users.
* **Full** — Includes all available Postman API tools (100+ tools), available at `https://mcp.postman.com/mcp` and `https://mcp.eu.postman.com/mcp` for EU users.

### Install in Cursor
Expand All @@ -65,15 +68,15 @@ To install the remote Postman MCP Server in Cursor, click the install button.

**Note:** Ensure that the Authorization header uses the `Bearer <YOUR_API_KEY>` format.

By default, the server uses **Minimal** mode. To access **Full** mode, change the `url` value to `https://mcp.postman.com/mcp` in the `mcp.json` file.
By default, the server uses **Minimal** mode. To access **Full** mode, change the `url` value to `https://mcp.postman.com/mcp` in the `mcp.json` file. To access **Code** mode, change the value to `https://mcp.postman.com/code`.

### Install in Visual Studio Code

[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=postman_mcp_server&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fmcp.postman.com%2Fminimal%22%2C%22headers%22%3A%7B%22Authorization%22%3A%22Bearer%20YOUR_API_KEY%22%7D%7D)

To install the remote Postman MCP Server in VS Code, click the install button or use the [Postman VS Code Extension](https://marketplace.visualstudio.com/items?itemName=Postman.postman-for-vscode).

By default, the server uses **Minimal** mode. To access **Full** mode, change the `url` value to `https://mcp.postman.com/mcp` in the `mcp.json` file.
By default, the server uses **Minimal** mode. To access **Full** mode, change the `url` value to `https://mcp.postman.com/mcp` in the `mcp.json` file. To access **Code** mode, change the value to `https://mcp.postman.com/code`.

#### Manual configuration

Expand All @@ -84,8 +87,7 @@ You can use the Postman MCP Server with MCP-compatible extensions in VS Code, su
"servers": {
"postman-api-http-server": {
"type": "http",
"url": "https://mcp.postman.com/{minimal OR mcp}",
// Use "https://mcp.postman.com/mcp" for full or "https://mcp.postman.com/minimal" for minimal mode.
"url": "https://mcp.postman.com/{minimal OR code OR mcp}",
// For the EU server, use the "https://mcp.eu.postman.com" URL.
"headers": {
"Authorization": "Bearer ${input:postman-api-key}"
Expand Down Expand Up @@ -114,6 +116,12 @@ For **Minimal** mode:
claude mcp add --transport http postman https://mcp.postman.com/minimal --header "Authorization: Bearer <POSTMAN_API_KEY>"
```

For **Code** mode:

```bash
claude mcp add --transport http postman https://mcp.postman.com/code --header "Authorization: Bearer <POSTMAN_API_KEY>"
```

For **Full** mode:

```bash
Expand All @@ -133,6 +141,7 @@ STDIO is a lightweight solution that's ideal for integration with editors and to
The local server supports the following tool configurations:

* **Minimal** — (Default) Only includes essential tools for basic Postman operations.
* **Code** — Includes tools for searching public and internal API definitions and generating client code
* **Full** — Includes all available Postman API tools (100+ tools). Use the `--full` flag to enable this configuration.

**Note:** Use the `--region` flag to specify the Postman API region (`us` or `eu`), or set the `POSTMAN_API_BASE_URL` environment variable directly. By default, the server uses the `us` option.
Expand All @@ -144,7 +153,7 @@ The local server supports the following tool configurations:

To install the local Postman MCP Server in VS Code, click the install button.

By default, the server uses **Full** mode. To access **Minimal** mode, remove the `--full` flag from the `mcp.json` configuration file.
By default, the server uses **Full** mode. To access **Minimal** mode, remove the `--full` flag from the `mcp.json` configuration file. To access **Code** mode, replace the `--full` flag with `--code`.

#### Manual configuration

Expand All @@ -158,7 +167,8 @@ You can manually integrate your MCP server with Cursor or VS Code to use it with
"command": "npx",
"args": [
"@postman/postman-mcp-server",
"--full" // (optional) Use this flag to enable full mode.
"--full", // (optional) Use this flag to enable full mode...
"--code", // (optional) ...OR this flag to enable code mode.
"--region us" // (optional) Use this flag to specify the Postman API region (us or eu). Defaults to us.
],
"env": {
Expand All @@ -182,14 +192,15 @@ You can manually integrate your MCP server with Cursor or VS Code to use it with

To install the local Postman MCP Server in Cursor, click the install button.

By default, the server uses **Full** mode. To access **Minimal** mode, remove the `--full` flag from the `mcp.json` configuration file.
By default, the server uses **Full** mode. To access **Minimal** mode, remove the `--full` flag from the `mcp.json` configuration file. To access **Code** mode, replace the `--full` flag with `--code`.

### Claude integration

To integrate the MCP server with Claude, check the latest [Postman MCP Server release](https://github.com/postmanlabs/postman-mcp-server/releases) and get the `.mcpb` file.

* **Minimal** - `postman-api-mcp-minimal.mcpb`
* **Full** - `postman-api-mcp-full.mcpb`
* **Minimal** - `postman-mcp-server-minimal.mcpb`
* **Full** - `postman-mcp-server-full.mcpb`
* **Code** - `postman-mcp-server-code.mcpb`

For more information, see the [Claude Desktop Extensions](https://www.anthropic.com/engineering/desktop-extensions) documentation.

Expand All @@ -203,6 +214,12 @@ For **Minimal** mode:
claude mcp add postman --env POSTMAN_API_KEY=YOUR_KEY -- npx @postman/postman-mcp-server@latest
```

For **Code** mode:

```bash
claude mcp add postman --env POSTMAN_API_KEY=YOUR_KEY -- npx @postman/postman-mcp-server@latest --code
```

For **Full** mode:

```bash
Expand Down Expand Up @@ -239,7 +256,6 @@ If you're migrating from Postman MCP Server version 1.x to 2.x, be aware of the

## Questions and support

* See the [Postman Agent Generator](https://postman.com/explore/agent-generator) page for updates and new capabilities.
* See [Add your MCP requests to your collections](https://learning.postman.com/docs/postman-ai-agent-builder/mcp-requests/overview/) to learn how to use Postman to perform MCP requests.
* Visit the [Postman Community](https://community.postman.com/) to share what you've built, ask questions, and get help.
* You can connect to both the remote and local servers and test them using the [Postman MCP Server collection](https://www.postman.com/postman/postman-public-workspace/collection/681dc649440b35935978b8b7).
20 changes: 10 additions & 10 deletions dist/package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 22 additions & 2 deletions dist/src/enabledResources.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 6 additions & 3 deletions dist/src/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading