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

To integrate the remote Postman MCP server with Claude using connectors, follow the setup instructions for the Postman MCP connector for Claude.

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:

Manual installation

To configure the server by hand, add one of the following JSON blocks to your .cursor/mcp.json file.

OAuth

On the US server, omit the headers object entirely and Cursor completes the OAuth flow for you. This is the fastest setup:

1
{
2
    "mcpServers": {
3
        "postman": {
4
            "url": "https://mcp.postman.com/minimal"
5
        }
6
    }
7
}

API key

The EU server requires an API key. Add an Authorization header in Bearer <POSTMAN_API_KEY> format, and replace mcp.postman.com with mcp.eu.postman.com for the EU server:

1
{
2
    "mcpServers": {
3
        "postman": {
4
            "url": "https://mcp.postman.com/minimal",
5
            "headers": { "Authorization": "Bearer <POSTMAN_API_KEY>" }
6
        }
7
    }
8
}

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 CLI

To install the remote server in Codex CLI, 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 --url https://mcp.postman.com/minimal

API key

Use the API key method for the EU server (mcp.eu.postman.com), or whenever you prefer API key authentication to OAuth. Codex CLI reads the key from an environment variable rather than taking it inline, so export it first:

$
export POSTMAN_API_KEY=<POSTMAN_API_KEY>

Then add the remote server with --bearer-token-env-var, naming the variable to read. Replace mcp.postman.com with mcp.eu.postman.com for the EU server:

$
codex mcp add postman --url https://mcp.postman.com/minimal --bearer-token-env-var POSTMAN_API_KEY

To run the server locally instead of connecting to the remote server, invoke the local server with npx. Add --region eu to send local server traffic to the Postman API EU region. Without it, the local server calls the US region regardless of which endpoint you were using before:

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

Manual installation

To configure the remote server by hand, create a ~/.codex/config.toml file and add the following, using the same server name (postman) as the earlier commands:

1
[mcp_servers.postman]
2
url = "https://mcp.postman.com/minimal"
3
bearer_token_env_var = "POSTMAN_API_KEY"

Change the url value to select a different tool configuration, or point it at mcp.eu.postman.com for the EU region. Omit bearer_token_env_var to use OAuth on the US server. If you need to send a header other than Authorization, use the http_headers or env_http_headers keys instead.

To configure the local STDIO server by hand, see Set up a local server.

Antigravity CLI

To install the MCP server in Antigravity CLI, run the following command:

$
agy plugin install https://github.com/postmanlabs/postman-antigravity-cli-extension

The extension connects to the remote server with OAuth using the Minimal tool configuration by default. To switch configurations, run /postman:use-remote with the configuration you want (minimal, code, full, or learn):

$
/postman:use-remote full

For more information, see the Postman Antigravity CLI extension.

API key

If you’re using the EU server (mcp.eu.postman.com) or prefer API key authentication, edit the mcp_config.json file in the installed extension directory and add an Authorization header to the server entry. Note that this file uses serverUrl rather than url:

1
{
2
    "mcpServers": {
3
        "postman": {
4
            "serverUrl": "https://mcp.postman.com/minimal",
5
            "headers": {
6
                "Authorization": "Bearer <POSTMAN_API_KEY>"
7
            }
8
        }
9
    }
10
}

Change the serverUrl path to select a different tool configuration: /minimal, /code, /mcp (Full), or /learn.

GitHub Copilot CLI

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

To add it interactively, start copilot and enter the following, then fill out the form:

$
/mcp add

To add it non-interactively, run one of the following commands in your terminal. On the US server, Copilot CLI completes the OAuth flow for you:

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

To use an API key instead, which is required for the EU server, add the --header flag:

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

For more information, see the Copilot CLI documentation.

Manual installation

Copy one of the following JSON configurations into the ~/.copilot/mcp-config.json file. The tools field enables the server’s tools for the agent:

1
{
2
    "mcpServers": {
3
        "postman": {
4
            "type": "http",
5
            "url": "https://mcp.postman.com/minimal",
6
            "tools": [
7
                "*"
8
            ]
9
        }
10
    }
11
}

API key

The EU server requires an API key. Add an Authorization header in Bearer <POSTMAN_API_KEY> format, and replace mcp.postman.com with mcp.eu.postman.com for the EU server:

1
{
2
    "mcpServers": {
3
        "postman": {
4
            "type": "http",
5
            "url": "https://mcp.postman.com/minimal",
6
            "headers": {
7
                "Authorization": "Bearer <POSTMAN_API_KEY>"
8
            },
9
            "tools": [
10
                "*"
11
            ]
12
        }
13
    }
14
}

Kiro

To install the remote Postman MCP server in Kiro, click the install button for the tool configuration that you want to use:

Minimal	Code	Full	Learn

Manual installation

To configure the server by hand, add the following to Kiro’s mcp.json file. On the US server, omit the headers object and Kiro completes the OAuth flow for you:

1
{
2
    "mcpServers": {
3
        "postman": {
4
            "url": "https://mcp.postman.com/minimal",
5
            "disabled": false,
6
            "autoApprove": []
7
        }
8
    }
9
}

Change the url path to select a different tool configuration: /minimal, /code, /mcp (Full), or /learn.

API key

The EU server requires an API key. Add an Authorization header in Bearer <POSTMAN_API_KEY> format, and replace mcp.postman.com with mcp.eu.postman.com for the EU server:

1
{
2
    "mcpServers": {
3
        "postman": {
4
            "url": "https://mcp.postman.com/minimal",
5
            "headers": { "Authorization": "Bearer <POSTMAN_API_KEY>" },
6
            "disabled": false,
7
            "autoApprove": []
8
        }
9
    }
10
}

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.

Telemetry

Remote servers gather telemetry data anonymously to help Postman improve the MCP server.

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.