README.md•12.7 kB
# Postman MCP Server
The Postman MCP Server connects Postman to AI tools, giving AI agents and assistants the ability to access workspaces, manage collections and environments, evaluate APIs, and automate workflows through natural language interactions.
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.
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).
Postman also offers servers as an [npm package](https://www.npmjs.com/package/@postman/postman-mcp-server).
**Note:** Before getting started, ensure that you have a valid [Postman API key](https://postman.postman.co/settings/me/api-keys).
### Use Cases
* **Code synchronization** - Effortlessly keep your code in sync with your [Postman Collections](https://learning.postman.com/docs/design-apis/collections/overview/) and specs.
* **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.
Designed for developers who want to integrate their AI tools with Postman’s context and features. Supports quick natural language queries queries to advanced agent workflows.
### Support for EU
The Postman MCP Server supports the EU region for remote and local servers:
* For streamable HTTP, the remote server is available at `https://mcp.eu.postman.com`.
* For our STDIO public package, use the `--region` flag to specify the Postman API region (`us` or `eu`), or set the `POSTMAN_API_BASE_URL` environment variable directly.
---
### Contents
* [**Remote server**](#remote-server)
* [**VS Code**](#install-in-visual-studio-code)
* [**Cursor**](#install-in-cursor)
* [**Claude Code**](#install-in-claude-code)
* [**Local server**](#local-server)
* [**VS Code**](#install-in-visual-studio-code-1)
* [**Cursor**](#install-in-cursor-1)
* [**Claude**](#claude-integration)
* [**Claude Code**](#install-in-claude-code-1)
* [**Gemini CLI**](#use-as-a-gemini-cli-extension)
* [**Docker**](#install-in-docker)
* [**Questions and support**](#questions-and-support)
* [**Migration from Postman MCP Server v1 to v2**](#migration-from-v1x-to-v2x)
---
## Remote server
The remote Postman MCP Server is hosted by Postman over streamable HTTP and provides the easiest method for getting started. If your MCP host doesn't support remote MCP servers, you can use the [local Postman MCP Server](#local-server).
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.
* **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
[](https://cursor.com/en/install-mcp?name=postman_mcp_server&config=eyJ1cmwiOiJodHRwczovL21jcC5wb3N0bWFuLmNvbS9taW5pbWFsIiwiaGVhZGVycyI6eyJBdXRob3JpemF0aW9uIjoiQmVhcmVyIFlPVVJfQVBJX0tFWSJ9fQ%3D%3D)
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.
### Install in Visual Studio Code
[](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.
#### Manual configuration
You can use the Postman MCP Server with MCP-compatible extensions in VS Code, such as GitHub Copilot, Claude for VS Code, or other AI assistants that support MCP. To do so, add the following JSON block to the `.vscode/mcp.json` configuration file:
```json
{
"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.
// For the EU server, use the "https://mcp.eu.postman.com" URL.
"headers": {
"Authorization": "Bearer ${input:postman-api-key}"
}
}
},
"inputs": [
{
"id": "postman-api-key",
"type": "promptString",
"description": "Enter your Postman API key"
}
]
}
```
When prompted, enter your Postman API key.
### Install in Claude Code
To install the MCP server in Claude Code, run the following command in your terminal:
For **Minimal** mode:
```bash
claude mcp add --transport http postman https://mcp.postman.com/minimal
```
For **Full** mode:
```bash
claude mcp add --transport http postman https://mcp.postman.com/mcp
```
---
## Local server
If remote MCP servers aren't supported by your MCP host, you can install the Postman MCP Server to your local machine.
STDIO is a lightweight solution that's ideal for integration with editors and tools like Visual Studio Code. Install an MCP-compatible VS Code extension, such as GitHub Copilot, Claude for VS Code, or other AI assistants that support MCP.
**Note:** To run the server as a Node application, install [Node.js](https://nodejs.org/en).
The local server supports the following tool configurations:
* **Minimal** — (Default) Only includes essential tools for basic Postman operations.
* **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.
### Install in Visual Studio Code
[](https://insiders.vscode.dev/redirect/mcp/install?name=postman-api-mcp&inputs=%5B%7B%22id%22%3A%22postman-api-key%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Enter%20your%20Postman%20API%20key%22%7D%5D&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22%40postman%2Fpostman-mcp-server%22%2C%22--full%22%5D%2C%22env%22%3A%7B%22POSTMAN_API_KEY%22%3A%22%24%7Binput%3Apostman-api-key%7D%22%7D%7D)
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.
#### Manual configuration
You can manually integrate your MCP server with Cursor or VS Code to use it with extensions that support MCP. To do this, create a `mcp.json` file in your project and add the following JSON block to it:
```json
{
"servers": {
"postman-api-mcp": {
"type": "stdio",
"command": "npx",
"args": [
"@postman/postman-mcp-server",
"--full" // (optional) Use this flag to enable full mode.
"--region us" // (optional) Use this flag to specify the Postman API region (us or eu). Defaults to us.
],
"env": {
"POSTMAN_API_KEY": "${input:postman-api-key}"
}
}
},
"inputs": [
{
"id": "postman-api-key",
"type": "promptString",
"description": "Enter your Postman API key"
}
]
}
```
### Install in Cursor
[](https://cursor.com/en/install-mcp?name=postman-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyJAcG9zdG1hbi9wb3N0bWFuLW1jcC1zZXJ2ZXIiLCItLWZ1bGwiXSwiZW52Ijp7IlBPU1RNQU5fQVBJX0tFWSI6IllPVVJfQVBJX0tFWSJ9fQ%3D%3D)
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.
### 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`
For more information, see the [Claude Desktop Extensions](https://www.anthropic.com/engineering/desktop-extensions) documentation.
### Install in Claude Code
To install the MCP server in Claude Code, run the following command in your terminal:
For **Minimal** mode:
```bash
claude mcp add postman -- npx @postman/mcp-server@latest
```
For **Full** mode:
```bash
claude mcp add postman -- npx @postman/mcp-server@latest --full
```
### Use as a Gemini CLI extension
To install the MCP server as a Gemini CLI extension, run the following command in your terminal:
```bash
gemini extensions install https://github.com/postmanlabs/postman-mcp-server
```
### Install in Docker
For Docker set up and installation, see [DOCKER.md](./DOCKER.md).
---
## Migration from v1.x to v2.x
If you're migrating from Postman MCP Server version 1.x to 2.x, be aware of the following:
* **Tool naming changes** - All tool names changed from kebab-case to camelCase. For example:
* `create-collection` → `createCollection`
* `get-workspaces` → `getWorkspaces`
* `delete-environment` → `deleteEnvironment`
* **Tool availability changes**
* The default (minimal) behavior provides only 37 essential tools.
* The `--full` flag provides access to all tools.
---
## 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).
