Summary
The Postman MCP Server integrates Postman's API testing and collection management capabilities with AI agents, enabling natural language interactions to access workspaces, manage collections and environments, and automate API workflows. It provides three tool configuration levels—Minimal (essential operations), Full (100+ tools for advanced collaboration), and Code (API code generation)—supporting both OAuth and API key authentication on remote and local deployments. This server solves the problem of enabling AI assistants to programmatically interact with Postman for API testing, code synchronization, and collection management without manual configuration.
Agent, run crypto. Access onchain data & trade routes via 1inch.
Install now →
On Capafy, your Skill runs online 24/7 as an agent product, and you get paid every time someone uses it.
Start earning →
Connect Claude to +800M contacts, +150M companies. Find & Enrich leads in chat.
Try For Free →
Integrate web data into your AI product. One API to scrape website & brand data.
Get API Key Now →Tools
Public tool metadata for what this MCP can expose to an agent.
41 tools
createCollectionCreates a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** If you do not include the \`workspace\` query parameter, the system creates the collection in the oldest personal Int...2 params
Creates a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** If you do not include the \`workspace\` query parameter, the system creates the collection in the oldest personal Int...
Parameters* required
workspacestringThe workspace's ID.
collectionobjectcreateCollectionRequestCreates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** It is recommended that you pass the \`na...15 params
Creates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** It is recommended that you pass the \`na...
Parameters* required
urlstringThe request's URL.
authvalueThe request's authentication information.
datavalueThe request body's form data.
namestringThe request's name. 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.
eventsvalueA list of scripts configured to run when specific events occur.
methodstringThe request's HTTP method.one of
GET · PUT · POST · PATCH · DELETE · COPYdataModestringThe request body's data mode.one of
raw · urlencoded · formdata · binary · graphqlfolderIdstringThe folder ID in which to create the request. By default, the system will create the request at the collection level.
headerDataarrayThe request's headers.
dataOptionsvalueAdditional configurations and options set for the request body's various data modes.
descriptionstringThe request's description.
queryParamsarrayThe request's query parameters.
rawModeDatastringThe request body's raw mode data.
collectionIdstringThe collection's ID.
graphqlModeDatavalueThe request body's GraphQL mode data.
createCollectionResponseCreates 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](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** It is recommended...19 params
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](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** It is recommended...
Parameters* required
urlstringThe associated request's URL.
mimestringThe response's MIME type.
namestringThe response's name. 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.
textstringThe raw text of the response body.
timestringThe time taken by the request to complete, in milliseconds.
methodstringThe request's HTTP method.one of
GET · PUT · POST · PATCH · DELETE · COPYstatusstringThe response's HTTP status text.
cookiesstringThe response's cookie data.
headersarrayA list of headers.
requeststringThe parent request's ID.
dataModestringThe associated request body's data mode.one of
raw · urlencoded · formdata · binary · graphqllanguagestringThe response body's language type.
dataOptionsvalueAdditional configurations and options set for the request body's various data modes.
descriptionstringThe response's description.
rawDataTypestringThe response's raw data type.
rawModeDatastringThe associated request body's raw mode data.
collectionIdstringThe collection's ID.
responseCodeobjectThe response's HTTP response code information.
requestObjectstringA JSON-stringified representation of the associated request.
createEnvironmentCreates 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 t...2 params
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 t...
Parameters* required
workspacestringThe workspace's ID.
environmentobjectInformation about the environment.
createMockCreates 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}-{colle...2 params
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}-{colle...
Parameters* required
mockobjectworkspacestringThe workspace's ID.
createSpecCreates an API specification in Postman's [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview/). Specifications can be single or multi-file. **Note:** - Postman supports OpenAPI 2.0, OpenAPI 3.0, OpenAPI 3.1, AsyncAPI 2.0, protobuf 2 and 3, and Gra...4 params
Creates an API specification in Postman's [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview/). Specifications can be single or multi-file. **Note:** - Postman supports OpenAPI 2.0, OpenAPI 3.0, OpenAPI 3.1, AsyncAPI 2.0, protobuf 2 and 3, and Gra...
Parameters* required
namestringThe specification's name.
typestringThe specification's type.one of
OPENAPI:2.0 · OPENAPI:3.0 · OPENAPI:3.1 · ASYNCAPI:2.0 · PROTOBUF:2 · PROTOBUF:3filesarrayA list of the specification's files and their contents.
workspaceIdstringThe workspace's ID.
createSpecFileCreates an API specification file. **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 insid...3 params
Creates an API specification file. **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 insid...
Parameters* required
pathstringThe file's path. Accepts JSON or YAML files.
specIdstringThe spec's ID.
contentstringThe file's stringified contents.
createWorkspaceCreates a new [workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). **Note:** - This endpoint returns a 403 \`Forbidden\` response if the user does not have permission to create workspaces. [Admins and Super Admins](http...1 params
Creates a new [workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). **Note:** - This endpoint returns a 403 \`Forbidden\` response if the user does not have permission to create workspaces. [Admins and Super Admins](http...
Parameters* required
workspaceobjectInformation about the workspace.
duplicateCollectionCreates 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.3 params
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.
Parameters* required
suffixstringAn optional suffix to append to the duplicated collection's name.
workspacestringThe workspace ID in which to duplicate the collection.
collectionIdstringThe collection's unique ID.
generateCollectionCreates 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.4 params
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.
Parameters* required
namestringThe generated collection's name.
specIdstringThe spec's ID.
optionsobjectThe advanced creation options and their values. For more details, see Postman's [OpenAPI to Postman Collection Converter OPTIONS documentation](https://github.com/postmanlabs/openapi-to-postman/blob/develop/OPTIONS.md). These properties are case-sensitive.
elementTypestringThe `collection` element type.
generateSpecFromCollectionGenerates an API specification for the given collection. The response contains a polling link to the task status.5 params
Generates an API specification for the given collection. The response contains a polling link to the task status.
Parameters* required
namestringThe API specification's name.
typestringThe specification's type.
formatstringThe format of the API specification.one of
JSON · YAMLelementTypestringThe `spec` value.
collectionUidstringThe collection's unique ID.
getAllSpecsGets all API specifications in a workspace.3 params
Gets all API specifications in a workspace.
Parameters* required
limitintegerThe maximum number of rows to return in the response.default: 10
cursorstringThe pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter.
workspaceIdstringThe workspace's ID.
getAuthenticatedUserGets 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.
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.
No parameter schema in public metadata yet.
getCollectionGet 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...3 params
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...
Parameters* required
modelstringOptional 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.one of
minimal · fullaccess_keystringA collection's read-only access key. Using this query parameter does not require an API key to call the endpoint.
collectionIdstringThe collection ID must be in the form <OWNER_ID>-<UUID> (e.g. 12345-33823532ab9e41c9b6fd12d0fd459b8b).
getCollectionsThe workspace ID query is required for this endpoint. If not provided, the LLM should ask the user to provide it.4 params
The workspace ID query is required for this endpoint. If not provided, the LLM should ask the user to provide it.
Parameters* required
namestringFilter results by collections that match the given name.
limitintegerThe maximum number of rows to return in the response.
offsetintegerThe zero-based offset of the first item to return.
workspacestringThe workspace's ID.
getDuplicateCollectionTaskStatusGets the status of a collection duplication task.1 params
Gets the status of a collection duplication task.
Parameters* required
taskIdstringThe task's unique ID.
getEnabledToolsIMPORTANT: 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.
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.
No parameter schema in public metadata yet.
getEnvironmentGets information about an environment.1 params
Gets information about an environment.
Parameters* required
environmentIdstringThe environment's ID.
getEnvironmentsGets information about all of your [environments](https://learning.postman.com/docs/sending-requests/managing-environments/).1 params
Gets information about all of your [environments](https://learning.postman.com/docs/sending-requests/managing-environments/).
Parameters* required
workspacestringThe workspace's ID.
getGeneratedCollectionSpecsGets the API specification generated for the given collection.2 params
Gets the API specification generated for the given collection.
Parameters* required
elementTypestringThe `spec` value.
collectionUidstringThe collection's unique ID.
getMockGets 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.1 params
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* required
mockIdstringThe mock's ID.
getMocksGets 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 curre...2 params
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 curre...
Parameters* required
teamIdstringReturn only results that belong to the given team ID.
- For team-scoped requests, set this from GET `/me` (`me.teamId`).
workspacestringReturn only results found in the given workspace ID.
- Prefer this parameter when the user mentions a specific workspace.
getSpecGets information about an API specification.1 params
Gets information about an API specification.
Parameters* required
specIdstringThe spec's ID.
getSpecCollectionsGets all of an API specification's generated collections.4 params
Gets all of an API specification's generated collections.
Parameters* required
limitintegerThe maximum number of rows to return in the response.default: 10
cursorstringThe pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter.
specIdstringThe spec's ID.
elementTypestringThe `collection` element type.
getSpecDefinitionGets the complete contents of an API specification's definition.1 params
Gets the complete contents of an API specification's definition.
Parameters* required
specIdstringThe spec's ID.
getSpecFileGets the contents of an API specification's file.2 params
Gets the contents of an API specification's file.
Parameters* required
specIdstringThe spec's ID.
filePathstringThe path to the file.
getSpecFilesGets all the files in an API specification.1 params
Gets all the files in an API specification.
Parameters* required
specIdstringThe spec's ID.
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 collec...5 params
**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 collec...
Parameters* required
slugstringThe tag's ID within a team or individual (non-team) user scope.
limitintegerThe maximum number of tagged elements to return in a single call.default: 10
cursorstringThe cursor to get the next set of results in the paginated response. If you pass an invalid value, the API only returns the first set of results.
directionstringThe ascending (`asc`) or descending (`desc`) order to sort the results by, based on the time of the entity's tagging.one of
asc · descdefault: descentityTypestringFilter results for the given entity type.one of
api · collection · workspacegetWorkspaceGets information about a workspace. **Note:** This endpoint's response contains the \`visibility\` field. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) determines who can access the...2 params
Gets information about a workspace. **Note:** This endpoint's response contains the \`visibility\` field. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) determines who can access the...
Parameters* required
includestringInclude 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.
one of
mocks:deactivated · scimworkspaceIdstringThe workspace's ID.
getWorkspacesGets 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 wor...3 params
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 wor...
Parameters* required
typestringThe type of workspace to filter the response by. One of: `personal`, `team`, `private`, `public`, `partner`.
- For “my …” requests, this can be combined with `createdBy`. If type is not specified, it will search across all types for that user.
one of
personal · team · private · public · partnerincludestringInclude 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.
one of
mocks:deactivated · scimcreatedByintegerReturn only workspaces created by the specified Postman user ID.
- For “my …” requests, set `createdBy` to the current user’s ID from GET `/me` (`me.user.id`).
- If the user's ID is not known, first call GET `/me`, then retry with `createdBy`.
publishMockPublishes a mock server. Publishing a mock server sets its **Access Control** configuration setting to public.1 params
Publishes a mock server. Publishing a mock server sets its **Access Control** configuration setting to public.
Parameters* required
mockIdstringThe mock's ID.
putCollectionReplaces the contents of a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). Include the collection's ID values in the request body. If you do not, the endpoint removes the existing items...3 params
Replaces the contents of a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). Include the collection's ID values in the request body. If you do not, the endpoint removes the existing items...
Parameters* required
PreferstringThe `respond-async` header to perform the update asynchronously.
collectionobjectcollectionIdstringThe collection ID must be in the form <OWNER_ID>-<UUID> (e.g. 12345-33823532ab9e41c9b6fd12d0fd459b8b).
putEnvironmentReplaces all the contents of an environment with the given information. **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...2 params
Replaces all the contents of an environment with the given information. **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...
Parameters* required
environmentobjectInformation about the environment.
environmentIdstringThe environment's ID.
runCollectionRuns a Postman collection by ID with detailed test results and execution statistics. Supports optional environment for variable substitution. Note: Advanced parameters like custom delays and other runtime options are not yet available.9 params
Runs a Postman collection by ID with detailed test results and execution statistics. Supports optional environment for variable substitution. Note: Advanced parameters like custom delays and other runtime options are not yet available.
Parameters* required
stopOnErrorbooleanGracefully halt on errors (default: false)
abortOnErrorbooleanAbruptly halt on errors (default: false)
collectionIdstringThe collection ID in the format <OWNER_ID>-<UUID> (e.g. 12345-33823532ab9e41c9b6fd12d0fd459b8b).
environmentIdstringOptional environment ID to use for variable substitution during the run.
scriptTimeoutnumberScript timeout in milliseconds (default: 5000)
stopOnFailurebooleanGracefully halt on test failures (default: false)
abortOnFailurebooleanAbruptly halt on test failures (default: false)
iterationCountnumberNumber of iterations to run (default: 1)
requestTimeoutnumberRequest timeout in milliseconds (default: 60000)
syncCollectionWithSpecSyncs a collection generated from an API specification. This is an asynchronous endpoint that returns an HTTP \`202 Accepted\` response. **Note:** - This endpoint only supports the OpenAPI 3.0 specification type. - You can only sync collections generated from the given spec ID.2 params
Syncs a collection generated from an API specification. This is an asynchronous endpoint that returns an HTTP \`202 Accepted\` response. **Note:** - This endpoint only supports the OpenAPI 3.0 specification type. - You can only sync collections generated from the given spec ID.
Parameters* required
specIdstringThe spec's ID.
collectionUidstringThe collection's unique ID.
syncSpecWithCollectionSyncs an API specification linked to a collection. This is an asynchronous endpoint that returns an HTTP \`202 Accepted\` response. **Note:** - This endpoint only supports the OpenAPI 3.0 specification type. - You can only sync specs generated from the given collection ID.2 params
Syncs an API specification linked to a collection. This is an asynchronous endpoint that returns an HTTP \`202 Accepted\` response. **Note:** - This endpoint only supports the OpenAPI 3.0 specification type. - You can only sync specs generated from the given collection ID.
Parameters* required
specIdstringThe spec's ID.
collectionUidstringThe collection's unique ID.
updateCollectionRequestUpdates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** - You must pass a collection ID (\`12ece...15 params
Updates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** - You must pass a collection ID (\`12ece...
Parameters* required
urlstringThe request's URL.
authvalueThe request's authentication information.
datavalueThe request body's form data.
namestringThe request's name.
eventsvalueA list of scripts configured to run when specific events occur.
methodstringThe request's HTTP method.one of
GET · PUT · POST · PATCH · DELETE · COPYdataModestringThe request body's data mode.one of
raw · urlencoded · formdata · binary · graphqlrequestIdstringThe request's ID.
headerDataarrayThe request's headers.
dataOptionsvalueAdditional configurations and options set for the request body's various data modes.
descriptionstringThe request's description.
queryParamsarrayThe request's query parameters.
rawModeDatastringThe request body's raw mode data.
collectionIdstringThe collection's ID.
graphqlModeDatavalueThe request body's GraphQL mode data.
updateMockUpdates a mock server. - Resource: Mock server entity associated with a collection UID. - Use this to change name, environment, privacy, or default server response.2 params
Updates a mock server. - Resource: Mock server entity associated with a collection UID. - Use this to change name, environment, privacy, or default server response.
Parameters* required
mockobjectmockIdstringThe mock's ID.
updateSpecFileUpdates an API specification's file. **Note:** - This endpoint does not accept an empty request body. You must pass one of the accepted values. - This endpoint does not accept multiple request body properties in a single call. For example, you cannot pass both the \`content\`...5 params
Updates an API specification's file. **Note:** - This endpoint does not accept an empty request body. You must pass one of the accepted values. - This endpoint does not accept multiple request body properties in a single call. For example, you cannot pass both the \`content\`...
Parameters* required
namestringThe file's name.
typestringThe type of file:
- `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file.
- `DEFAULT` — A file referenced by the `ROOT` file.
one of
DEFAULT · ROOTspecIdstringThe spec's ID.
contentstringThe specification's stringified contents.
filePathstringThe path to the file.
updateSpecPropertiesUpdates an API specification's properties, such as its name.2 params
Updates an API specification's properties, such as its name.
Parameters* required
namestringThe spec's name.
specIdstringThe spec's ID.
updateWorkspaceUpdates a workspace. **Note:** - This endpoint does not support the following visibility changes: - \`private\` to \`public\`, \`public\` to \`private\`, and \`private\` to \`personal\` for **Free** and **Solo** [plans](https://www.postman.com/pricing/). - \`public\` to \`pers...2 params
Updates a workspace. **Note:** - This endpoint does not support the following visibility changes: - \`private\` to \`public\`, \`public\` to \`private\`, and \`private\` to \`personal\` for **Free** and **Solo** [plans](https://www.postman.com/pricing/). - \`public\` to \`pers...
Parameters* required
workspaceobjectworkspaceIdstringThe workspace's ID.
Postman MCP Server
The Postman MCP Server connects Postman to AI tools, giving AI agents and assistants the ability to access workspaces, manage collections and environments, evaluate APIs, and automate workflows through natural language interactions. Learn more on the Postman MCP Server product page.
Postman also offers the server as an npm package.
Postman MCP Server collection
The Postman MCP Server collection is the quickest way to explore, test, and connect to the Postman MCP Server. Use it to:
- Browse the complete list of available tools across all configurations.
- Connect to and test the remote server — Full and Minimal.
- Connect to and test the local server.
Tool configurations
- Minimal — (Default) Only includes essential tools for basic Postman operations. Ideal for users who want to modify a single Postman element, such as collections, workspaces, or environments.
- Code — Includes tools to generate high-quality, well-organized client code from public and internal API definitions. Ideal for users who need to consume APIs or get API context to their agents.
- Full — Includes all available Postman API tools (100+ tools). Ideal for users who engage in advanced collaboration and Postman's Enterprise features.
Authentication
For the best developer experience and fastest setup, use OAuth on the remote server (https://mcp.postman.com). OAuth is fully compliant with the MCP Authorization specification and requires no manual API key configuration.
The EU remote server and the local server support only Postman API key authentication.
Quick start
Remote (any OAuth-compatible MCP host):
Add this URL to your MCP host's configuration:
https://mcp.postman.com/minimal
Change /minimal to /code or /mcp for Code or Full mode. For EU or API key auth, pass Authorization: Bearer <POSTMAN_API_KEY> as a header.
Local:
npx @postman/postman-mcp-server
Add --code or --full for Code or Full mode. Set POSTMAN_API_KEY as an environment variable.
For IDE-specific setup instructions, see the table below. For more information, see the Postman MCP Server docs.
Supported agents and IDEs
| Agent / IDE | Remote | Local |
|---|---|---|
| Claude Code | Docs | Docs |
| Claude Desktop | — | Docs |
| Cursor | Docs | Docs |
| VS Code | Docs | Docs |
| Codex | Docs | Docs |
| Windsurf | Docs | Docs |
| Antigravity | Docs | Docs |
| GitHub Copilot CLI | Docs | Docs |
| Gemini CLI | Docs | Docs |
| Kiro | Docs | Docs |
| Docker | — | Docs |
EU support
The Postman MCP Server supports the EU region for remote and local servers:
- For streamable HTTP, the remote server is available at
https://mcp.eu.postman.com/mcp(Full),https://mcp.eu.postman.com/code, andhttps://mcp.eu.postman.com/minimal. - For the STDIO public package, use the
--region euflag, or set thePOSTMAN_API_BASE_URLenvironment variable directly. - OAuth isn't supported for the EU server. The EU remote server only supports API key authentication.
Use cases
- API Testing — Continuously test your API using your Postman collection. Use the local server to test local APIs, as the remote server won't have network access to your workstation.
- Code synchronization — Keep your code in sync with your Postman Collections and specs.
- Collection management — Create and tag collections, update documentation, add comments, or perform actions across multiple collections without leaving your editor.
- Workspace and environment management — Create workspaces and environments, plus manage environment variables.
- Automatic spec creation — Create specs from your code and use them to generate collections.
- Client code generation — Generate production-ready client code that consumes APIs following best practices and project conventions.
Docker
For Docker setup and installation, see DOCKER.md.
Questions and support
- See Add your MCP requests to your collections to learn how to use Postman to perform MCP requests.
- Visit the Postman Community to share what you've built, ask questions, and get help.
- You can connect to both the remote and local servers and test them using the Postman MCP Server collection.
Featured
Agent, run crypto. Access onchain data & trade routes via 1inch.
Install now →On Capafy, your Skill runs online 24/7 as an agent product, and you get paid every time someone uses it.
Start earning →Connect Claude to +800M contacts, +150M companies. Find & Enrich leads in chat.
Try For Free →Integrate web data into your AI product. One API to scrape website & brand data.
Get API Key Now →Configuration
POSTMAN_API_KEY*secretA valid Postman API key.
Registryactive
Package@postman/postman-mcp-server
TransportSTDIO, HTTP
AuthRequired
UpdatedJun 8, 2026