Use the Postman plugin for coding agents

Postman is available wherever your coding agent works. Install the Postman plugin for Claude Code, Codex, Cursor, OpenCode, Pi, and other coding agents. You can also run the Postman CLI postman init command directly in your project. Either way, your agent gets Postman’s skills to build, test, and manage APIs using the Postman CLI, without you leaving your coding environment.

Install the plugin

Install the plugin with the npx command, which installs into every detected agent or can be limited to just one. You can also install the plugin using a specific agent’s own method: Claude Code, Codex, Cursor, Factory, Kimi Code, OpenCode, or Pi.

The following requirements apply based on your installation method and coding agent:

Node.js 22 or later (only needed for the npx command)
Claude Code 2.1.268 or later
Codex 0.138.0 or later
Cursor 2.5 or later
Factory Droid 0.57.5 or later
Kimi Code 0.6.0 or later
OpenCode 1.14.33 or later, and Git
Pi 0.99.0 or later

All agents

Install the Postman plugin into every supported coding agent found on your machine, with a single command. You can also limit the installation to a specific agent.

npx @postman/postman-plugin [command] [options]

Command	What it does
`install`	Install into each detected agent, or update it there (default).
`status`	Show which agents are detected and whether the Postman plugin is installed.
`remove`	Uninstall from each detected agent (alias: `uninstall`).

Option	What it does
`--agent <id>`	Limit to one or more agents (repeat the option, or comma-separate): `claude-code`, `codex`, `cursor`, `factory`, `kimi`, `opencode`, `pi`.
`-y`, `--yes`	Skip the confirmation prompt for `install` or `remove` (required for both outside a terminal, unless you also use `--dry-run`).
`--dry-run`	Preview what `install` or `remove` would do, without making any changes.
`-h`, `--help`	Show the help.
`-v`, `--version`	Show the version.

For example:

# Install into every detected agent (the default command)
npx @postman/postman-plugin
# Limit to one agent
npx @postman/postman-plugin install --agent cursor
# Check what's currently installed
npx @postman/postman-plugin status
# Remove the plugin from every detected agent
npx @postman/postman-plugin remove

Exit codes:

Exit code	Meaning
`0`	Succeeded, or there was nothing to do.
`1`	Failed: an error occurred, you canceled, or `install` found no supported agent.
`2`	Invalid usage, or `install` or `remove` needed confirmation but ran outside a terminal (use `--yes`).
`3`	Succeeded, except for a manual step you still need to complete (shown as `next:` in the output).

If you’d rather install for a single agent, see Claude Code, Codex, Cursor, Factory, Kimi Code, OpenCode, or Pi.

Claude Code

Before installing, run an interactive claude session at least once so the official marketplace is registered.

Install the plugin for Claude Code using Claude’s plugin marketplace:

claude plugin marketplace add anthropics/claude-plugins-official
claude plugin install postman@claude-plugins-official

Codex

Install the plugin for Codex from the app, a direct link, or the command line.

App

Direct link

Command line

Open the Codex app, and click Plugins.
Search for “Postman”.
Select the Postman plugin, and click Install.

Cursor

Inside Cursor, install the plugin from the Cursor marketplace:

/add-plugin postman

Factory

Install the plugin for Factory using the following commands:

droid plugin marketplace add https://github.com/postmanlabs/postman-plugin.git
droid plugin install postman@postman-plugin --scope user

To update, run droid plugin marketplace update postman-plugin, then droid plugin update postman@postman-plugin --scope user. To sign in to Postman’s MCP server, run /mcp inside a Droid session.

Kimi Code

Inside a Kimi Code session, install the plugin using the full repository URL:

/plugins install https://github.com/postmanlabs/postman-plugin/tree/main

To update, run the same command again, then /new. To remove the plugin, run /plugins remove postman. To sign in to Postman’s MCP server, run /mcp-config login plugin-postman:postman.

OpenCode

Install the plugin for OpenCode using the command for your version.

OpenCode 2.0.4 or later:

opencode plugin add github:postmanlabs/postman-plugin

OpenCode 1.14.33 or later:

opencode plugin --global github:postmanlabs/postman-plugin

You need Git for either command. Restart OpenCode after installing.

If you installed the plugin for OpenCode by cloning the repository and adding a loader file, remove that install to avoid registering each skill twice. Delete ~/.config/opencode/plugins/postman.ts and the ~/.config/opencode/postman-plugin directory.

