Developer resourcesPostman API referencePostman MCP Server

Set up the Postman MCP Server

View as Markdown

The Postman MCP Server supports both remote servers through streamable HTTP and local servers with STDIO. The remote server is available at https://mcp.postman.com/ and https://mcp.eu.postman.com for the EU, and the local server is available in the Postman MCP Server GitHub repository. You can also fork the Postman MCP collection from the Postman Public Workspace.

Postman also offers servers as an npm package and as a Docker image.

Authentication

For the best developer experience and fastest setup, use OAuth on the remote server (https://mcp.postman.com). OAuth is fully compliant with the MCP Authorization specification and doesn’t require manual API key configuration.

The EU remote server and the local server support only Postman API key authentication.

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 the 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.
  • OAuth isn’t supported for the EU Postman MCP Server. The EU remote server only supports API key authentication.

Remote server

The remote Postman MCP Server is hosted by Postman over streamable HTTP and provides the easiest method for getting started.

The remote server (https://mcp.postman.com) supports OAuth for the best developer experience and fastest setup, and doesn’t require an API key. OAuth provides stronger security and access control compared to a static API key. It’s MCP specification-compliant, including Dynamic Client Registration (DCR), OAuth metadata, and PKCE.

The EU remote server (https://mcp.eu.postman.com) only supports API key authentication.

MCP hosts that support OAuth can discover and use it automatically for all tools. The remote server also accepts a Postman API key (Bearer token in the Authorization header).

Use cases

Consider using the remote Postman MCP server if:

  • Your MCP host doesn’t support local MCP servers.
  • You want a fast and quick way to get started with the Postman MCP server.

Supported configurations

The remote Postman MCP server offers the following tool configurations through streamable HTTP:

  • Minimal — (Default) This mode 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

Click the button to install the remote Postman MCP Server in Cursor:

Install the remote Postman MCP Server

If your MCP host supports OAuth, use the https://mcp.postman.com server URL without headers for the fastest setup. Otherwise, ensure the Authorization header uses the Bearer <YOUR_API_KEY> format. Note that OAuth isn’t supported for EU servers.

After installing, ensure that the Authorization header uses the Bearer $POSTMAN-API-KEY format.

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 in this file.

Install in Visual Studio Code

To install the remote Postman MCP Server in VS Code, click the install button or use the Postman VS Code Extension:

Install the remote Postman MCP Server in VS Code

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 in this file.

Manual installation

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 this, add the following JSON block to the .vscode/mcp.json configuration file:

OAuth

Add the following JSON block to use the recommended OAuth installation method:

1{
2    "servers": {
3        "postman": {
4            "type": "http",
5            "url": "https://mcp.postman.com/{minimal OR code OR mcp}"
6        }
7    }
8}

Start the server. When prompted, enter your Postman API key.

API key

Use the following JSON block to use the API key installation method:

1{
2    "servers": {
3        "postman": {
4            "type": "http",
5            "url": "https://mcp.postman.com/{minimal OR code OR mcp}",
6            // For the EU server, use "https://mcp.eu.postman.com/{minimal OR code OR mcp}"
7            "headers": {
8                "Authorization": "Bearer ${input:postman-api-key}"
9            }
10        }
11    },
12    "inputs": [
13        {
14            "id": "postman-api-key",
15            "type": "promptString",
16            "description": "Enter your Postman API key"
17        }
18    ]
19}

Start the server. When prompted, enter your Postman API key.

Install in Claude Code

On the US server, Claude Code automatically uses OAuth for the best installation experience. To use an API key (required for the EU server), add the --header flag.

OAuth

To use the OAuth installation method for US servers, run the following command in your terminal:

For Minimal mode:

$claude mcp add --transport http postman https://mcp.postman.com/minimal

For Code mode:

$claude mcp add --transport http postman https://mcp.postman.com/code

For Full mode:

$claude mcp add --transport http postman https://mcp.postman.com/mcp

API key

To use the API key installation method if required and for EU servers, run the following command in your terminal:

For Minimal mode:

$claude mcp add --transport http postman https://mcp.postman.com/minimal --header "Authorization: Bearer <POSTMAN_API_KEY>"

For Code mode:

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

For Full mode:

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

Install in Codex

To install the remote server in Codex, use one of the following methods, depending on your authentication and region.

OAuth

Use this method with the US server for the best installation experience. OAuth requires no manual API key setup.

For Minimal mode:

$codex mcp add postman --remote-url https://mcp.postman.com/minimal

For Code mode:

$codex mcp add postman --remote-url https://mcp.postman.com/code

For Full mode:

$codex mcp add postman --remote-url https://mcp.postman.com/mcp

API key

If you’re using the EU server, a local server, or prefer API key authentication, use the API key method. Set the POSTMAN_API_KEY environment variable and invoke the MCP server using npx.

For Minimal mode:

$codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --minimal

For Code mode:

$codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --code

For Full mode:

$codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --full

Manual installation

To manually install the MCP server in Codex, create a ~/.codex/config.toml config file, then copy the following config into the file:

$[mcp_servers.postman-mcp-server]
$command = "npx"
$args = ["-y", "@postman/postman-mcp-server"]
$
$[mcp_servers.postman-mcp-server.env]
$POSTMAN_API_KEY="XXX"

Install in Windsurf

To install the MCP server in Windsurf, copy the following JSON config into the .codeium/windsurf/mcp_config.json file. This configuration uses the remote server (https://mcp.postman.com), which automatically authenticates with OAuth.

1{
2    "mcpServers": {
3        "postman-full": {
4            "args": [
5                "mcp-remote",
6                "https://mcp.postman.com/mcp"
7            ],
8            "disabled": false,
9            "disabledTools": [],
10            "env": {}
11        },
12        "postman-code": {
13            "args": [
14                "mcp-remote",
15                "https://mcp.postman.com/code"
16            ],
17            "disabled": false,
18            "disabledTools": [],
19            "env": {}
20        },
21        "postman-minimal": {
22            "args": [
23                "mcp-remote",
24                "https://mcp.postman.com/minimal"
25            ],
26            "disabled": false,
27            "disabledTools": [],
28            "env": {}
29        }
30    }
31}

Install in Antigravity

To install the MCP server in Antigravity, click Manage MCP servers > View raw config. Then, copy the following JSON config into the .codeium/windsurf/mcp_config.json file. This configuration uses the remote server (https://mcp.postman.com), which automatically authenticates with OAuth.

1{
2    "mcpServers": {
3        "postman-full": {
4            "args": [
5                "mcp-remote",
6                "https://mcp.postman.com/mcp"
7            ],
8            "disabled": false,
9            "disabledTools": [],
10            "env": {}
11        },
12        "postman-code": {
13            "args": [
14                "mcp-remote",
15                "https://mcp.postman.com/code"
16            ],
17            "disabled": false,
18            "disabledTools": [],
19            "env": {}
20        },
21        "postman-minimal": {
22            "args": [
23                "mcp-remote",
24                "https://mcp.postman.com/minimal"
25            ],
26            "disabled": false,
27            "disabledTools": [],
28            "env": {}
29        }
30    }
31}

Install in GitHub Copilot CLI

You can add the MCP server to your Copilot CLI either with OAuth (recommended) or an API key.

Use the Copilot CLI to interactively add the MCP server:

$/mcp add

Manual installation

Copy the following JSON config into the ~/.copilot/mcp-config.json file:

1{
2    "mcpServers": {
3        "postman": {
4            "type": "http",
5            "url": "https://mcp.postman.com/minimal" // Use "https://mcp.postman.com/mcp" for Full mode, or "https://mcp.postman.com/code"` for Code mode.
6        }
7    }
8}

API key

Use the following method to install on EU servers or if API key authentication is required:

1{
2    "mcpServers": {
3        "postman": {
4            "type": "http",
5            "url": "https://mcp.eu.postman.com/minimal", // To use Full mode, use https://mcp.postman.com/mcp. For Code mode, use https://mcp.postman.com/code.
6            "headers": {
7                "Authorization": "Bearer ${input:postman-api-key}"
8            }
9        }
10    },
11    "inputs": [
12        {
13            "id": "postman-api-key",
14            "type": "promptString",
15            "description": "Enter your Postman API key"
16        }
17    ]
18}

By default, this uses Minimal mode. To access Full mode, change the url value to https://mcp.postman.com/mcp. To access Code mode, change the value to https://mcp.postman.com/code.

For more information, see the Copilot CLI documentation.

Local server

The local server is based on STDIO transport and is hosted locally on an environment of your choice. 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. The local server only supports API key authentication (with a Postman API key or Bearer token).

The local server only supports API key authentication (with a Postman API key or Bearer token).

Use cases

Consider using the local Postman MCP server if:

  • You want to power local use cases, such as local API testing.
  • You have specific security and network requirements.
  • You prefer to build the MCP server from the source code in this repo.

Supported configurations

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.

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.

To run the server as a Node application, install Node.js before getting started.

Install in Visual Studio Code

Click the button to install the local Postman MCP Server in VS Code:

Install the local Postman MCP Server in VS Code

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 the --code flag.

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:

1{
2    "servers": {
3        "postman": {
4            "type": "stdio",
5            "command": "npx",
6            "args": [
7                "@postman/postman-mcp-server",
8                "--full", // (optional) Use this flag to enable full mode...
9                "--code", // (optional) ...or this flag to enable code mode.
10                "--region us" // (optional) Use this flag to specify the Postman API region (us or eu). Defaults to us.
11            ],
12            "env": {
13                "POSTMAN_API_KEY": "${input:postman-api-key}"
14            }
15        }
16    },
17    "inputs": [
18        {
19            "id": "postman-api-key",
20            "type": "promptString",
21            "description": "Enter your Postman API key"
22        }
23    ]
24}

Install in Cursor

Click the button to install the local Postman MCP Server in Cursor:

Install the local Postman MCP Server in Cursor

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 the --code flag.

Manual installation

You can manually integrate your MCP server with VS Code to use it with extensions that support MCP. To do so, create a .vscode/mcp.json file in your project and add the following JSON block to it:

1{
2    "servers": {
3        "postman-api-mcp": {
4            "type": "stdio",
5            "command": "npx",
6            "args": [
7                "@postman/postman-mcp-server",
8                "--full" // (optional) Use this flag to enable full mode.
9                "--code" // (optional) Use this flag to enable code mode.
10                "--region us" // (optional) Use this flag to specify the Postman API region (us or eu). Defaults to us.
11            ],
12            "env": {
13                "POSTMAN_API_KEY": "${input:postman-api-key}"
14            }
15        }
16    },
17    "inputs": [
18        {
19            "id": "postman-api-key",
20            "type": "promptString",
21            "description": "Enter your Postman API key"
22        }
23    ]
24}

Claude integration

To integrate the local Postman MCP Server with Claude, check the latest Postman MCP server release and get the .mcpb file:

  • Minimal — postman-api-mcp-minimal.mcpb
  • Code — postman-mcp-server-code.mcpb
  • Full — postman-api-mcp-full.mcpb

For more information, see the Claude 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:

$claude mcp add postman --env POSTMAN_API_KEY=YOUR_KEY -- npx @postman/postman-mcp-server@latest

For Code mode:

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

For Full mode:

$claude mcp add postman --env POSTMAN_API_KEY=YOUR_KEY -- npx @postman/postman-mcp-server@latest --full

Install in Codex

To install the local server, use the API key installation method. Set the POSTMAN_API_KEY environment variable and invoke the MCP server using npx.

For Minimal mode:

$codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --minimal

For Code mode:

$codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --code

For Full mode:

$codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --full

Install in Windsurf

To manually install the MCP server in Windsurf, do the following:

  1. Click Open MCP Marketplace in Windsurf.
  2. Enter “Postman” in the search text box to filter the marketplace results.
  3. Click Install.
  4. When prompted, enter a valid Postman API key.
  5. Select the tools that you want to enable, or click All Tools to select all available tools.
  6. Turn on Enabled to enable the Postman MCP server.

Manual installation

Copy the following JSON config into the .codeium/windsurf/mcp_config.json file:

1{
2    "mcpServers": {
3        "postman": {
4            "args": [
5                "@postman/postman-mcp-server"
6            ],
7            "command": "npx",
8            "disabled": false,
9            "disabledTools": [],
10            "env": {
11                "POSTMAN_API_KEY": "<POSTMAN_API_KEY>"
12            }
13        }
14    }
15}

Install in Antigravity

To install the MCP server in Antigravity, click Manage MCP servers > View raw config. Then, copy the following JSON config into the .codeium/windsurf/mcp_config.json file:

1{
2    "mcpServers": {
3        "postman": {
4            "args": [
5                "@postman/postman-mcp-server"
6            ],
7            "command": "npx",
8            "disabled": false,
9            "disabledTools": [],
10            "env": {
11                "POSTMAN_API_KEY": "XXXX"
12            }
13        }
14    }
15}

Install in GitHub Copilot CLI

Use the Copilot CLI to interactively add the MCP server:

$/mcp add

Manual installation

Copy the following JSON config into the ~/.copilot/mcp-config.json file:

1{
2    "mcpServers": {
3        "postman": {
4            "command": "npx",
5            "args": [
6                "@postman/postman-mcp-server"
7            ],
8            "env": {
9                "POSTMAN_API_KEY": "YOUR_API_KEY"
10            }
11        }
12    }
13}

Use as a Gemini CLI extension

To install the MCP server as a Gemini CLI extension, run the following command in your terminal:

$gemini extensions install https://github.com/postmanlabs/postman-mcp-server

Install in Kiro

To set up the Postman MCP Server with one-click, go to the Kiro Powers and click API Testing with Postman. Then, click Add to Kiro.

Manual installation

To manually install the Postman MCP Server in Kiro, do the following:

  1. Launch the Kiro app, then click the Kiro ghost icon in the left navigation.

  2. Add an MCP Server, then select User Config or Workspace Config to install the Postman MCP Server.

  3. Add the following JSON block to the mcp.json configuration file:

    1{
    2    "mcpServers": {
    3        "postman": {
    4        "command": "npx",
    5            "args": [
    6                "@postman/postman-mcp-server"
    7            ],
    8            "env": {
    9                "POSTMAN_API_KEY": "postman-api-key"
    10            },
    11            "disabled": false,
    12            "autoApprove": [
    13                "getAuthenticatedUser"
    14            ]
    15        }
    16    }
    17}

Install in Docker

To use the Postman MCP Server in Docker, you can use one of the following methods:

  • To install the Postman MCP Server in Docker, see the Postman MCP Server at Docker MCP Hub. Click + Add to Docker Desktop to automatically install it.

  • To run the Postman MCP Server image in Docker, run the following command in your terminal. Docker automatically discovers, downloads, and runs the Postman MCP Server image:

    $docker run -i -e POSTMAN_API_KEY="<your-secret-key>" mcp/postman

  • To build and run the server in Docker manually, run the docker build -t postman-api-mcp-stdio . command. Then, run one of the following commands, replacing $YOUR-POSTMAN-API-KEY with your Postman API key:

    • Minimal - docker run -i -e POSTMAN_API_KEY="<your-secret-key>" postman-api-mcp-stdio
    • Full - docker run -i -e POSTMAN_API_KEY="<your-secret-key>" postman-api-mcp-stdio --full