Set up a remote Postman MCP server

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

The remote server 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.

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

Before you begin

To use API key authentication (required for EU servers), generate a Postman API key. The US remote server supports OAuth and doesn’t require a key. For an overview of the server, remote versus local, and when to use each configuration, see Use AI agents with the Postman API.

Endpoints

Use the endpoint that matches the tool configuration you want. Each is available in both the US and EU regions:

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 one of the following commands in your terminal:

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

API key

To use the API key installation method, run one of the following commands in your terminal. If you’re using the EU server, you must use the API key installation method. For the EU server, replace mcp.postman.com with mcp.eu.postman.com in the commands below.

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

Cursor

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

If your MCP host supports OAuth, use the https://mcp.postman.com/mcp, https://mcp.postman.com/minimal, or https://mcp.postman.com/code 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.

Visual Studio Code

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

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 one of the following JSON blocks to use the recommended OAuth installation method:

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

Start the server. When prompted, complete the OAuth sign-in flow.

API key

Use one of the following JSON blocks to use the desired API key installation method:

1
{
2
    "servers": {
3
        "postman": {
4
            "type": "http",
5
            "url": "https://mcp.postman.com/minimal",
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
}

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

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.

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

API key

If you’re using the EU server (mcp.eu.postman.com), 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.

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

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"

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, 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
}

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. This configuration uses the remote server, 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
}

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

For more information, see the Copilot CLI documentation.

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"
6
        }
7
    }
8
}

API key

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

1
{
2
    "mcpServers": {
3
        "postman": {
4
            "type": "http",
5
            "url": "https://mcp.eu.postman.com/minimal",
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
}

Gemini CLI

To add the MCP server to your Gemini CLI, run one of the following commands in your terminal:

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

Kiro

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

Minimal	Code	Full

Verify your connection

After installing, restart or reload your MCP host so it picks up the new server. To confirm the connection works, check that your host lists the Postman server and its tools, then ask your agent to perform a simple read-only action, such as “List my Postman workspaces.” If it returns your workspaces, you’re connected.

Next steps

For best practices and tips for getting the most out of the server, see Get the most out of the Postman MCP server.