mcp/postman repository overview

⁠Postman MCP Server

Postman's MCP server connects AI agents, assistants, and chatbots directly to your APIs on Postman. Use natural language to prompt AI to automate work across your Postman collections, environments, workspaces, and more.

What is an MCP Server?⁠

⁠MCP Info

⁠Image Building Info

⁠Available Tools (42)

---

⁠Tools Details

⁠Tool: createCollection

Creates a collection using the Postman Collection v2.1.0 schema format⁠.

Note:

If you do not include the `workspace` query parameter, the system creates the collection in the oldest personal Internal workspace you own.

---

⁠Tool: createCollectionRequest

Creates a request in a collection. For a complete list of properties, refer to the Request entry in the Postman Collection Format documentation⁠.

Note:

It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a request with a blank name.

---

⁠Tool: createCollectionResponse

Creates a request response in a collection. For a complete list of request body properties, refer to the Response entry in the Postman Collection Format documentation⁠.

Note:

It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a response with a blank name.

---

⁠Tool: createEnvironment

Creates an environment.

Note:

• The request body size cannot exceed the maximum allowed size of 30MB.
• If you receive an HTTP `411 Length Required` error response, manually pass the `Content-Length` header and its value in the request header.
• If you do not include the `workspace` query parameter, the system creates the environment in the oldest personal Internal workspace you own. Parameters|Type|Description -|-|- workspace|string|The workspace's ID. environment|object optional|Information about the environment.

---

⁠Tool: createMock

Creates a mock server in a collection.

• Pass the collection UID (ownerId-collectionId), not the bare collection ID.
• If you only have a `collectionId`, resolve the UID first:
  1. Prefer GET `/collections/{collectionId}` and read `uid`, or
  2. Construct `{ownerId}-{collectionId}` using ownerId from GET `/me`:
  • For team-owned collections: `ownerId = me.teamId`
  • For personal collections: `ownerId = me.user.id`
• Use the `workspace` query to place the mock in a specific workspace. Prefer explicit workspace scoping. Parameters|Type|Description -|-|- workspace|string|The workspace's ID. mock|object optional|

---

⁠Tool: createSpec

Creates an API specification in Postman's Spec Hub⁠. Specifications can be single or multi-file.

Note:

• Postman supports OpenAPI (2.0, 3.0, and 3.1), AsyncAPI (2.0 and 3.0), protobuf (2 and 3), GraphQL, and Smithy specifications.
• If the file path contains a `/` (forward slash) character, then a folder is created. For example, if the path is the `components/schemas.json` value, then a `components` folder is created with the `schemas.json` file inside.
• Multi-file specifications can only have one root file.
• Files cannot exceed a maximum of 12 MB in size. Parameters|Type|Description -|-|- files|array|A list of the specification's files and their contents. name|string|The specification's name. type|string|The type of API specification. workspaceId|string|The workspace's ID.

---

⁠Tool: createSpecFile

Creates a file for an OpenAPI or a protobuf 2 or 3 specification.

Note:

• If the file path contains a `/` (forward slash) character, then a folder is created. For example, if the path is the `components/schemas.json` value, then a `components` folder is created with the `schemas.json` file inside.
• Creating a spec file assigns it the `DEFAULT` file type.
• Multi-file specifications can only have one root file.
• Files cannot exceed a maximum of 10 MB in size. Parameters|Type|Description -|-|- content|string|The file's stringified contents. path|string|The file's path. Accepts JSON or YAML files. specId|string|The spec's ID.

---

⁠Tool: createWorkspace

Creates a new workspace⁠.

Note:

• This endpoint returns a 403 `Forbidden` response if the user does not have permission to create workspaces. Admins and Super Admins⁠ can configure workspace permissions to restrict users and/or user groups from creating workspaces or require approvals for the creation of team workspaces.
• Private and Partner Workspaces⁠ are available on Postman Team and Enterprise plans⁠.
• There are rate limits when publishing public workspaces.
• Public team workspace names must be unique.
• The `teamId` property must be passed in the request body if Postman Organizations⁠ is enabled. Parameters|Type|Description -|-|- workspace|object optional|Information about the workspace.

---

⁠Tool: duplicateCollection

Creates a duplicate of the given collection in another workspace.

Use the GET `/collection-duplicate-tasks/{taskId}` endpoint to get the duplication task's current status.

---

⁠Tool: generateCollection

Creates a collection from the given API specification. The specification must already exist or be created before it can be used to generate a collection. The response contains a polling link to the task status.

---

⁠Tool: generateSpecFromCollection

