Skip to content

postmanlabs/postman-mcp-server

Repository files navigation

Postman MCP Server

The Postman MCP Server connects Postman to AI tools, giving AI agents and assistants the ability to access workspaces, manage collections and environments, evaluate APIs, and automate workflows through natural language interactions.

Postman supports the following tool configurations:

  • Minimal — (Default) Only includes essential tools for basic Postman operations This offers faster performance and simplifies use for those who only need basic Postman operations. Ideal for users who want to modify a single Postman elements, such as collections, workspaces, or environments.
  • Full — Includes all available Postman API tools (100+ tools). This configuration is ideal for users who engage in advanced collaboration and Postman's Enterprise features.

Use Cases

  • Code synchronization - Effortlessly keep your code in sync with your Postman collections and specs.
  • Collection management - Create and tag collections, update collection and request documentation, add comments, or perform actions across multiple collections without leaving your editor.
  • Workspace and environment management - Create workspaces and environments, plus manage your environment variables.
  • Automatic spec creation - Create specs from your code and use them to generate Postman collections.

Designed for developers who want to integrate their AI tools with Postman’s context and features. Supports quick natural language queries queries to advanced agent workflows.

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

Contents


Remote server

The remote Postman MCP Server is hosted by Postman over streamable HTTP and provides the easiest method for getting started. If your MCP host doesn't support remote MCP servers, you can use the local Postman MCP Server.

The remote server supports the following tool configurations:

  • Minimal — (Default) Only includes essential tools for basic Postman operations, available at https://mcp.postman.com/minimal.
  • Full — Includes all available Postman API tools (100+ tools), available at https://mcp.postman.com/mcp.

Note: The remote EU HTTP server is available at https://mcp.eu.postman.com.

Prerequisites

Before getting started, make certain you have a valid Postman API Key.

Install in VS Code

Install in VS Code

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

Note: By default, the server provides 37 tools. Use full mode (https://mcp.postman.com/mcp) to access all 106 tools.

Manual configuration

To manually configure the remote Postman MCP Server in VS Code, add the following JSON block to the .vscode/mcp.json file:

{
    "servers": {
        "postman-api-http-server": {
            "type": "http",
            "url": "https://mcp.postman.com/{minimal | mcp}", // use "minimal" (default) or "mcp" (full)
            "headers": {
                "Authorization": "Bearer ${input:postman-api-key}"
            }
        }
    },
    "inputs": [
        {
            "id": "postman-api-key",
            "type": "promptString",
            "description": "Enter your Postman API key"
        }
    ]
}

When prompted, enter your Postman API key. Afterwards, the agent performs calls to the Postman cloud MCP server at https://mcp.postman.com.

Install in Cursor

Install in Cursor

To install the remote Postman MCP Server in Cursor, click the install button.

Note: Ensure that the Authorization header uses the Bearer <YOUR_API_KEY> format.

Install in Claude Code

To install the MCP server in Claude Code, run the following command in your terminal:

Minimal

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

Full

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

Local server

If remote MCP servers aren't supported by your MCP host, you can install the Postman MCP Server to your local machine.

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.

Note: For Docker set up and installation, see DOCKER.md.

The local server supports the following tool configurations:

  • Minimal — (Default) Only includes essential tools for basic Postman operations.
  • Full — Includes all available Postman API tools (100+ tools). Use the --full flag to enable this configuration.

Prerequisites

Before getting started, you'll need the following:

  1. To run the server as a Node application, install Node.js.
  2. A valid Postman API Key.

Configuration

To configure the extension to use the local Postman MCP Server, do the following:

  1. Clone the postman-mcp-server repository.
  2. In the repository's root folder, run the npm install command. This installs all the required dependencies.
  3. Replace ${workspaceFolder} in the mcp.json file with the full path to the Postman MCP repository.
  4. When prompted, enter your Postman API key.

Install in VS Code

Install with Node in VS Code

To install the local Postman MCP Server in Visual Studio Code, click the install button.

Note:

  • By default, this server provides 37 tools (minimal mode). Use the --full flag to access all 106 tools.
  • 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.

Manual configuration

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

{
    "servers": {
        "postman-api-mcp": {
            "type": "stdio",
            "command": "npx",
            "args": [
                "@postman/postman-mcp-server",
                "--full" // (optional) Use this flag to enable full mode
            ],
            "env": {
                "POSTMAN_API_KEY": "${input:postman-api-key}"
            }
        }
    },
    "inputs": [
        {
            "id": "postman-api-key",
            "type": "promptString",
            "description": "Enter your Postman API key"
        }
    ]
}

Install in Cursor

Install with Node in Cursor

To install the local Postman MCP Server in Cursor, click the install button.

Claude integration

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

  • postman-api-mcp-minimal.mcpb - Contains the 37 essential tools for common Postman operations.
  • postman-api-mcp-full.mcpb - Contains all available Postman tools.

For more information, see Anthropic's Claude Desktop Extensions documentation.

Install in Claude Code

To install the MCP server in Claude Code, run the following command in your terminal:

Minimal

claude mcp add postman -- npx @postman/mcp-server@latest

Full

claude mcp add postman -- npx @postman/mcp-server@latest --full

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

Migration from v1.x to v2.x

If you're migrating from Postman MCP Server version 1.x to 2.x, be aware of the following:

  • Tool naming changes - All tool names changed from kebab-case to camelCase. For example:
    • create-collectioncreateCollection
    • get-workspacesgetWorkspaces
    • delete-environmentdeleteEnvironment
  • Tool availability changes
    • The default (minimal) behavior provides only 37 essential tools.
    • The --full flag provides access to all 106 tools.

Questions and support