ReferencePostman API referencePostman MCP Server

Set up a local Postman MCP server

View as Markdown

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).

Before you begin

Local servers only support API key authentication, so you’ll need to generate a Postman API key. For an overview of the server, remote versus local, and when to use each configuration, see Use AI agents with the Postman API.

Supported configurations

The local server supports the same tool configurations as the remote server—Minimal (default), Code, and Full—selected with a command-line flag. It also supports a local-only option:

  • Quiet — Suppresses debug and info logs in stderr and returns only warn and error. Required for Windsurf users on Windows, where it avoids a stderr pipe buffer deadlock that causes the MCP initialize request to time out. Enable it alongside the Minimal, Code, or Full 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.

Claude Code

To install the MCP server in Claude Code, run one of the following commands in your terminal:

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

Cursor

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

Install the local Postman MCP server in Cursor

Manual installation

To manually integrate your MCP server with Cursor and VS Code, create a .vscode/mcp.json file in your project and add one of the following JSON blocks to it. You can optionally include the --region flag to specify the Postman API region (us or eu). Defaults to us (in the args array, specify it as "--region", "eu").

1{
2    "servers": {
3        "postman-api-mcp": {
4            "type": "stdio",
5            "command": "npx",
6            "args": [
7                "@postman/postman-mcp-server"
8            ],
9            "env": {
10                "POSTMAN_API_KEY": "${input:postman-api-key}"
11            }
12        }
13    },
14    "inputs": [
15        {
16            "id": "postman-api-key",
17            "type": "promptString",
18            "description": "Enter your Postman API key"
19        }
20    ]
21}

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

Manual configuration

You can manually integrate your MCP server with VS Code to use it with extensions that support MCP. Add the optional --region flag to specify the Postman API region (us or eu). Defaults to us (in the args array, specify it as "--region", "eu").

To create a manual configuration, create a mcp.json file in your project and add one of the following JSON blocks to it:

1{
2    "servers": {
3        "postman": {
4            "type": "stdio",
5            "command": "npx",
6            "args": [
7                "@postman/postman-mcp-server"
8            ],
9            "env": {
10                "POSTMAN_API_KEY": "${input:postman-api-key}"
11            }
12        }
13    },
14    "inputs": [
15        {
16            "id": "postman-api-key",
17            "type": "promptString",
18            "description": "Enter your Postman API key"
19        }
20    ]
21}

Claude

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.

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.

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

Windsurf

To 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.

Windows users on Windsurf can encounter a startup timeout because too many startup logs fill the stderr buffer, which blocks the server before MCP initialization completes. Using the --quiet configuration suppresses those logs and avoids the issue.

Manual installation

Copy the following JSON config into the .codeium/windsurf/mcp_config.json file (to use --quiet with Code or Full, include it alongside --code or --full in the args array).

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}

Antigravity

To install the MCP server in Antigravity, click Manage MCP servers > View raw config. Then, copy the following JSON config into the 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}

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": "<POSTMAN_API_KEY>"
10            }
11        }
12    }
13}

Gemini CLI

To install the MCP server directly in the Gemini CLI, run one of the following commands in your terminal.

$gemini mcp add postman npx -- -y @postman/postman-mcp-server --env POSTMAN_API_KEY=<POSTMAN_API_KEY>

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

Kiro

To install the local Postman MCP Server in Kiro, click the install button for the version that you want to use:

MinimalCodeFull
Add Postman MCP Minimal server to Kiro Add Postman MCP Code server to Kiro Add Postman MCP Full server to Kiro

To install the Postman MCP server with Kiro powers, go to Kiro Powers and navigate to API Testing with Postman in the Browse powers section. Then, click Add to Kiro.

Manual installation

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

  1. Launch Kiro and click the Kiro ghost icon in the left sidebar.

  2. Add an MCP Server and select either 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        }
    14    }
    15}

Docker

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="<POSTMAN_API_KEY>" mcp/postman

Manual installation

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:

$docker run -i -e POSTMAN_API_KEY="<POSTMAN_API_KEY>" postman-api-mcp-stdio