Skip to content

postmanlabs/postman

v0.3.0Apache-2.0

Work with Postman from your agent: bootstrap a repo's Postman setup, mock an API before it's implemented, run collection and governance checks in CI, monitor a live endpoint, deploy and debug Postman Flows, and publish generated API documentation.

ai-readiness

Use when assessing or improving how well AI agents can discover, call, and recover from errors with an API. Scores an existing Postman collection or OpenAPI spec and turns measured gaps into contract improvements; supports a separate CI readiness threshold. Use for requests such as "is this API ready for agents".

api-discovery

Use when finding an API or owner, integrating a public provider, locating Postman resources, or investigating consumers and change impact across services. Turns discovered contracts and mocks into reusable dependencies and identifies evidence outside the current checkout. Use for requests such as "who consumes this endpoint".

api-documentation

Use when defining or improving an API contract, generating documentation from a collection or OpenAPI spec, publishing API docs, or sharing a documentation link. Makes auth, inputs, responses, and examples reusable by callers, tests, and mocks. Use for requests such as "publish API docs".

api-engineer

Use when an HTTP API task spans several steps, such as building a new endpoint end to end with its contract, implementation, tests and mocks, or when it is API work and no narrower Postman skill fits. Prefer the narrower Postman skill when one fits. Routes to the relevant Postman skills and keeps contracts, tests and mocks reusable across the work, using organization-wide dependency context. Not for UI-only changes, library or CLI code, or questions about what existing code does. Use for requests such as "implement this endpoint".

api-mocking

Use when something needs an API that isn't built or reachable yet (a frontend, client or demo), when other teams should build against your API before it ships, or when asked to mock an API or fake a backend. Finds, builds, runs and publishes a stand-in for one API — a published mock when its owner or a verified publisher has one, otherwise one built from its spec or collection that behaves like the real API, stateful when callers write then read. To run and test your own code against the services it calls, use api-simulation. Covers postman mock and postman dependency add mock.

api-monitoring

Use when setting up recurring API checks, running or diagnosing a Postman Monitor, changing its schedule, or reaching private APIs through a self-hosted runner. Reuses collection assertions to detect live regressions and traces failures to individual run evidence. Use for requests such as "check this API every minute".

api-simulation

Use when you add or change code that calls other services and need to run it, test it, prove a fix or reproduce an upstream failure (timeouts, 5xx, 409, 429) end to end, locally or in CI, without the real services because they're unreachable, need credentials, cost money, have side effects or don't exist yet. Also use it to answer what happens to a request, or to the data it writes, when a service it calls goes down, is slow or returns errors ("what happens to a booking if the email service is down?"). Runs services, frontends, tests or demos against stand-ins for their HTTP dependencies, served as one environment locally or at a deployed URL. Applies even when nobody says mock or simulation; a postman/simulations/ directory is itself a reason to load it. To give a frontend or another team a stand-in for an API, use api-mocking. Covers postman simulation.

api-testing

Use when testing an endpoint with real HTTP requests, running collection assertions, or checking real application traffic against an API contract. Not for unit tests of internal functions. Reuses saved requests and reports what live, mocked, or captured-traffic results actually establish. Use for requests such as "test this endpoint".

application-testing

Use when connecting Playwright end-to-end tests to Postman — capturing their network traffic, generating a collection from that traffic, matching it against a collection contract, measuring which APIs the tests cover, setting it up in CI, or debugging why capture shows nothing. Runs postman application test, which wraps Playwright, runs pm.test assertions on captured traffic and publishes results to Application Inventory. Covers the Postman side only, not Playwright test authoring or Playwright failures unrelated to capture. Use for requests such as "connect my Playwright tests to Postman" or "which APIs are my e2e tests not hitting".

ci-integration

Use when adding API tests, structural or governance lint, or AI-readiness gates to CI, or publishing reviewed API artifacts to a Postman workspace after merge. Makes contract checks repeatable and separates validation from shared workspace changes. Use for requests such as "run this collection on every PR".

cli-install

Use when the Postman CLI is missing or can't be installed, or when postman is "command not found". Installs the CLI globally so postman is on PATH, with a fallback to the hosted MCP server when installing is blocked. Use for requests such as "install the Postman CLI".

collection-schema-v3

Use when writing or debugging local Postman v3 collection, environment or globals files, including collection lint failures. Preserves the per-entity files, inherited context, and schema shapes that make API changes reusable and reviewable in Git. Use for requests such as "fix this request YAML".

datasets

Use when creating or repairing dataset manifests, or when a collection needs queried or joined test inputs, a reusable named view, spreadsheet worksheet data, live database rows, or script access through pm.datasets(). Chooses between a simple iteration file and a dataset while preserving query semantics, portability, and credential boundaries. Use for requests such as "run this collection over database rows".

flows

Use when running, deploying, or debugging an existing Postman Flow. Distinguishes local graph execution from a deployed webhook, reuses named input scenarios, and follows a run to the failing block rather than treating an HTTP response as whole-flow success. Use for requests such as "why did this flow fail".

mcp-testing

Use when checking, debugging or writing tests for an MCP server, local or remote, whoever built it. Use for requests such as "does my MCP server work", "why does this tool call fail", "connect to this MCP URL" or "make sure these tools keep working". Not for using Postman's own MCP tools on a workspace; that is postman-mcp-server.

performance-testing

Use when load-testing or benchmarking an API with concurrent virtual users and latency or error thresholds, or when importing or migrating a JMeter .jmx plan or a Gatling simulation (Java/Kotlin/Scala/JS/TS) into a Postman collection plus a postman performance run configuration. Reuses a collection to probe a chosen failure mode and distinguishes target limits from load-generator limits. Use for requests such as "load test this API", "import my JMeter plan", or "convert my Gatling project to Postman".

postman-mcp-server

Use when working through Postman MCP tools to inspect or change workspace resources, choose a targeted operation, or handle MCP limitations. Supports hosted workflows when the CLI is unavailable and distinguishes tool completion from a usable result. Not for testing an MCP server itself; that is mcp-testing. Use for requests such as "use Postman MCP to inspect this collection".

variables

Use when parameterizing requests across environments, choosing variable scopes, chaining values in scripts, or referencing credentials without committing or exposing them. Keeps one reusable collection while separating target configuration from secret values. Use for requests such as "where should I put this API key".

webhook-testing

Use when writing, debugging or testing code that receives HTTP callbacks (webhooks) from another system, or testing webhooks your API sends, whether or not Postman is mentioned. Gives a reusable public URL that captures deliveries, forwards them to localhost and replays them, keeps sender configuration across sessions, and records arrivals even while forwarding is stopped, so delivery failures can be told apart from local connectivity problems. Use for requests such as "get payment events to localhost" or "replay an event after a fix".

workspaces

Use when initializing Postman in a repository, binding it to a Postman workspace, interpreting what postman init did, or handling CLI-suggested actions for authentication, plan, credits, usage quota, or subscription restrictions. Treats the workspace as the place where a service's API work and its evidence live, kept separate from the services it depends on. Use for requests such as "set up Postman in this repo" or "connect this repo to our workspace".