> This page is for Postman Docs, version Latest (v12) (default).
> For other versions, use one of these documentation indexes:
> - Latest (v12) (default): https://learning.postman.com/latest-v-12/llms.txt
> - v11: https://learning.postman.com/v11/llms.txt

> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://learning.postman.com/llms.txt.

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

Use the region toggle to view endpoints, commands, and configuration for your Postman region.

The US 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 US remote server also accepts a Postman API key (Bearer token in the Authorization header).

The EU remote server only supports API key authentication. Pass your Postman API key as a Bearer token in the `Authorization` header.

### Before you begin

The US remote server supports OAuth and doesn't require a key. To use API key authentication instead, generate a [Postman API key](https://go.postman.co/settings/me/api-keys).

Generate a [Postman API key](https://go.postman.co/settings/me/api-keys) before starting.

For an overview of the server, remote versus local, and when to use each configuration, see [Postman MCP server overview](/docs/reference/postman-api/postman-mcp-server/overview/).

### Endpoints

Use the endpoint that matches the [tool configuration](/docs/reference/postman-api/postman-mcp-server/overview#tool-configurations) you want:

| Configuration     | US endpoint                             |
| ----------------- | --------------------------------------- |
| Minimal (default) | `https://mcp.postman.com/minimal`       |
| Code              | `https://mcp.postman.com/code`          |
| Full              | `https://mcp.postman.com/mcp`           |
| Learn             | `https://mcp.postman.com/learn`         |
| Context Graph     | `https://mcp.postman.com/context-graph` |

| Configuration     | EU endpoint                                |
| ----------------- | ------------------------------------------ |
| Minimal (default) | `https://mcp.eu.postman.com/minimal`       |
| Code              | `https://mcp.eu.postman.com/code`          |
| Full              | `https://mcp.eu.postman.com/mcp`           |
| Learn             | `https://mcp.eu.postman.com/learn`         |
| Context Graph     | `https://mcp.eu.postman.com/context-graph` |

## Claude

To integrate the remote Postman MCP server with Claude using connectors, follow the setup instructions for the [Postman MCP connector for Claude](https://claude.com/connectors/postman).

## Claude Code

Claude Code automatically uses OAuth for the best installation experience. To use an API key instead, add the `--header` flag.

### OAuth

Run one of the following commands in your terminal:

#### Minimal

```bash wordWrap
claude mcp add --transport http postman https://mcp.postman.com/minimal
```

#### Code

```bash wordWrap
claude mcp add --transport http postman https://mcp.postman.com/code
```

#### Full

```bash wordWrap
claude mcp add --transport http postman https://mcp.postman.com/mcp
```

#### Learn

```bash wordWrap
claude mcp add --transport http postman https://mcp.postman.com/learn
```

#### Context Graph

```bash wordWrap
claude mcp add --transport http postman https://mcp.postman.com/context-graph
```

### API key

Run one of the following commands in your terminal:

#### Minimal

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

#### Code

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

#### Full

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

#### Learn

```bash wordWrap
claude mcp add --transport http postman https://mcp.postman.com/learn --header "Authorization: Bearer <POSTMAN_API_KEY>"
```

#### Context Graph

```bash wordWrap
claude mcp add --transport http postman https://mcp.postman.com/context-graph --header "Authorization: Bearer <POSTMAN_API_KEY>"
```

Pass your Postman API key as a Bearer token using the `--header` flag:

#### Minimal

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

#### Code

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

#### Full

```bash wordWrap
claude mcp add --transport http postman https://mcp.eu.postman.com/mcp --header "Authorization: Bearer <POSTMAN_API_KEY>"
```

#### Learn

```bash wordWrap
claude mcp add --transport http postman https://mcp.eu.postman.com/learn --header "Authorization: Bearer <POSTMAN_API_KEY>"
```

#### Context Graph

```bash wordWrap
claude mcp add --transport http postman https://mcp.eu.postman.com/context-graph --header "Authorization: Bearer <POSTMAN_API_KEY>"
```

## Cursor

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

[![Install the remote Postman MCP server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=postman_mcp_server\&config=eyJ1cmwiOiJodHRwczovL21jcC5wb3N0bWFuLmNvbS9taW5pbWFsIiwiaGVhZGVycyI6eyJBdXRob3JpemF0aW9uIjoiQmVhcmVyIFlPVVJfQVBJX0tFWSJ9fQ%3D%3D)

### Manual installation

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

#### OAuth

Omit the `headers` object entirely and Cursor completes the OAuth flow for you. This is the fastest setup:

#### Minimal

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.postman.com/minimal"
        }
    }
}
```

#### Code

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.postman.com/code"
        }
    }
}
```

#### Full

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.postman.com/mcp"
        }
    }
}
```

#### Learn

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.postman.com/learn"
        }
    }
}
```

