Complete rewrite covering installation, quick start, all 8 commands, auto-routing, readiness analyzer overview, requirements, development instructions, and how the MCP auto-config works. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Postman Plugin for Claude Code
Full API lifecycle management inside Claude Code. One install, zero manual MCP configuration.
Installation
claude plugin install postman@postmanlabs/claude-code-postman-plugin
Quick Start
- Set your API key:
export POSTMAN_API_KEY=PMAK-your-key-here
- Run setup:
/postman:setup
That's it. The plugin auto-configures the Postman MCP Server, verifies your connection, and lists your workspaces. You're ready to go.
Get your API key at postman.postman.co/settings/me/api-keys.
Commands
| Command | What It Does |
|---|---|
/postman:setup |
Configure API key, verify connection, select workspace |
/postman:sync |
Create or update Postman collections from OpenAPI specs |
/postman:codegen |
Generate typed client code from any Postman collection |
/postman:search |
Find APIs across your private workspaces |
/postman:test |
Run collection tests, diagnose failures, suggest fixes |
/postman:mock |
Create mock servers for frontend development |
/postman:docs |
Generate, improve, and publish API documentation |
/postman:security |
Security audit against OWASP API Top 10 |
What You Can Do
Sync your API to Postman
"Sync my OpenAPI spec with Postman"
→ Detects local spec, creates/updates collection, sets up environment
Generate client code from private APIs
"Generate a TypeScript client for the payments API"
→ Reads your Postman collection, detects project language, writes typed code
Search across your workspace
"Is there an endpoint that returns user emails?"
→ Searches private collections, drills into endpoint details, shows response shapes
Run API tests
"Run the tests for my User API collection"
→ Executes collection, parses results, diagnoses failures, suggests code fixes
Create mock servers
"Create a mock for frontend development"
→ Generates missing examples, creates mock, provides integration config
Audit API security
"Run a security audit on my API"
→ 20+ checks including OWASP Top 10, severity scoring, remediation guidance
Check if your API is agent-ready
"Is my API ready for AI agents?"
→ 48 checks across 8 pillars, scored 0-100, prioritized fix recommendations
Auto-Routing
You don't need to remember command names. The plugin's routing skill detects your intent and runs the right command:
- "Sync my collection" routes to
/postman:sync - "Generate a client" routes to
/postman:codegen - "Check for vulnerabilities" routes to
/postman:security - "Is my API agent-ready?" triggers the readiness analyzer
API Readiness Analyzer
The built-in readiness analyzer evaluates APIs for AI agent compatibility across 8 pillars:
| Pillar | What It Checks |
|---|---|
| Metadata | operationIds, summaries, descriptions, tags |
| Errors | Error schemas, codes, retry guidance |
| Introspection | Parameter types, required fields, examples |
| Naming | Consistent casing, RESTful paths |
| Predictability | Response schemas, pagination, date formats |
| Documentation | Auth docs, rate limits |
| Performance | Rate limit headers, caching, bulk endpoints |
| Discoverability | OpenAPI version, server URLs |
70%+ with no critical failures = Agent-Ready.
Requirements
- Claude Code v1.0.33+
- Postman API key (
POSTMAN_API_KEYenvironment variable) - No Python, Node, or other runtime dependencies
How It Works
The plugin bundles a .mcp.json file that auto-configures the Postman MCP Server when installed. All commands communicate with Postman through 111 MCP tools. No scripts, no dependencies, pure MCP.
Development
To test the plugin locally during development:
cd your-api-project/
claude --plugin-dir /path/to/postman-plugin
This loads the plugin from a local directory instead of the marketplace.
License
Apache-2.0