postman-mcp-server

# Postman MCP Server > Skill by [ara.so](https://ara.so) — MCP Skills collection. The Postman MCP Server connects AI tools to Postman, enabling agents to access workspaces, manage collections and environments, evaluate APIs, and automate workflows through natural language. It supports three configurations: **Minimal** (essential operations), **Full** (100+ tools), and **Code** (API definition search and client code generation). ## Installation ### Remote Server (Recommended) The remote server is hosted by Postman and requires no local setup. It supports OAuth (US region) or API key authentication. **US Server**: `https://mcp.postman.com` **EU Server**: `https://mcp.eu.postman.com` (API key only) #### Claude Code Installation **OAuth (US only):** ```bash # Minimal (default) claude mcp add --transport http postman https://mcp.postman.com/minimal # Code generation claude mcp add --transport http postman https://mcp.postman.com/code # Full (100+ tools) claude mcp add --transport http postman https://mcp.postman.com/mcp ``` **API Key (required for EU):** ```bash claude mcp add --transport http postman https://mcp.postman.com/minimal \ --header "Authorization: Bearer ${POSTMAN_API_KEY}" ``` #### VS Code Installation Add to `.vscode/mcp.json`: **OAuth:** ```json { "servers": { "postman": { "type": "http", "url": "https://mcp.postman.com/minimal" } } } ``` **API Key:** ```json { "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" } ] } ``` #### Cursor Installation Click the [install button](https://cursor.com/en/install-mcp?name=postman_mcp_server&config=eyJ1cmwiOiJodHRwczovL21jcC5wb3N0bWFuLmNvbS9taW5pbWFsIiwiaGVhZGVycyI6eyJBdXRob3JpemF0aW9uIjoiQmVhcmVyIFlPVVJfQVBJX0tFWSJ9fQ%3D%3D) or manually configure `mcp.json`: ```json { "url": "https://mcp.postman.com/minimal", "headers": { "Authorization": "Bearer ${POSTMAN_API_KEY}" } } ``` ### Local Server The local server runs on your machine, enabling access to local APIs and providing more control. #### NPM Installation ```bash # Install globally npm install -g @postman/postman-mcp-server # Or use with npx npx @postman/postman-mcp-server ``` #### Claude Code (Local) ```bash claude mcp add postman npx @postman/postman-mcp-server \ --apiKey ${POSTMAN_API_KEY} \ --toolset minimal ``` **Toolset options:** `minimal`, `code`, `full` **Region flag (EU):** ```bash claude mcp add postman npx @postman/postman-mcp-server \ --apiKey ${POSTMAN_API_KEY} \ --region eu ``` #### VS Code (Local) Add to `.vscode/mcp.json`: ```json { "servers": { "postman": { "type": "stdio", "command": "npx", "args": [ "@postman/postman-mcp-server", "--apiKey", "${env:POSTMAN_API_KEY}", "--toolset", "minimal" ] } } } ``` #### Docker ```bash docker run -e POSTMAN_API_KEY=${POSTMAN_API_KEY} \ postman/postman-mcp-server:latest \ --toolset minimal ``` ## Authentication ### Getting a Postman API Key 1. Navigate to [Postman API Keys](https://postman.postman.co/settings/me/api-keys) 2. Click "Generate API Key" 3. Copy the key and store it securely 4. Set environment variable: `export POSTMAN_API_KEY=your_key_here` ### OAuth Setup (US Remote Server Only) OAuth is automatically configured when using the US remote server without headers. The MCP host will handle authentication flow when tools are first accessed. ## Core Capabilities ### 1. Workspace Management **Create a workspace:** ```typescript // Via natural language to AI agent: // "Create a new team workspace called 'Mobile API' with description 'APIs for mobile app'" // The agent calls: { "tool": "create_workspace", "arguments": { "name": "Mobile API", "type": "team", "description": "APIs for mobile app" } } ``` **List workspaces:** ```typescript // "Show me all my workspaces" { "tool": "get_all_workspaces", "arguments": {} } ``` **Get workspace details:** ```typescript // "Get details about workspace 12345" { "tool": "get_workspace", "arguments": { "workspaceId": "12345" } } ``` ### 2. Collection Operations **Create a collection:** ```typescript // "Create a new collection named 'User API' in my workspace" { "tool": "create_collection", "arguments": { "workspaceId": "workspace-123", "name": "User API", "description": "User management endpoints" } } ``` **Add a request to collection:** ```typescript // "Add a GET request to /users endpoint in my User API collection" { "tool": "create_request", "arguments": { "collectionId": "collection-456", "name": "Get Users", "method": "GET", "url": "https://api.example.com/users", "description": "Retrieve all users" } } ``` **Update collection documentation:** ```typescript // "Update the documentation for my User API collection" { "tool": "update_collection", "arguments": { "collectionId": "collection-456", "collection": { "info": { "description": "# User API\n\nComplete user management API with CRUD operations." } } } } ``` **Tag a collection:** ```typescript // "Tag my collection with 'production' and 'v2'" { "tool": "tag_collection", "arguments": { "collectionId": "collection-456", "tags": ["production", "v2"] } } ``` ### 3. Environment Management **Create environment:** ```typescript // "Create a development environment with base URL" { "tool": "create_environment", "arguments": { "workspaceId": "workspace-123", "name": "Development", "values": [ { "key": "baseUrl", "value": "https://dev.api.example.com", "type": "default" }, { "key": "apiKey", "value": "", "type": "secret" } ] } } ``` **Update environment variables:** ```typescript // "Update the baseUrl in my production environment" { "tool": "update_environment", "arguments": { "environmentId": "env-789", "environment": { "values": [ { "key": "baseUrl", "value": "https://api.example.com", "type": "default" } ] } } } ``` ### 4. API Testing **Run a collection:** ```typescript // "Test my User API collection in the development environment" { "tool": "run_collection", "arguments": { "collectionId": "collection-456", "environmentId": "env-789" } } ``` **Send a single request:** ```typescript // "Send a POST request to create a user" { "tool": "send_request", "arguments": { "method": "POST", "url": "{{baseUrl}}/users", "headers": { "Content-Type": "application/json", "Authorization": "Bearer {{apiKey}}" }, "body": { "mode": "raw", "raw": JSON.stringify({ "name": "John Doe", "email": "john@example.com" }) } } } ``` ### 5. Code Generation The **Code** toolset enables searching API definitions and generating production-ready client code. **Search public APIs:** ```typescript // "Find payment processing APIs" { "tool": "search_public_apis", "arguments": { "query": "payment processing", "limit": 10 } } ``` **Generate client code from API definition:** ```typescript // "Generate TypeScript client code for the Stripe API" { "tool": "generate_client_code", "arguments": { "apiId": "stripe-api-123", "language": "typescript", "framework": "axios", "options": { "includeTypes": true, "includeExamples": true } } } ``` **Generate code from collection:** ```typescript // "Create a Python client from my User API collection" { "tool": "generate_code_from_collection", "arguments": { "collectionId": "collection-456", "language": "python", "variant": "requests" } } ``` ### 6. API Specifications **Create spec from OpenAPI:** ```typescript // "Import my OpenAPI spec into Postman" { "tool": "create_api_spec", "arguments": { "workspaceId": "workspace-123", "name": "User API Spec", "schema": { "type": "openapi", "content": "... OpenAPI YAML/JSON ..." } } } ``` **Generate collection from spec:** ```typescript // "Generate a collection from my API spec" { "tool": "generate_collection_from_spec", "arguments": { "apiId": "api-spec-123", "name": "Generated User API Collection" } } ``` ## Common Patterns ### Pattern 1: API-First Development Workflow ```typescript // 1. Create workspace // "Create a workspace for my new project" // 2. Import OpenAPI spec // "Import my OpenAPI spec for the Product API" // 3. Generate collection // "Generate a collection from the Product API spec" // 4. Create environments // "Create dev, staging, and prod environments"