#### Context Graph

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.postman.com/context-graph"
        }
    }
}
```

#### API key

To use API key authentication, add an `Authorization` header in `Bearer <POSTMAN_API_KEY>` format:

#### Minimal

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.postman.com/minimal",
            "headers": { "Authorization": "Bearer <POSTMAN_API_KEY>" }
        }
    }
}
```

#### Code

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.postman.com/code",
            "headers": { "Authorization": "Bearer <POSTMAN_API_KEY>" }
        }
    }
}
```

#### Full

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.postman.com/mcp",
            "headers": { "Authorization": "Bearer <POSTMAN_API_KEY>" }
        }
    }
}
```

#### Learn

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.postman.com/learn",
            "headers": { "Authorization": "Bearer <POSTMAN_API_KEY>" }
        }
    }
}
```

#### Context Graph

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.postman.com/context-graph",
            "headers": { "Authorization": "Bearer <POSTMAN_API_KEY>" }
        }
    }
}
```

The Cursor one-click install button is configured for the US region. To configure the server for the EU region, use the manual installation instructions below.

### Manual installation

Add one of the following JSON blocks to your `.cursor/mcp.json` file, using an `Authorization` header in `Bearer <POSTMAN_API_KEY>` format:

#### Minimal

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.eu.postman.com/minimal",
            "headers": { "Authorization": "Bearer <POSTMAN_API_KEY>" }
        }
    }
}
```

#### Code

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.eu.postman.com/code",
            "headers": { "Authorization": "Bearer <POSTMAN_API_KEY>" }
        }
    }
}
```

#### Full

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.eu.postman.com/mcp",
            "headers": { "Authorization": "Bearer <POSTMAN_API_KEY>" }
        }
    }
}
```

#### Learn

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.eu.postman.com/learn",
            "headers": { "Authorization": "Bearer <POSTMAN_API_KEY>" }
        }
    }
}
```

#### Context Graph

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.eu.postman.com/context-graph",
            "headers": { "Authorization": "Bearer <POSTMAN_API_KEY>" }
        }
    }
}
```

## Visual Studio Code

To install the remote Postman MCP server in VS Code, click the install button or use the [Postman VS Code Extension](/docs/reference/vs-code-extension/postman-mcp-server/):

[![Install the remote Postman MCP server in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square\&logo=visualstudiocode\&logoColor=white)](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 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.

#### OAuth

Add one of the following JSON blocks to the `.vscode/mcp.json` configuration file:

#### Minimal

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/minimal"
        }
    }
}
```

#### Code

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/code"
        }
    }
}
```

#### Full

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/mcp"
        }
    }
}
```

#### Learn

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/learn"
        }
    }
}
```

#### Context Graph

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/context-graph"
        }
    }
}
```

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

#### API key

Use one of the following JSON blocks in the `.vscode/mcp.json` configuration file:

#### Minimal

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/minimal",
            "headers": {
                "Authorization": "Bearer ${input:postman-api-key}"
            }
        }
    },
    "inputs": [
        {
            "id": "postman-api-key",
            "type": "promptString",
            "description": "Enter your Postman API key"
        }
    ]
}
```

#### Code

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/code",
            "headers": {
                "Authorization": "Bearer ${input:postman-api-key}"
            }
        }
    },
    "inputs": [
        {
            "id": "postman-api-key",
            "type": "promptString",
            "description": "Enter your Postman API key"
        }
    ]
}
```

