Skip to content

postmanlabs/postman-mcp-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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.
  • Code — Includes tools to generate high-quality, well-organized client code from public and internal API definitions. This configuration is ideal for users who need to consume APIs or simply get context about APIs to their agents.

For a complete list of the Postman MCP Server's tools, see the Postman MCP Server collection. This collection offers both the remote full and minimal servers, and the local server.

Postman also offers servers as an npm package.

Note: Before getting started, ensure that you have a valid Postman API key.

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 collections.
  • Client code generation - Generate production-ready client code that consumes APIs following best practices and project conventions. The code toolset produces code that precisely matches your API definitions, organizes it into an intuitive tree structure mirroring your Postman collections and requests, and leverages example responses to create accurate response types and error handling.

Designed for developers who want to integrate their AI tools with Postman's context and features. Supports quick natural language 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 and https://mcp.eu.postman.com/minimal for EU users.
  • Code — Includes tools for searching public and internal API definitions and generating client code, available at https://mcp.postman.com/code and https://mcp.eu.postman.com/code for EU users.
  • Full — Includes all available Postman API tools (100+ tools), available at https://mcp.postman.com/mcp and https://mcp.eu.postman.com/mcp for EU users.

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.

By default, the server uses Minimal mode. 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.

Install in Visual Studio Code

Install in VS Code

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

By default, the server uses Minimal mode. 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.

Manual configuration

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 so, add the following JSON block to the .vscode/mcp.json configuration file:

{
    "servers": {
        "postman-api-http-server": {
            "type": "http",
            "url": "https://mcp.postman.com/{minimal OR code OR mcp}",
            // For the EU server, use the "https://mcp.eu.postman.com" URL.
            "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.

Install in Claude Code

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

For Minimal mode:

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

For Code mode:

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

For Full mode:

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

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: To run the server as a Node application, install Node.js.

The local server supports the following tool configurations:

  • Minimal — (Default) Only includes essential tools for basic Postman operations.
  • Code — Includes tools for searching public and internal API definitions and generating client code
  • Full — Includes all available Postman API tools (100+ tools). Use the --full flag to enable this configuration.

Note: 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.

Install in Visual Studio Code

Install with Node in VS Code

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

By default, the server uses Full mode. To access Minimal mode, remove the --full flag from the mcp.json configuration file. To access Code mode, replace the --full flag with --code.

Manual configuration

You can manually integrate your MCP server with Cursor or VS Code to use it with extensions that support MCP. To do this, create a 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...
                "--code", // (optional) ...OR this flag to enable code mode.
                "--region us" // (optional) Use this flag to specify the Postman API region (us or eu). Defaults to us.
            ],
            "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.

By default, the server uses Full mode. To access Minimal mode, remove the --full flag from the mcp.json configuration file. To access Code mode, replace the --full flag with --code.

Claude integration

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

  • Minimal - postman-mcp-server-minimal.mcpb
  • Full - postman-mcp-server-full.mcpb
  • Code - postman-mcp-server-code.mcpb

For more information, see the Claude Desktop Extensions documentation.

Install in Claude Code

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

For Minimal mode:

claude mcp add postman --env POSTMAN_API_KEY=YOUR_KEY -- npx @postman/postman-mcp-server@latest 

For Code mode:

claude mcp add postman --env POSTMAN_API_KEY=YOUR_KEY -- npx @postman/postman-mcp-server@latest  --code

For Full mode:

claude mcp add postman --env POSTMAN_API_KEY=YOUR_KEY -- npx @postman/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

Install in Docker

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


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

Questions and support