SuperAPI AI Directory

postman-mcp-server

Coding & development

View repository

Updated 11-11 03:27

About this skill

Postman Knowledge

Reference for Postman concepts and MCP tool selection. Use this context when working with Postman MCP tools to make better decisions.

See references/setup.md for how to to setup postman mcp server and auth.

Core Concepts

  • Collection: A group of API requests organized in folders. The primary unit of work in Postman. Contains requests, examples, tests, and documentation.
  • Environment: Key-value pairs (variables) scoped to a context (dev, staging, prod). Used to swap base URLs, auth tokens, and config without changing requests.
  • Workspace: Container for collections, environments, and specs. Can be personal, team, or public.
  • Spec (Spec Hub): An OpenAPI or AsyncAPI definition stored in Postman. Can generate collections and stay synced.
  • Request: A single API call definition (method, URL, headers, body, tests).
  • Response: A saved example response for a request. Used by mock servers and documentation.
  • Folder: A grouping within a collection, typically by resource (e.g., "Users", "Orders").
  • Tags: Labels on collections for categorization and search.
  • Monitor: A scheduled collection runner that checks API health.
  • Mock Server: A fake API that serves example responses from a collection.

Decision Guide

Goal Approach
Push code changes to Postman Create/update spec in Spec Hub, then sync to collection
Consume a Postman API Read collection + generate client code
Find an API Use searchPostmanElements, then drill into details
Test an API Run collection with runCollection
Create a fake API for frontend Create mock server from collection with examples
Document an API Analyze collection completeness, fill gaps, optionally publish
Audit API security Run security checks against spec or collection
Learn how to use a Postman feature Search Postman docs with searchLearningCenter (Full mode)

MCP Tool Selection

Workspace operations: getWorkspaces, getWorkspace, createWorkspace Collection CRUD: getCollections, getCollection, createCollection, putCollection, patchCollection, deleteCollection Request/Response: getCollectionRequest, createCollectionRequest, updateCollectionRequest, getCollectionResponse, createCollectionResponse, updateCollectionResponse Folder management: getCollectionFolder, createCollectionFolder, updateCollectionFolder Spec Hub: getAllSpecs, getSpec, createSpec, getSpecDefinition, updateSpecFile, getSpecFiles Sync: generateCollection, syncCollectionWithSpec, syncSpecWithCollection Environments: getEnvironments, getEnvironment, createEnvironment, putEnvironment Mocks: getMocks, getMock, createMock, publishMock, unpublishMock Tests: runCollection Docs: publishDocumentation, unpublishDocumentation Search: searchPostmanElements , getTaggedEntities Learning Center: searchLearningCenter (Full mode only — searches Postman product docs for how-to guidance) User: getAuthenticatedUser

See references/mcp-limitations.md for known limitations and workarounds.

Workflows

Each reference below is a full MCP-tool workflow for one goal — the tool call sequence, what to present at each step, and error handling. Reach for one once the Decision Guide above has picked a goal; they assume MCP tools only, no postman CLI.

  • references/setup.md — first-run auth (OAuth or API key) and workspace verification.
  • references/search.md — discover APIs across workspaces with searchPostmanElements.
  • references/sync.md — create/update collections from specs, or sync a spec from collection changes.
  • references/mock.md — create a mock server from a collection or spec.
  • references/test.md — run collection tests and diagnose failures.
  • references/docs.md — generate, improve, and publish API documentation.
  • references/security.md — audit a spec or collection against the OWASP API Top 10.
  • references/learn.md — search the Postman Learning Center for how-to guidance.