#### Full

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/mcp",
            "headers": {
                "Authorization": "Bearer ${input:postman-api-key}"
            }
        }
    },
    "inputs": [
        {
            "id": "postman-api-key",
            "type": "promptString",
            "description": "Enter your Postman API key"
        }
    ]
}
```

#### Learn

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/learn",
            "headers": {
                "Authorization": "Bearer ${input:postman-api-key}"
            }
        }
    },
    "inputs": [
        {
            "id": "postman-api-key",
            "type": "promptString",
            "description": "Enter your Postman API key"
        }
    ]
}
```

#### Context Graph

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/context-graph",
            "headers": {
                "Authorization": "Bearer ${input:postman-api-key}"
            }
        }
    },
    "inputs": [
        {
            "id": "postman-api-key",
            "type": "promptString",
            "description": "Enter your Postman API key"
        }
    ]
}
```

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

The VS Code one-click install button is configured for the US region. To configure the server for the EU region, use the manual installation instructions below.

### Manual installation

Add one of the following JSON blocks to the `.vscode/mcp.json` configuration file, using an `Authorization` header in `Bearer <POSTMAN_API_KEY>` format:

#### Minimal

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.eu.postman.com/minimal",
            "headers": {
                "Authorization": "Bearer ${input:postman-api-key}"
            }
        }
    },
    "inputs": [
        {
            "id": "postman-api-key",
            "type": "promptString",
            "description": "Enter your Postman API key"
        }
    ]
}
```

#### Code

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.eu.postman.com/code",
            "headers": {
                "Authorization": "Bearer ${input:postman-api-key}"
            }
        }
    },
    "inputs": [
        {
            "id": "postman-api-key",
            "type": "promptString",
            "description": "Enter your Postman API key"
        }
    ]
}
```

#### Full

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.eu.postman.com/mcp",
            "headers": {
                "Authorization": "Bearer ${input:postman-api-key}"
            }
        }
    },
    "inputs": [
        {
            "id": "postman-api-key",
            "type": "promptString",
            "description": "Enter your Postman API key"
        }
    ]
}
```