To remove the plugin on OpenCode 2.0.4 or later, run opencode plugin remove github:postmanlabs/postman-plugin. On OpenCode 1.14.33 or later, delete the plugin entry from ~/.config/opencode/opencode.json or opencode.jsonc, then restart OpenCode.

Pi

Install the plugin for Pi from Pi’s package gallery:

pi install npm:@postman/postman-plugin

To update, run pi update npm:@postman/postman-plugin. Then, inside a Pi session, sign in to Postman’s MCP server with /mcp login postman. Signing in from the shell with pi mcp login doesn’t load extensions, so it reports no server named postman.

Load skills into your agent

As an alternative to installing the plugin, you can load Postman’s skills directly into your coding agent using the Postman CLI. Install the Postman CLI, then load Postman’s skills into your project.

To install the Postman CLI, run the following:

npm install -g postman-cli

To install the Postman CLI for your specific OS, see Install the Postman CLI.

Then run the following:

postman init

The postman init command is a single command you can run from any terminal, script, or CI job.

To learn more, see Init command.

Work with Postman from your agent

Once you’re set up, describe what you want in natural language. Your coding agent can sync your project with a Postman Workspace, discover public APIs, create mock servers, or set up monitors.

The following are examples of tasks you can perform with your coding agent:

Create and test a collection

Create a collection for the API in this repo, add tests, and run them.

Find affected APIs

I’m changing the credit card service. What APIs in my company use it?

Assess a schema change's impact

What depends on the billing-api collection, and what would changing its response schema break?

Questions about what depends on an API, who owns it, or what a change could break are answered with Postman Context Graph, a dependency map of your organization’s API ecosystem. Your agent queries it with the postman context-graph commands, so prompts like the two preceding ones work without you pointing the agent at each service yourself.

How the plugin works

The plugin automatically routes each task to whichever tool is best suited to complete it, so you don’t have to choose yourself. It sends your agent’s requests to the Postman CLI whenever the CLI can complete them, and falls back to the Postman MCP Server only for tasks the CLI doesn’t support. Your agent does the work from the command line. Open Postman whenever you want to review or approve what changed.

To learn more about using the plugin with your coding agent, see the Postman plugin for coding agents repository.

Plugin skills

The plugin installs 16 skills that teach your agent how to complete API tasks with Postman. Each skill loads when the task calls for it, so your agent uses only the ones it needs.

Skill	What it does
`ai-readiness`	Scores a collection or OpenAPI specification for how well an AI agent can discover, understand, call, and recover from errors with it.
`api-discovery`	Finds and uses APIs from the web or Postman. Integrates public third-party APIs with Postman Orbit, locates Postman elements with search, and investigates dependencies, ownership, runtime behavior, and change impact with Postman Context Graph.
`api-documentation`	Generates filesystem-first API documentation from a collection or specification that you can share with your team.
`api-engineer`	Coordinates the other skills to design, implement, mock, test, monitor, document, and deploy an API with fewer tokens.
`api-mocking`	Creates a mock from a collection or specification, running locally or deployed at a durable URL, with scenario and status-code overrides for testing failure paths.
`api-monitoring`	Creates, schedules, and manages monitors, triggers ad-hoc runs, inspects run history, and hosts self-hosted runners for APIs on a private network.
`api-simulation`	Runs your real service locally against mocks of every API it depends on, found in your code and Context Graph and served together on one port.
`api-testing`	Runs tests against an API from the command line. Tests a single request, a full collection of assertions, or your app’s real traffic matched against a collection contract.
`bootstrap`	Runs before other skills to resolve the Postman CLI, authenticate when the task needs it, and manage the repository’s workspace binding.
`ci-integration`	Adds Postman checks to CI pipelines as independent pass/fail gates, such as running a collection on every PR or linting against governance rules.
`collection-schema-v3`	The reference the agent reads before writing or editing files in the Native Git v3 collection format.
`datasets`	Queries CSV and JSON files, spreadsheets, and live databases as one SQL surface, and drives a collection run one iteration per row with Postman Datasets.
`flows`	Runs, deploys, and debugs Postman Flows from the command line, and traces a failed run to the block that broke.
`performance-testing`	Load-tests a collection with concurrent virtual users, a chosen load profile, and pass/fail thresholds, locally or on Postman Cloud runners.
`postman-mcp-server`	Loads when the agent works with Postman MCP tools, guiding tool selection and workarounds.
`variables`	Adds variables to collections and stores secrets in the team’s Postman Shared Vault so values never land in agent context or committed files.