$git clone https://github.com/Postman-Devrel/postman-claude-code-pluginOfficial Postman plugin for Claude Code
| 1 | <p align="center"> |
| 2 | <img src="https://voyager.postman.com/logo/postman-logo-orange.svg" alt="Postman" width="320"> |
| 3 | </p> |
| 4 | |
| 5 | # Postman Plugin for Claude Code |
| 6 | |
| 7 | The Postman Plugin provides a single, simple install for Claude Code. It provides full API lifecycle management, and best practices when working with Postman APIs. |
| 8 | |
| 9 | ## What's included: |
| 10 | - Commands for setting up the Postman MCP Server (no more manual installs!), working with Collections, Tests, Mock Servers, and generating code and documentation from Collections |
| 11 | - Skills for API discovery and client code generation, OpenAPI spec generation, Postman CLI workflows, and API best practices |
| 12 | - Agent for reviewing API production readiness and providing recommendations based on the <a href="https://www.postman.com/ai/90-day-ai-readiness-playbook/">Postman API Readiness Guide</a>. |
| 13 | |
| 14 | ## Installation |
| 15 | |
| 16 | Clone the repo and load it as a local plugin: |
| 17 | |
| 18 | ```bash |
| 19 | git clone https://github.com/Postman-Devrel/postman-claude-code-plugin.git |
| 20 | ``` |
| 21 | |
| 22 | Then start Claude Code with the plugin loaded: |
| 23 | |
| 24 | ```bash |
| 25 | cd your-api-project/ |
| 26 | claude --plugin-dir /path/to/postman-claude-code-plugin |
| 27 | ``` |
| 28 | |
| 29 | ## Quick Start |
| 30 | |
| 31 | 1. Start Claude Code with the plugin: |
| 32 | ```bash |
| 33 | claude --plugin-dir /path/to/postman-claude-code-plugin |
| 34 | ``` |
| 35 | |
| 36 | 2. Run setup: |
| 37 | ``` |
| 38 | /postman:setup |
| 39 | ``` |
| 40 | |
| 41 | 3. Authenticate when prompted — **OAuth (recommended)**, which opens a browser sign-in with no key copying, or an API key: |
| 42 | ```bash |
| 43 | export POSTMAN_API_KEY=PMAK-your-key-here |
| 44 | ``` |
| 45 | If you use an API key, add it to your shell profile (`~/.zshrc` or `~/.bashrc`) to persist across sessions. Get one at [go.postman.co/settings/me/api-keys](https://go.postman.co/settings/me/api-keys). |
| 46 | |
| 47 | That's it. The plugin auto-configures the Postman MCP Server, verifies your connection, and lists your workspaces. You're ready to go. |
| 48 | |
| 49 | ## Commands |
| 50 | |
| 51 | | Command | What It Does | |
| 52 | |---------|-------------| |
| 53 | | `/postman:setup` | Configure API key, verify connection, select workspace | |
| 54 | | `/postman:sync` | Create or update Postman collections from OpenAPI specs | |
| 55 | | `/postman:search` | Find APIs across your org's resources, your workspaces, and the public Postman network | |
| 56 | | `/postman:context` | Fetch real API definitions, generate and maintain typed client code | |
| 57 | | `/postman:test` | Run collection tests, diagnose failures, suggest fixes | |
| 58 | | `/postman:mock` | Create mock servers for frontend development | |
| 59 | | `/postman:docs` | Generate, improve, and publish API documentation | |
| 60 | | `/postman:security` | Security audit against OWASP API Top 10 | |
| 61 | | `/postman:learn` | Search the Postman Learning Center for how-to guidance and suggested workflows (Full mode) | |
| 62 | |
| 63 | ## What You Can Do |
| 64 | |
| 65 | ### Sync your API to Postman |
| 66 | ``` |
| 67 | "Sync my OpenAPI spec with Postman" |
| 68 | → Detects local spec, creates/updates collection, sets up environment |
| 69 | ``` |
| 70 | |
| 71 | ### Generate client code from private APIs |
| 72 | ``` |
| 73 | "Generate a TypeScript client for the payments API" |
| 74 | → Reads your Postman collection, detects project language, writes typed code |
| 75 | ``` |
| 76 | |
| 77 | ### Search across your workspace |
| 78 | ``` |
| 79 | "Is there an endpoint that returns user emails?" |
| 80 | → Searches across your org's collections, drills into endpoint details, shows response shapes |
| 81 | ``` |
| 82 | |
| 83 | ### Run API tests |
| 84 | ``` |
| 85 | "Run the tests for my User API collection" |
| 86 | → Executes collection, parses results, diagnoses failures, suggests code fixes |
| 87 | ``` |
| 88 | |
| 89 | ### Create mock servers |
| 90 | ``` |
| 91 | "Create a mock for frontend development" |
| 92 | → Generates missing examples, creates mock, provides integration config |
| 93 | ``` |
| 94 | |
| 95 | ### Audit API security |
| 96 | ``` |
| 97 | "Run a security audit on my API" |
| 98 | → 20+ checks including OWASP Top 10, severity scoring, remediation guidance |
| 99 | ``` |
| 100 | |
| 101 | ### Check if your API is agent-ready |
| 102 | ``` |
| 103 | "Is my API ready for AI agents?" |
| 104 | → 48 checks across 8 pillars, scored 0-100, prioritized fix recommendations |
| 105 | ``` |
| 106 | |
| 107 | ## Natural Language Routing |
| 108 | |
| 109 | You don't need to remember command names. Claude matches your intent to the right command or skill natively: |
| 110 | |
| 111 | - "Sync my collection" runs `/postman:sync` |
| 112 | - "Check for vulnerabilities" runs `/postman:security` |
| 113 | - "Is my API agent-ready?" triggers the readiness analyzer |
| 114 | |
| 115 | ## API Readiness Analyzer |
| 116 | |
| 117 | The built-in readiness analyzer evaluates APIs for AI agent compatibility across 8 pillars: |
| 118 | |
| 119 | | Pillar | What It Checks | |
| 120 | |--------|---------------| |
| 121 | | Metadata | operationIds, summaries, descriptions, tags | |
| 122 | | Errors | Error schemas, codes, retry guidance | |
| 123 | | Introspection | Parameter types, required fields, examples | |
| 124 | | Naming | Consistent casing, RESTful paths | |
| 125 | | Predictability | Response schemas, pagination, date formats | |
| 126 | | Documentation | Auth docs, rate limits | |
| 127 | | Performance | Rate limit headers, caching, bulk endpoints | |
| 128 | | Discoverability | OpenAPI version, server URLs | |
| 129 | |
| 130 | **70%+ with no critical failures = Agent-Ready.** |
| 131 | |
| 132 | ## Requirements |
| 133 | |
| 134 | - Claude Code v1.0.33+ |
| 135 | - A Postman account — authenticate via OAuth during `/postman:setup`, or set a `POSTMAN_API_KEY` environment variable |
| 136 | - No Python, Node, or other runtime dependencies |
| 137 | |
| 138 | ## How It Works |
| 139 | |
| 140 | The plugin bundles a `.mcp.json` file that auto-configures the [P |