#### Learn

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.eu.postman.com/learn",
            "headers": {
                "Authorization": "Bearer ${input:postman-api-key}"
            }
        }
    },
    "inputs": [
        {
            "id": "postman-api-key",
            "type": "promptString",
            "description": "Enter your Postman API key"
        }
    ]
}
```

#### Context Graph

```json wordWrap
{
    "servers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.eu.postman.com/context-graph",
            "headers": {
                "Authorization": "Bearer ${input:postman-api-key}"
            }
        }
    },
    "inputs": [
        {
            "id": "postman-api-key",
            "type": "promptString",
            "description": "Enter your Postman API key"
        }
    ]
}
```

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

## Codex CLI

> **Info**
>
> Streamable HTTP support was experimental in older Codex CLI releases. If `codex mcp add --url` isn't recognized, or the server is added but never connects, update Codex CLI. On releases that only pick up STDIO servers, add `experimental_use_rmcp_client = true` to `~/.codex/config.toml` instead of updating.

### OAuth

Use OAuth for the best installation experience. It requires no manual API key setup:

#### Minimal

```bash wordWrap
codex mcp add postman --url https://mcp.postman.com/minimal
```

#### Code

```bash wordWrap
codex mcp add postman --url https://mcp.postman.com/code
```

#### Full

```bash wordWrap
codex mcp add postman --url https://mcp.postman.com/mcp
```

#### Learn

```bash wordWrap
codex mcp add postman --url https://mcp.postman.com/learn
```

#### Context Graph

```bash wordWrap
codex mcp add postman --url https://mcp.postman.com/context-graph
```

### API key

Codex CLI reads the key from an environment variable rather than taking it inline, so export it first:

```bash wordWrap
export POSTMAN_API_KEY=<POSTMAN_API_KEY>
```

Then add the remote server with `--bearer-token-env-var`, naming the variable to read:

#### Minimal

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

#### Code

```bash wordWrap
codex mcp add postman --url https://mcp.postman.com/code --bearer-token-env-var POSTMAN_API_KEY
```

#### Full

```bash wordWrap
codex mcp add postman --url https://mcp.postman.com/mcp --bearer-token-env-var POSTMAN_API_KEY
```

#### Learn

```bash wordWrap
codex mcp add postman --url https://mcp.postman.com/learn --bearer-token-env-var POSTMAN_API_KEY
```

#### Context Graph

```bash wordWrap
codex mcp add postman --url https://mcp.postman.com/context-graph --bearer-token-env-var POSTMAN_API_KEY
```

Codex CLI reads the API key from an environment variable rather than taking it inline, so export it first:

```bash wordWrap
export POSTMAN_API_KEY=<POSTMAN_API_KEY>
```

Then add the remote server with `--bearer-token-env-var`, naming the variable to read:

#### Minimal

```bash wordWrap
codex mcp add postman --url https://mcp.eu.postman.com/minimal --bearer-token-env-var POSTMAN_API_KEY
```

#### Code

```bash wordWrap
codex mcp add postman --url https://mcp.eu.postman.com/code --bearer-token-env-var POSTMAN_API_KEY
```

#### Full

```bash wordWrap
codex mcp add postman --url https://mcp.eu.postman.com/mcp --bearer-token-env-var POSTMAN_API_KEY
```

#### Learn

```bash wordWrap
codex mcp add postman --url https://mcp.eu.postman.com/learn --bearer-token-env-var POSTMAN_API_KEY
```

#### Context Graph

```bash wordWrap
codex mcp add postman --url https://mcp.eu.postman.com/context-graph --bearer-token-env-var POSTMAN_API_KEY
```

To run the server locally instead of connecting to the remote server, invoke the [local server](/docs/reference/postman-api/postman-mcp-server/postman-mcp-local-server#codex-cli) with `npx`:

#### Minimal

```bash wordWrap
codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server
```

#### Code

```bash wordWrap
codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --code
```

#### Full

```bash wordWrap
codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --full
```

#### Learn

```bash wordWrap
codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --learn
```

#### Context Graph

```bash wordWrap
codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --context-graph
```

#### Minimal

```bash wordWrap
codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --region eu
```

#### Code

```bash wordWrap
codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --region eu --code
```

#### Full

```bash wordWrap
codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --region eu --full
```

#### Learn

```bash wordWrap
codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --region eu --learn
```

#### Context Graph

```bash wordWrap
codex mcp add postman --env POSTMAN_API_KEY=<POSTMAN_API_KEY> -- npx @postman/postman-mcp-server --region eu --context-graph
```

### 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:

```toml wordWrap
[mcp_servers.postman]
url = "https://mcp.postman.com/minimal"
bearer_token_env_var = "POSTMAN_API_KEY"
```

Change the `url` value to select a different [tool configuration](/docs/reference/postman-api/postman-mcp-server/overview#tool-configurations). Omit `bearer_token_env_var` to use OAuth. If you need to send a header other than `Authorization`, use the `http_headers` or `env_http_headers` keys instead.

```toml wordWrap
[mcp_servers.postman]
url = "https://mcp.eu.postman.com/minimal"
bearer_token_env_var = "POSTMAN_API_KEY"
```

Change the `url` value to select a different [tool configuration](/docs/reference/postman-api/postman-mcp-server/overview#tool-configurations). 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](/docs/reference/postman-api/postman-mcp-server/postman-mcp-local-server#codex-cli).

## Antigravity CLI

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

```bash wordWrap
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](/docs/reference/postman-api/postman-mcp-server/overview#tool-configurations) by default. To switch configurations, run `/postman:use-remote` with the `minimal`, `code`, `full`, or `learn` configuration:

```bash wordWrap
/postman:use-remote full
```

For more information, see the [Postman Antigravity CLI extension](https://github.com/postmanlabs/postman-antigravity-cli-extension).

### API key

If you prefer API key authentication to OAuth, 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`:

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "serverUrl": "https://mcp.postman.com/minimal",
            "headers": {
                "Authorization": "Bearer <POSTMAN_API_KEY>"
            }
        }
    }
}
```

Change the `serverUrl` path to use a different tool configuration: `/minimal`, `/code`, `/mcp` (Full), `/learn`, or `/context-graph`.

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`:

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "serverUrl": "https://mcp.eu.postman.com/minimal",
            "headers": {
                "Authorization": "Bearer <POSTMAN_API_KEY>"
            }
        }
    }
}
```

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

For more information, see the [Postman Antigravity CLI extension](https://github.com/postmanlabs/postman-antigravity-cli-extension).

## GitHub Copilot CLI

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

Add the MCP server to Copilot CLI using API key authentication.

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

```bash wordWrap
/mcp add
```

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

#### Minimal

```bash wordWrap
copilot mcp add --transport http postman https://mcp.postman.com/minimal
```

#### Code

```bash wordWrap
copilot mcp add --transport http postman https://mcp.postman.com/code
```

#### Full

```bash wordWrap
copilot mcp add --transport http postman https://mcp.postman.com/mcp
```

#### Learn

```bash wordWrap
copilot mcp add --transport http postman https://mcp.postman.com/learn
```

#### Context Graph

```bash wordWrap
copilot mcp add --transport http postman https://mcp.postman.com/context-graph
```

To use an API key instead, add the `--header` flag:

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

To add it non-interactively, run the following command in your terminal:

```bash wordWrap
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](https://docs.github.com/en/copilot/concepts/agents/about-copilot-cli).

### 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:

#### Minimal

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/minimal",
            "tools": [
                "*"
            ]
        }
    }
}
```

#### Code

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/code",
            "tools": [
                "*"
            ]
        }
    }
}
```

#### Full

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/mcp",
            "tools": [
                "*"
            ]
        }
    }
}
```

