Postman Official

Frequently asked questions

What does the Postman MCP server do?

Postman MCP Server The Postman MCP Server implements the Model Context Protocol (MCP) to connect AI agents and coding assistants — including Claude Code, Cursor, VS Code Copilot, GitHub Copilot CLI, and Gemini CLI — directly to your Postman workspaces, collections, specifications, and environments. Postman also offers the server as an npm package. For the full installation guide with agent-specific setup, see Postman's MCP Server product page. --- Postman MCP Server collection The Postman MCP Server collection is the quickest way to explore, test, and connect to the Postman MCP Server. Use it to: Browse the complete list of available tools across all configurations. Connect to and test the remote server — Full and Minimal. Connect to and test the local server. --- Tool configurations Minimal — (Default) Only includes essential tools for basic Postman operations. Ideal for users who want to modify a single Postman element, such as collections, workspaces, or environments. Code — Includes tools to generate high-quality, well-organized client code from public and internal API definitions. Ideal for users who need to consume APIs or get API context to their agents. Full — Includes all available Postman API tools (100+ tools). Ideal for users who engage in advanced collaboration and Postman's Enterprise features. Learn — Searches Postman Docs for guides, tutorials, and reference content. Ideal for agents who need to discover Postman features, look up API concepts, or find learning resources. --- Authentication For the best developer experience and fastest setup, use OAuth on the remote server ( OAuth is fully compliant with the MCP Authorization specification and requires no manual API key configuration. The EU remote server and the local server support only Postman API key authentication. --- Quick start Remote (any OAuth-compatible MCP host): Add this URL to your MCP host's configuration: Change /minimal to /code or /mcp for Code or Full mode. For EU or API key auth, pass Authorization: Bearer API KEY> as a header. Local: Add --code or --full for Code or Full mode. Set POSTMAN API KEY as an environment variable. For IDE-specific setup instructions, see the following table. For more information, see the Postman MCP Server docs. --- Supported agents and IDEs Agent / IDE Remote Local --- --- --- Claude Code Docs Docs Claude Desktop Docs Docs Cursor Docs Docs VS Code Docs Docs Codex Docs Docs Antigravity CLI Docs Docs GitHub Copilot CLI Docs Docs Kiro Docs Docs Docker — Docs --- EU support The Postman MCP Server supports the EU region for remote and local servers: For streamable HTTP, the remote server is available at (Full), and For the STDIO public package, use the --region eu flag, or set the POSTMAN API BASE URL environment variable directly. OAuth isn't supported for the EU server. The EU remote server only supports API key authentication. --- Use cases API Testing — Continuously test your API using your Postman collection. Use the local server to test local APIs, as the remote server won't have network access to your workstation. Code synchronization — Keep your code in sync with your Postman Collections and specs. Collection management — Create and tag collections, update documentation, add comments, or perform actions across multiple collections without leaving your editor. Workspace and environment management — Create workspaces and environments, plus manage 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. --- Docker For Docker setup and installation, see DOCKER.md. --- Contributing Bug reports, tool requests, and documentation fixes are all welcome — see CONTRIBUTING.md. Report a bug Request a tool, or a change to one Report a documentation issue The MCP tool definitions and the server implementation here are synced from Postman's internal source of truth, so changes to files under src/ can't be merged in this repository — but issues are how those changes get made, and we credit contributions that ship. Documentation and repository tooling accept pull requests directly. Found a security issue? See SECURITY.md — please don't open a public issue. --- Questions and support See Add your MCP requests to your collections to learn how to use Postman to perform MCP requests. Visit the Postman Community to share what you've built, ask questions, and get help. You can connect to both the remote and local servers and test them using the Postman MCP Server collection. Report bugs and request tools in GitHub Issues. See SUPPORT.md for which channel fits your question. --- Keywords Model Context Protocol · MCP Server · Postman · AI Agents · Claude Code · Cursor · VS Code · Specifications · REST API · API Testing · TypeScript · OpenAPI

How do I install Postman?

Run the install command shown above, then paste the config for your client (Claude Desktop, Claude Code, Cursor, VS Code or Windsurf) into its MCP settings and restart the client.

Is Postman free to use?

The MCP server itself is free to install. The source is public on https://github.com/postmanlabs/postman-mcp-server. Any third-party service it calls may require its own API key and account.

Which clients support Postman?

Any MCP-compatible client can use it, including Claude Desktop, Claude Code, Cursor, VS Code, Windsurf and custom agents.