Generates an OpenAPI 2.0, 3.0, or 3.1 specification for the given collection. The response contains a polling link to the task status.

---

⁠Tool: getAllSpecs

Gets all API specifications in a workspace.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getAuthenticatedUser

Gets information about the authenticated user.

• This endpoint provides “current user” context (`user.id`, `username`, `teamId`, roles).
• When a user asks for “my …” (e.g., “my workspaces, my information, etc.”), call this first to resolve the user ID.

⁠Tool: getCollection

Get information about a collection. By default this tool returns the lightweight collection map (metadata + recursive itemRefs). Use the model parameter to opt in to Postman's full API responses:

• model=minimal — root-level folder/request IDs only
• model=full — full Postman collection payload. Parameters|Type|Description -|-|- collectionId|string|The collection ID must be in the form <OWNER_ID>- (e.g. 12345-33823532ab9e41c9b6fd12d0fd459b8b). access_key|string optional|A collection's read-only access key. Using this query parameter does not require an API key to call the endpoint. model|string optional|Optional response shape override. Omit to receive the lightweight collection map. Set to minimal for the Postman minimal model or full for the complete collection payload.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getCollections

The workspace ID query is required for this endpoint. If not provided, the LLM should ask the user to provide it.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getDuplicateCollectionTaskStatus

Gets the status of a collection duplication task.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getEnabledTools

IMPORTANT: Run this tool first when a requested tool is unavailable. Returns information about which tools are enabled in the full and minimal tool sets, helping you identify available alternatives.

⁠Tool: getEnvironment

Gets information about an environment.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getEnvironments

Gets information about all of your environments⁠.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getGeneratedCollectionSpecs

Gets the API specification generated for the given collection.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getMock

Gets information about a mock server.

• Resource: Mock server entity. Response includes the associated `collection` UID and `mockUrl`.
• Use the `collection` UID to navigate back to the source collection. Parameters|Type|Description -|-|- mockId|string|The mock's ID.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getMocks

Gets all active mock servers. By default, returns only mock servers you created across all workspaces.

• Always pass either the `workspace` or `teamId` query to scope results. Prefer `workspace` when known.
• If you need team-scoped results, set `teamId` from the current user: call GET `/me` and use `me.teamId`.
• If both `teamId` and `workspace` are passed, only `workspace` is used. Parameters|Type|Description -|-|- teamId|string optional|Return only results that belong to the given team ID.
• For team-scoped requests, set this from GET /me (me.teamId).

workspace|string optional|Return only results found in the given workspace ID.

• Prefer this parameter when the user mentions a specific workspace.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getSpec

Gets information about an API specification.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getSpecCollections

Gets all of an API specification's generated collections.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getSpecDefinition

Gets the complete contents of an OpenAPI or AsyncAPI specification's definition.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getSpecFile

Gets the contents of an API specification's file.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getSpecFiles

Gets all the files in an API specification.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getTaggedEntities

Requires an Enterprise plan. Tagging is only available on Postman Enterprise plans. This tool returns a 404 error on Free, Basic, and Professional accounts.

Gets Postman elements (entities) by a given tag. Tags enable you to organize and search workspaces, APIs, and collections that contain shared tags.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getWorkspace

Gets information about a workspace.

Note:

This endpoint's response contains the `visibility` field. Visibility⁠ determines who can access the workspace:

• `personal` — Only you can access the workspace.
• `team` — All team members can access the workspace.
• `private` — Only invited team members can access the workspace (Team and Enterprise plans only⁠).
• `public` — Everyone can access the workspace.
• `partner` — Only invited team members and partners⁠ can access the workspace (Team and Enterprise plans only⁠). Parameters|Type|Description -|-|- workspaceId|string|The workspace's ID. include|string optional|Include the following information in the endpoint's response:
• mocks:deactivated — Include all deactivated mock servers in the response.
• scim — Return the SCIM user IDs of the workspace creator and who last modified it.

This tool is read-only. It does not modify its environment.

---

⁠Tool: getWorkspaces

Gets all workspaces you have access to.

• For “my …” requests, first call GET `/me` and pass `createdBy={me.user.id}`.
• This endpoint's response contains the visibility field. Visibility determines who can access the workspace:
  • `personal` — Only you can access the workspace.
  • `team` — All team members can access the workspace.
  • `private` — Only invited team members can access the workspace (Professional and Enterprise).
  • `public` — Everyone can access the workspace.
  • `partner` — Invited team members and partners (Professional and Enterprise).
• For tools that require the

[...]