#### Learn

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/learn",
            "tools": [
                "*"
            ]
        }
    }
}
```

#### Context Graph

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/context-graph",
            "tools": [
                "*"
            ]
        }
    }
}
```

#### API key

To use API key authentication, add an `Authorization` header in `Bearer <POSTMAN_API_KEY>` format:

#### Minimal

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/minimal",
            "headers": {
                "Authorization": "Bearer <POSTMAN_API_KEY>"
            },
            "tools": [
                "*"
            ]
        }
    }
}
```

#### Code

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/code",
            "headers": {
                "Authorization": "Bearer <POSTMAN_API_KEY>"
            },
            "tools": [
                "*"
            ]
        }
    }
}
```

#### Full

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/mcp",
            "headers": {
                "Authorization": "Bearer <POSTMAN_API_KEY>"
            },
            "tools": [
                "*"
            ]
        }
    }
}
```

#### Learn

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/learn",
            "headers": {
                "Authorization": "Bearer <POSTMAN_API_KEY>"
            },
            "tools": [
                "*"
            ]
        }
    }
}
```

#### Context Graph

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.postman.com/context-graph",
            "headers": {
                "Authorization": "Bearer <POSTMAN_API_KEY>"
            },
            "tools": [
                "*"
            ]
        }
    }
}
```

Add an `Authorization` header in `Bearer <POSTMAN_API_KEY>` format:

#### Minimal

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.eu.postman.com/minimal",
            "headers": {
                "Authorization": "Bearer <POSTMAN_API_KEY>"
            },
            "tools": [
                "*"
            ]
        }
    }
}
```

#### Code

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.eu.postman.com/code",
            "headers": {
                "Authorization": "Bearer <POSTMAN_API_KEY>"
            },
            "tools": [
                "*"
            ]
        }
    }
}
```

#### Full

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.eu.postman.com/mcp",
            "headers": {
                "Authorization": "Bearer <POSTMAN_API_KEY>"
            },
            "tools": [
                "*"
            ]
        }
    }
}
```

#### Learn

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.eu.postman.com/learn",
            "headers": {
                "Authorization": "Bearer <POSTMAN_API_KEY>"
            },
            "tools": [
                "*"
            ]
        }
    }
}
```

#### Context Graph

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "type": "http",
            "url": "https://mcp.eu.postman.com/context-graph",
            "headers": {
                "Authorization": "Bearer <POSTMAN_API_KEY>"
            },
            "tools": [
                "*"
            ]
        }
    }
}
```

> **Warning**
>
> Copilot CLI's `mcp-config.json` doesn't support the `${input:...}` placeholders or the `inputs` array used by `.vscode/mcp.json`. It stores the value you enter verbatim. Keep your API key out of shared or committed files.

## 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**                                                                                                                                                                                                                                                               | **Context Graph**                                                                                                                                                                                                                                                                       |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [![Add Postman MCP Minimal server to Kiro](https://kiro.dev/images/add-to-kiro.svg)](https://kiro.dev/launch/mcp/add?name=postman-mcp-server\&config=%7B%22url%22%3A%22https%3A%2F%2Fmcp.postman.com%2Fminimal%22%2C%22disabled%22%3Afalse%2C%22autoApprove%22%3A%5B%5D%7D) | [![Add Postman MCP Code server to Kiro](https://kiro.dev/images/add-to-kiro.svg)](https://kiro.dev/launch/mcp/add?name=postman-mcp-server\&config=%7B%22url%22%3A%22https%3A%2F%2Fmcp.postman.com%2Fcode%22%2C%22disabled%22%3Afalse%2C%22autoApprove%22%3A%5B%5D%7D) | [![Add Postman MCP Full server to Kiro](https://kiro.dev/images/add-to-kiro.svg)](https://kiro.dev/launch/mcp/add?name=postman-mcp-server\&config=%7B%22url%22%3A%22https%3A%2F%2Fmcp.postman.com%2Fmcp%22%2C%22disabled%22%3Afalse%2C%22autoApprove%22%3A%5B%5D%7D) | [![Add Postman MCP Learn server to Kiro](https://kiro.dev/images/add-to-kiro.svg)](https://kiro.dev/launch/mcp/add?name=postman-mcp-server\&config=%7B%22url%22%3A%22https%3A%2F%2Fmcp.postman.com%2Flearn%22%2C%22disabled%22%3Afalse%2C%22autoApprove%22%3A%5B%5D%7D) | [![Add Postman MCP Context Graph server to Kiro](https://kiro.dev/images/add-to-kiro.svg)](https://kiro.dev/launch/mcp/add?name=postman-mcp-server\&config=%7B%22url%22%3A%22https%3A%2F%2Fmcp.postman.com%2Fcontext-graph%22%2C%22disabled%22%3Afalse%2C%22autoApprove%22%3A%5B%5D%7D) |

### Manual installation

To configure the server by hand, add the following to Kiro's `mcp.json` file. Omit the `headers` object and Kiro completes the OAuth flow for you:

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.postman.com/minimal",
            "disabled": false,
            "autoApprove": []
        }
    }
}
```

Change the `url` path to select a different [tool configuration](/docs/reference/postman-api/postman-mcp-server/overview#tool-configurations): `/minimal`, `/code`, `/mcp` (Full), `/learn`, or `/context-graph`.

#### API key

To use API key authentication, add an `Authorization` header in `Bearer <POSTMAN_API_KEY>` format:

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.postman.com/minimal",
            "headers": { "Authorization": "Bearer <POSTMAN_API_KEY>" },
            "disabled": false,
            "autoApprove": []
        }
    }
}
```

The Kiro one-click install buttons are configured for the US region. To configure the server for the EU region, use the manual installation instructions below.

### Manual installation

Add the following to Kiro's `mcp.json` file, using an `Authorization` header in `Bearer <POSTMAN_API_KEY>` format:

```json wordWrap
{
    "mcpServers": {
        "postman": {
            "url": "https://mcp.eu.postman.com/minimal",
            "headers": { "Authorization": "Bearer <POSTMAN_API_KEY>" },
            "disabled": false,
            "autoApprove": []
        }
    }
}
```

Change the `url` path to select a different [tool configuration](/docs/reference/postman-api/postman-mcp-server/overview#tool-configurations): `/minimal`, `/code`, `/mcp` (Full), `/learn`, or `/context-graph`.

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

> **Note**
>
> Product telemetry is enabled by default for the remote Postman MCP server and turned off by default for the [local Postman MCP server](/docs/reference/postman-api/postman-mcp-server/postman-mcp-local-server#telemetry).

## 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](/docs/reference/postman-api/postman-mcp-server/postman-mcp-server-tips/).