### Build and Run Postman MCP Server Locally Source: https://context7.com/delano/postman-mcp-server/llms.txt Clone the repository, install dependencies, and build the server locally. This is an alternative to installing via Smithery. ```bash git clone https://github.com/delano/postman-api-server.git cd postman-api-server pnpm install && pnpm run build ``` -------------------------------- ### Install Dependencies for Postman MCP Server Source: https://github.com/delano/postman-mcp-server/blob/main/README.md Installs project dependencies using pnpm. Ensure pnpm is installed globally. ```bash pnpm install ``` -------------------------------- ### Install Postman MCP Server with Smithery Source: https://github.com/delano/postman-mcp-server/blob/main/README.md Installs the Postman MCP Server for Claude Desktop using the Smithery CLI. Ensure you have npx installed. ```bash npx -y @smithery/cli install postman-api-server --client claude ``` -------------------------------- ### Save Response Example Source: https://context7.com/delano/postman-mcp-server/llms.txt This API call allows you to save a response example for a specific request within a collection. Provide the collection ID, request ID, and the response details, including its name, status code, and status text. ```json { "name": "create_collection_response", "arguments": { "collection_id": "12ece9e1-2abf-4edc-8e34-de66e74114d2", "request_id": "9d123806-69a6-42be-88c4-28c3ef0fe5e2", "response": { "name": "200 OK - Success", "code": 200, "status": "OK" } } } ``` -------------------------------- ### Create Collection Response Source: https://context7.com/delano/postman-mcp-server/llms.txt Saves a response example for a specific request within a collection. ```APIDOC ## create_collection_response — Save a response example for a request ### Description Saves a response example for a specific request within a collection. ### Method POST (assumed) ### Endpoint `/collections/:collection_id/requests/:request_id/responses` (assumed) ### Parameters #### Request Body - **collection_id** (string) - Required - The ID of the collection containing the request. - **request_id** (string) - Required - The ID of the request to associate the response with. - **response** (object) - Required - An object containing the response example details. - **name** (string) - Required - The name of the response example. - **code** (integer) - Required - The HTTP status code of the response. - **status** (string) - Required - The status text of the response. ### Request Example ```json { "name": "create_collection_response", "arguments": { "collection_id": "12ece9e1-2abf-4edc-8e34-de66e74114d2", "request_id": "9d123806-69a6-42be-88c4-28c3ef0fe5e2", "response": { "name": "200 OK - Success", "code": 200, "status": "OK" } } } ``` ``` -------------------------------- ### Get all APIs Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/apis.md Retrieves a list of all APIs. Supports filtering by workspace, creator, description, and pagination. ```APIDOC ## GET /apis ### Description Retrieves a list of all APIs. Supports filtering by workspace, creator, description, and pagination. ### Method GET ### Endpoint /apis ### Parameters #### Query Parameters - **workspaceId** (string) - Required - The ID of the workspace to query APIs from. - **createdBy** (string) - Optional - Filter APIs by the creator's identifier. - **cursor** (string) - Optional - Cursor for pagination. - **apiDescription** (string) - Optional - Filter APIs by a keyword in their description. - **limit** (integer) - Optional - The maximum number of APIs to return. ### Responses #### Success Response (200) - **apis** (array) - A list of API objects. - **nextCursor** (string) - Cursor for the next page of results. #### Error Responses - 401: Unauthorized - 403: Feature Unavailable - 404: API Not Found - 422: Unsupported Version - 500: Internal Server Error ``` -------------------------------- ### Get all roles Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/workspaces.md Lists available roles based on the team's plan. ```APIDOC ## GET /workspaces-roles ### Description Lists available roles based on the team's plan. ### Method GET ### Endpoint /workspaces-roles ### Responses #### Success Response (200) - **roles** (array) - A list of available roles. ``` -------------------------------- ### Get All Server Responses Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/mocks.md Retrieves a list of all server responses configured for a specific mock. ```APIDOC ## Get All Server Responses ### Description Retrieves a list of all server responses configured for a specific mock. ### Method GET ### Endpoint `/mocks/{mockId}/server-responses` ### Parameters #### Path Parameters - **mockId** (string) - Required - The ID of the mock. ### Responses #### Success Response (200) - **getMockServerResponses** - Details about the server responses. ``` -------------------------------- ### Get all environments Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/environments.md Retrieves a list of all environments accessible to the user. Supports filtering by workspace. ```APIDOC ## Get all environments ### Description Retrieves a list of all environments accessible to the user. Supports filtering by workspace. ### Method GET ### Endpoint /environments ### Parameters #### Query Parameters - **workspace** (string) - Optional - The workspace ID to filter environments by. ``` -------------------------------- ### Get all mock servers Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/mocks.md Retrieves a list of all mock servers available in your workspace. You can filter the results by team ID or workspace ID. ```APIDOC ## Get all mock servers ### Description Retrieves a list of all mock servers. ### Method GET ### Endpoint /mocks ### Parameters #### Query Parameters - **teamId** (string) - Optional - Filters results by team ID. - **workspace** (string) - Optional - Filters results by workspace ID. If both `teamId` and `workspace` are provided, only `workspace` is used. ### Responses #### Success Response (200) - **data** (array) - List of mock servers. - **info** (object) - Information about the response. - **success** (boolean) - Indicates if the request was successful. #### Error Responses - **401**: Unauthorized. - **500**: Server error. ``` -------------------------------- ### Direct Resource URI Formats Source: https://github.com/delano/postman-mcp-server/blob/main/src/handlers/README.md Examples of direct resource URIs handled by the ResourceHandler. These URIs provide top-level API data. ```plaintext postman://workspaces # List all workspaces postman://collections # List all collections postman://environments # List all environments ``` -------------------------------- ### Get all elements and folders Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/additional-features.md Retrieves all elements and folders from the Private API Network. Supports filtering and sorting. ```APIDOC ## GET /network/private ### Description Retrieves all elements and folders from the Private API Network. Supports filtering and sorting. ### Method GET ### Endpoint /network/private ### Parameters #### Query Parameters - **since** (string) - Optional - Filter by creation or update date. - **until** (string) - Optional - Filter by creation or update date. - **panAddedBy** (string) - Optional - Filter by the user who added the element. - **panElementName** (string) - Optional - Filter by element name. - **panSummary** (string) - Optional - Filter by element summary. - **panElementDescription** (string) - Optional - Filter by element description. - **sortCreatedUpdatedAt** (string) - Optional - Sort order for created/updated at fields. - **direction** (string) - Optional - Direction of sorting (ASC/DESC). - **createdBy** (string) - Optional - Filter by the user who created the element. - **offset** (integer) - Optional - Offset for pagination. - **limitDefault1000** (integer) - Optional - Limit for pagination. Defaults to 1000. - **panParentFolderId** (string) - Optional - Filter by parent folder ID. - **elementTypeQuery** (string) - Optional - Filter by element type (api/collection/workspace/folder). ### Responses #### Success Response (200) - `#/components/responses/getPanElementsAndFolders` #### Error Responses - 401: `#/components/responses/common401Error` - 403: `#/components/responses/common403Error` - 500: `#/components/responses/common500ErrorServerError` ``` -------------------------------- ### Get billing account details Source: https://context7.com/delano/postman-mcp-server/llms.txt Retrieve details for a specific billing account. This tool requires no arguments. ```json { "name": "get_accounts", "arguments": {} } ``` -------------------------------- ### Templated Resource URI Formats Source: https://github.com/delano/postman-mcp-server/blob/main/src/handlers/README.md Examples of templated resource URIs handled by the ResourceTemplateHandler. These URIs support parameterized and nested resources. ```plaintext postman://workspaces/{id}/collections # Collections in a workspace postman://apis/{id}/versions # Versions of an API postman://collections/{id}/requests # Requests in a collection ``` -------------------------------- ### Get mock call logs Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/mocks.md Retrieves the call logs for a specific mock server. You can filter and sort the logs by various parameters. ```APIDOC ## Get mock call logs ### Description Retrieves the call logs for a specific mock server. ### Method GET ### Endpoint /mocks/{mockId}/call-logs ### Parameters #### Path Parameters - **mockId** (string) - Required - The ID of the mock server. #### Query Parameters - **limit** (integer) - Optional - The maximum number of call logs to return (default: 100). - **cursor** (string) - Optional - Cursor for pagination. - **until** (string) - Optional - Timestamp to fetch logs until. - **since** (string) - Optional - Timestamp to fetch logs since. - **mockResponseStatusCode** (string) - Optional - Filter by mock response status code. - **mockResponseType** (string) - Optional - Filter by mock response type. - **mockRequestMethod** (string) - Optional - Filter by mock request method. - **mockRequestPath** (string) - Optional - Filter by mock request path. - **mockSortServedAt** (string) - Optional - Sort order for served at time. - **direction** (string) - Optional - Sort direction. - **mockInclude** (string) - Optional - Include additional data in the response. ### Responses #### Success Response (200) - **data** (array) - List of call logs. - **info** (object) - Information about the response. - **success** (boolean) - Indicates if the request was successful. #### Error Responses - **400**: Bad request (e.g., log retention period exceeded). - **401**: Unauthorized. - **404**: Mock server not found. - **500**: Server error. ### Notes - Maximum 6.5MB or 100 call logs per API call. - Retention period is based on the Postman plan. ``` -------------------------------- ### Constructing Environment UID Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/environments.md Demonstrates how to construct the full environment `uid` from owner and environment IDs, as required by the API. ```json { "owner": "31912785", "id": "b8cdb26a-0c58-4f35-9775-4945c39d7ee2", "uid": "31912785-b8cdb26a-0c58-4f35-9775-4945c39d7ee2" } ``` -------------------------------- ### Create Mock Server Source: https://context7.com/delano/postman-mcp-server/llms.txt Creates a mock server from a Postman collection. Requires workspace, mock details including name, collection ID, environment ID, and privacy setting. ```json { "name": "create_mock", "arguments": { "workspace": "1f0df51a-8658-4ee8-a2a1-d2567dfa09a9", "mock": { "name": "Payment API Mock", "collection": "12ece9e1-2abf-4edc-8e34-de66e74114d2", "environment": "31912785-b8cdb26a-0c58-4f35-9775-4945c39d7ee2", "private": true } } } ``` -------------------------------- ### Create mock server Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/mocks.md Creates a new mock server for a given collection. You can specify the name, description, and other settings for the mock server. ```APIDOC ## Create mock server ### Description Creates a new mock server for a collection. ### Method POST ### Endpoint /mocks ### Parameters #### Query Parameters - **workspace** (string) - Optional - The ID of the workspace to create the mock server in. If not specified, it will be created in the Personal workspace. ### Request Body `#/components/requestBodies/createMock` #### Request Body Fields - **collection** (string) - Required - The ID of the collection to mock. - **name** (string) - Required - The name of the mock server. - **description** (string) - Optional - A description for the mock server. - **environment** (string) - Optional - The ID of the environment to use. - **private** (boolean) - Optional - Access control setting (public/private). - **versionTag** (string) - Optional - The version tag of the collection. ### Responses #### Success Response (200) - **data** (object) - Details of the created mock server. - **info** (object) - Information about the response. - **success** (boolean) - Indicates if the request was successful. #### Error Responses - **400**: Bad request (e.g., missing required parameters). - **401**: Unauthorized. - **500**: Server error. ### Notes - Cannot create mocks for collections added to an API definition. ``` -------------------------------- ### Create API Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/apis.md Creates a new API. Requires essential details like name, summary, and workspace ID. ```APIDOC ## POST /apis ### Description Creates a new API. Requires essential details like name, summary, and workspace ID. ### Method POST ### Endpoint /apis ### Parameters #### Query Parameters - **workspaceId** (string) - Required - The ID of the workspace where the API will be created. - **Accept** (string) - Optional - Specifies the desired API version (e.g., `application/vnd.api+json;v=10`). ### Request Body `#/components/requestBodies/createApi` #### Request Body Fields - **name** (string) - Required - The name of the API. - **summary** (string) - Required - A brief description of the API. - **workspaceId** (string) - Required - The ID of the target workspace. ### Responses #### Success Response (200) - **api** (object) - The newly created API object. #### Error Responses - 400: Missing required parameter. - 401: Unauthorized. - 403: Forbidden (e.g., limit reached, feature unavailable). - 404: Workspace not found. - 500: Internal Server Error. ``` -------------------------------- ### Get Collection Comments Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/collections.md Retrieves comments associated with a collection. ```APIDOC ## GET /collections/{collectionId}/comments ### Description Retrieves comments associated with a collection. ### Method GET ### Endpoint /collections/{collectionId}/comments ### Parameters #### Path Parameters - **collectionId** (string) - Required #### Query Parameters - **collectionUid** (string) - Optional - The UID of the collection. ``` -------------------------------- ### Get workspace roles Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/workspaces.md Retrieves the roles for a specific workspace. ```APIDOC ## GET /workspaces/{workspaceId}/roles ### Description Retrieves the roles for a specific workspace. ### Method GET ### Endpoint /workspaces/{workspaceId}/roles ### Parameters #### Path Parameters - **workspaceId** (string) - Required - The ID of the workspace. #### Query Parameters - **workspaceIncludeScimQuery** (string) - Optional - Specifies SCIM information to include. ### Responses #### Success Response (200) - **roles** (array) - A list of roles within the workspace. #### Error Responses - **401**: Unauthorized - **403**: Insufficient permissions - **404**: Resource not found - **500**: Internal Server Error ``` -------------------------------- ### Get Pull Request Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/collections.md Retrieves details of a specific pull request. ```APIDOC ## GET /pull-requests/{pullRequestId} ### Description Retrieves details of a specific pull request. ### Method GET ### Endpoint /pull-requests/{pullRequestId} ### Parameters #### Path Parameters - **pullRequestId** (string) - Required - The ID of the pull request. ``` -------------------------------- ### Get All Forked Collections Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/collections.md Retrieves a list of all collections that have been forked by the user. ```APIDOC ## GET /collections/collection-forks ### Description Get all forked collections ### Method GET ### Endpoint /collections/collection-forks ### Parameters #### Query Parameters - **cursor** (string) - Optional - Cursor for pagination. - **limit** (integer) - Optional - Maximum number of items to return. - **createdAtSort** (string) - Optional - Sort order for creation date (e.g., 'asc', 'desc'). ### Responses #### Success Response (200) `#/components/responses/getCollectionsForkedByUser` #### Error Response (400) `#/components/responses/fork400ErrorNoUserFound` #### Error Response (401) `#/components/responses/common401Error` #### Error Response (500) `#/components/responses/common500Error` ``` -------------------------------- ### Create workspace Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/workspaces.md Creates a new workspace. Supports setting name, description, type, and visibility. ```APIDOC ## POST /workspaces ### Description Creates a new workspace. Supports setting name, description, type, and visibility. ### Method POST ### Endpoint /workspaces ### Request Body - **name** (string) - Required - The name of the workspace. - **description** (string) - Optional - The description of the workspace. - **type** (string) - Optional - The type of the workspace. - **visibility** (string) - Optional - The visibility of the workspace. ### Responses #### Success Response (200) - **workspace** (object) - Details of the created workspace. #### Error Responses - **400**: Malformed request - **401**: Unauthorized - **403**: User lacks permission to create workspaces - **500**: Server Error ``` -------------------------------- ### Get Collection Forks Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/collections.md Retrieves all forks associated with a specific collection. ```APIDOC ## GET /collections/{collectionId}/forks ### Description Get collection forks ### Method GET ### Endpoint /collections/{collectionId}/forks ### Parameters #### Path Parameters - **collectionId** (string) - Required - The ID of the collection. #### Query Parameters - **cursor** (string) - Optional - Cursor for pagination. - **limit** (integer) - Optional - Maximum number of items to return. - **createdAtSort** (string) - Optional - Sort order for creation date (e.g., 'asc', 'desc'). ### Responses #### Success Response (200) `#/components/responses/getCollectionForks` #### Error Response (400) `#/components/responses/forkCollection400ErrorNoForks` #### Error Response (404) `#/components/responses/fork404Error` #### Error Response (500) `#/components/responses/common500Error` ``` -------------------------------- ### Mock Servers Source: https://context7.com/delano/postman-mcp-server/llms.txt APIs for creating and managing mock servers and their responses. ```APIDOC ## create_mock ### Description Creates a mock server instance based on a Postman collection. ### Method Not specified (assumed to be a function call or RPC method) ### Endpoint Not applicable ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body ```json { "name": "create_mock", "arguments": { "workspace": "1f0df51a-8658-4ee8-a2a1-d2567dfa09a9", "mock": { "name": "Payment API Mock", "collection": "12ece9e1-2abf-4edc-8e34-de66e74114d2", "environment": "31912785-b8cdb26a-0c58-4f35-9775-4945c39d7ee2", "private": true } } } ``` ### Request Example ```json { "name": "create_mock", "arguments": { "workspace": "1f0df51a-8658-4ee8-a2a1-d2567dfa09a9", "mock": { "name": "Payment API Mock", "collection": "12ece9e1-2abf-4edc-8e34-de66e74114d2", "environment": "31912785-b8cdb26a-0c58-4f35-9775-4945c39d7ee2", "private": true } } } ``` ### Response #### Success Response (200) Details of the response are not provided in the source. #### Response Example None provided. ``` ```APIDOC ## create_server_response ### Description Adds a custom server response to an existing mock server. Only one server response can be active at a time. Supports simulated response delays. ### Method Not specified (assumed to be a function call or RPC method) ### Endpoint Not applicable ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body ```json { "name": "create_server_response", "arguments": { "mockId": "mock-server-id", "serverResponse": { "name": "Rate Limit Response", "code": 429, "headers": [ { "key": "Retry-After", "value": "60" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\"error\":\"Too Many Requests\"}", "active": true, "delay": 0 } } } ``` ### Request Example ```json { "name": "create_server_response", "arguments": { "mockId": "mock-server-id", "serverResponse": { "name": "Rate Limit Response", "code": 429, "headers": [ { "key": "Retry-After", "value": "60" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\"error\":\"Too Many Requests\"}", "active": true, "delay": 0 } } } ``` ### Response #### Success Response (200) Details of the response are not provided in the source. #### Response Example None provided. ``` ```APIDOC ## get_mock_call_logs ### Description Retrieves call logs for a mock server. Returns up to 100 logs and supports filtering by various criteria. ### Method Not specified (assumed to be a function call or RPC method) ### Endpoint Not applicable ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body ```json { "name": "get_mock_call_logs", "arguments": { "mockId": "mock-server-id", "requestMethod": "POST", "responseStatusCode": 200, "since": "2024-01-01T00:00:00Z", "until": "2024-01-31T23:59:59Z", "include": "request.headers,request.body,response.body", "direction": "desc", "limit": 50 } } ``` ### Request Example ```json { "name": "get_mock_call_logs", "arguments": { "mockId": "mock-server-id", "requestMethod": "POST", "responseStatusCode": 200, "since": "2024-01-01T00:00:00Z", "until": "2024-01-31T23:59:59Z", "include": "request.headers,request.body,response.body", "direction": "desc", "limit": 50 } } ``` ### Response #### Success Response (200) Details of the response are not provided in the source. #### Response Example None provided. ``` ```APIDOC ## publish_mock / unpublish_mock ### Description Controls the visibility of a mock server, making it either public or private. ### Method Not specified (assumed to be a function call or RPC method) ### Endpoint Not applicable ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body For `publish_mock`: ```json { "name": "publish_mock", "arguments": { "mockId": "mock-server-id" } } ``` For `unpublish_mock`: ```json { "name": "unpublish_mock", "arguments": { "mockId": "mock-server-id" } } ``` ### Request Example For `publish_mock`: ```json { "name": "publish_mock", "arguments": { "mockId": "mock-server-id" } } ``` For `unpublish_mock`: ```json { "name": "unpublish_mock", "arguments": { "mockId": "mock-server-id" } } ``` ### Response #### Success Response (200) Details of the response are not provided in the source. #### Response Example None provided. ``` -------------------------------- ### Publish mock server Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/mocks.md Publishes a mock server, making it publicly accessible. ```APIDOC ## Publish mock server ### Description Publishes a mock server, setting its access control to public. ### Method POST ### Endpoint /mocks/{mockId}/publish ### Parameters #### Path Parameters - **mockId** (string) - Required - The ID of the mock server to publish. ### Responses #### Success Response (200) - **data** (object) - Details of the published mock server. - **info** (object) - Information about the response. - **success** (boolean) - Indicates if the request was successful. #### Error Responses - **400**: Bad request (e.g., mock server already published). - **401**: Unauthorized. - **404**: Mock server not found. - **500**: Server error. ``` -------------------------------- ### Get Schema Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/apis.md Retrieves a specific schema by its ID for a given API. ```APIDOC ## GET /apis/{apiId}/schemas/{schemaId} ### Description Retrieves a specific schema by its ID for a given API. ### Method GET ### Endpoint /apis/{apiId}/schemas/{schemaId} ### Parameters #### Path Parameters - **apiId** (string) - Required - The ID of the API. - **schemaId** (string) - Required - The ID of the schema. #### Query Parameters - **v10Accept** (string) - Optional - Accept header for version 1.0. - **apiVersionQuery** (string) - Optional - Query parameter for API version. - **apiSchemaOutput** (string) - Optional - Specifies the output format for the schema. ### Note `versionId` query parameter is required for API viewers. ### Responses #### Success Response (200) - Response details found in `#/components/responses/getApiSchema`. #### Error Responses - **400**: Multiple possible responses: `#/components/schemas/apiSchema400ErrorNotLinked`, `#/components/schemas/v10HeaderMissing`. - **401**: `#/components/responses/api401ErrorUnauthorized`. - **403**: `#/components/responses/api403ErrorAndFeatureUnavailable`. - **404**: `#/components/responses/api404ErrorInstanceNotFound`. - **422**: `#/components/responses/gitLinkedApi422Error`. - **500**: `#/components/responses/common500Error`. ``` -------------------------------- ### Get Workspace Tags Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/workspaces.md Retrieves all tags associated with a specific workspace. ```APIDOC ## GET /workspaces/{workspaceId}/tags ### Description Retrieves all tags associated with a specific workspace. ### Method GET ### Endpoint /workspaces/{workspaceId}/tags ### Parameters #### Path Parameters - **workspaceId** (string) - Required - The ID of the workspace. ``` -------------------------------- ### Get API Tags Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/additional-features.md Retrieves all tags associated with a specific API. ```APIDOC ## GET /apis/{apiId}/tags ### Description Get API tags. ### Method GET ### Endpoint /apis/{apiId}/tags ### Parameters #### Path Parameters - apiId (string): Required - The ID of the API. #### Query Parameters - #/components/parameters/v10Accept ### Responses #### Success Response (200) `#/components/responses/tagGetPut` #### Error Responses - 400: `#/components/responses/v10HeaderMissing` - 401: `#/components/responses/tag401Error` - 403: Multiple possible responses: - `#/components/schemas/tag403Error` - `#/components/schemas/featureUnavailable403Error` - 404: `#/components/responses/tag404Error` - 500: `#/components/responses/tag500Error` ``` -------------------------------- ### Create environment Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/environments.md Creates a new environment. If no workspace is specified, it defaults to 'My Workspace'. The environment name is a required field. ```APIDOC ## Create environment ### Description Creates a new environment. If no workspace is specified, it defaults to 'My Workspace'. The environment name is a required field. ### Method POST ### Endpoint /environments ### Parameters #### Query Parameters - **workspace** (string) - Optional - The workspace ID where the environment will be created. #### Request Body - **name** (string) - Required - The name of the environment. - **values** (array) - Optional - An array of environment variables. - **key** (string) - Variable name. - **value** (string) - Variable value. - **type** (string) - Optional - Variable type (default/secret). - **enabled** (boolean) - Optional - Variable enabled status. ``` -------------------------------- ### Using Full Environment UID in Request Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/environments.md Shows the correct format for specifying the `environmentId` in API requests, emphasizing the use of the full `uid`. ```bash environmentId: 31912785-b8cdb26a-0c58-4f35-9775-4945c39d7ee2 ``` -------------------------------- ### Get Collection Tags Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/additional-features.md Retrieves all tags associated with a specific collection. ```APIDOC ## GET /collections/{collectionId}/tags ### Description Get collection tags. ### Method GET ### Endpoint /collections/{collectionId}/tags ### Parameters #### Path Parameters - collectionId (string): Required - The ID of the collection. ### Responses #### Success Response (200) `#/components/responses/tagGetPut` #### Error Responses - 401: `#/components/responses/tag401Error` - 403: `#/components/responses/tag403Error` - 500: `#/components/responses/tag500Error` ``` -------------------------------- ### Get Workspace Tags Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/additional-features.md Retrieves all tags associated with a specific workspace. ```APIDOC ## GET /workspaces/{workspaceId}/tags ### Description Get workspace tags. ### Method GET ### Endpoint /workspaces/{workspaceId}/tags ### Parameters #### Path Parameters - workspaceId (string): Required - The ID of the workspace. ### Responses #### Success Response (200) `#/components/responses/tagGetPut` #### Error Responses - 401: `#/components/responses/tag401Error` - 403: `#/components/responses/tag403Error` - 404: `#/components/responses/tag404Error` - 500: `#/components/responses/tag500Error` ``` -------------------------------- ### Launch MCP Inspector with pnpm Source: https://github.com/delano/postman-mcp-server/blob/main/README.md Run this command to launch the MCP Inspector for debugging. Access the debugging tools via the provided URL. ```bash pnpm run inspector ``` -------------------------------- ### Get a specific workspace Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/workspaces.md Retrieves details for a specific workspace by its ID. ```APIDOC ## GET /workspaces/{workspaceId} ### Description Retrieves details for a specific workspace by its ID. ### Method GET ### Endpoint /workspaces/{workspaceId} ### Parameters #### Path Parameters - **workspaceId** (string) - Required - The ID of the workspace to retrieve. #### Query Parameters - **workspaceIncludeQuery** (string) - Optional - Includes additional details in the response. ### Responses #### Success Response (200) - **workspace** (object) - Details of the workspace. #### Error Responses - **401**: Unauthorized - **404**: Workspace not found - **500**: Server Error ``` -------------------------------- ### Create Environment Source: https://context7.com/delano/postman-mcp-server/llms.txt Creates a new environment within a workspace, including its variables. ```APIDOC ## create_environment — Create a new environment with variables ### Description Creates a new environment within a specified workspace and defines its variables. Environment IDs follow the format `{ownerId}-{environmentId}`. Variable types can be `default` or `secret`. ### Method POST (assumed) ### Endpoint `/workspaces/:workspace_id/environments` (assumed) ### Parameters #### Request Body - **workspace** (string) - Required - The ID of the workspace to create the environment in. - **environment** (object) - Required - An object containing the environment details. - **name** (string) - Required - The name of the new environment. - **values** (array) - Required - An array of variable objects. - **key** (string) - Required - The variable key. - **value** (string) - Required - The variable value. - **type** (string) - Required - The type of the variable (`default` or `secret`). - **enabled** (boolean) - Required - Whether the variable is enabled. ### Request Example ```json { "name": "create_environment", "arguments": { "workspace": "1f0df51a-8658-4ee8-a2a1-d2567dfa09a9", "environment": { "name": "Production", "values": [ { "key": "baseUrl", "value": "https://api.example.com", "type": "default", "enabled": true }, { "key": "apiKey", "value": "prod-secret-key", "type": "secret", "enabled": true } ] } } } ``` ``` -------------------------------- ### Get specific monitor Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/monitors.md Retrieves details for a specific monitor by its ID. ```APIDOC ## GET /monitors/{monitorId} ### Description Retrieves details for a specific monitor. ### Method GET ### Endpoint /monitors/{monitorId} ### Parameters #### Path Parameters - **monitorId** (string) - Required - The ID of the monitor to retrieve ### Response #### Success Response (200) - `#/components/responses/getMonitor` #### Error Responses - 401: `#/components/responses/common401Error` - 403: `#/components/responses/featureUnavailable403Error` - 404: `#/components/responses/instanceNotFoundMonitor` - 500: `#/components/responses/common500ErrorServerError` ``` -------------------------------- ### List Environments Source: https://context7.com/delano/postman-mcp-server/llms.txt Lists all environments available within a specified workspace. ```APIDOC ## list_environments — List environments in a workspace ### Description Retrieves a list of all environments associated with a given workspace. ### Method GET (assumed) ### Endpoint `/workspaces/:workspace_id/environments` (assumed) ### Parameters #### Query Parameters - **workspace** (string) - Required - The ID of the workspace to list environments from. ### Request Example ```json { "name": "list_environments", "arguments": { "workspace": "1f0df51a-8658-4ee8-a2a1-d2567dfa09a9" } } ``` ``` -------------------------------- ### Create New API Definition Source: https://context7.com/delano/postman-mcp-server/llms.txt Define a new API with its name, summary, and description. The description can include Markdown and links. ```json { "name": "create_api", "arguments": { "name": "Payment Gateway API", "summary": "REST API for payment processing", "description": "Handles charge, refund, and subscription operations.\n\nSee [docs](https://example.com/docs).", "workspaceId": "1f0df51a-8658-4ee8-a2a1-d2567dfa09a9" } } ``` -------------------------------- ### Get workspace global variables Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/workspaces.md Retrieves the global variables for a specific workspace. ```APIDOC ## GET /workspaces/{workspaceId}/global-variables ### Description Retrieves the global variables for a specific workspace. ### Method GET ### Endpoint /workspaces/{workspaceId}/global-variables ### Parameters #### Path Parameters - **workspaceId** (string) - Required - The ID of the workspace. ### Responses #### Success Response (200) - **globalVariables** (object) - An object containing the workspace's global variables. #### Error Responses - **500**: Server Error ``` -------------------------------- ### Get Accounts Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/additional-features.md Retrieves Postman billing account details for the given team. ```APIDOC ## GET /accounts ### Description Gets Postman billing account details for the given team. ### Method GET ### Endpoint /accounts ### Responses #### Success Response (200) - `#/components/responses/getAccounts` #### Error Responses - 400: `#/components/responses/invoicesNoTeam400Error` - 401: `#/components/responses/unauthorizedError` - 500: `#/components/responses/common500ErrorServerError` ``` -------------------------------- ### Configure Claude Desktop for Postman MCP Server Source: https://context7.com/delano/postman-mcp-server/llms.txt Configure Claude Desktop to use the Postman MCP Server by specifying the command, arguments, and environment variables in the configuration file. ```json { "mcpServers": { "postman": { "command": "node", "args": ["/path/to/postman-api-server/build/index.js"], "env": { "POSTMAN_API_KEY": "your-postman-api-key-here" } } } } ``` -------------------------------- ### Implement Environment POST/PUT Request Bodies Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/README.md This prompt guides the review of Postman environment documentation and YAML definitions to understand request bodies for POST/PUT requests. It instructs modifications to the MCP tools implementation, including inline JSDocs, and notes potential updates to MCP protocol endpoints. ```prompt @/docs/api/summaries/environments.md @/docs/api/references/postman-api-requestBodies.yaml Review the postman environment md docs and yaml definitions. Understand the details and nuance of request bodies for POST/PUT requests. Modify out MCP tools implementation accordingly, including inline jsdocs. @src/tools/api/environments.ts @src/types.ts We may also need to update the MCP protocol endpoints to reflect the changes. IOW, updating our code that communicates with the Postman API is one part but we also may need to update the MCP protocol code that communicates with the MCP clients. ``` -------------------------------- ### List Environments in a Workspace Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/README.md This prompt demonstrates how to list environments within a specific workspace using Postman tools. It requires the workspace ID as an argument. ```prompt Use postman tools to list environments in a workspace: 0ddc8458-12e6-48bf-8ff0-490ca0a8f775 ``` -------------------------------- ### Get Schema File Contents Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/apis.md Retrieves the content of a specific file within a schema. ```APIDOC ## GET /apis/{apiId}/schemas/{schemaId}/files/{file-path} ### Description Retrieves the content of a specific file within a schema. ### Method GET ### Endpoint /apis/{apiId}/schemas/{schemaId}/files/{file-path} ### Parameters #### Path Parameters - **apiId** (string) - Required - The ID of the API. - **schemaId** (string) - Required - The ID of the schema. - **file-path** (string) - Required - The path of the file within the schema. #### Query Parameters - **v10Accept** (string) - Optional - Accept header for version 1.0. - **apiVersionQuery** (string) - Optional - Query parameter for API version. ### Note `versionId` query parameter is required for API viewers. ### Responses #### Success Response (200) - Response details found in `#/components/responses/getApiSchemaFileContents`. #### Error Responses - **400**: Multiple possible responses: `#/components/schemas/apiSchema400ErrorNotLinked`, `#/components/schemas/v10HeaderMissing`. - **401**: `#/components/responses/api401ErrorUnauthorized`. - **403**: `#/components/responses/featureUnavailable403Error`. - **404**: `#/components/responses/api404ErrorInstanceNotFound`. - **422**: `#/components/responses/gitLinkedApi422Error`. - **500**: `#/components/responses/common500Error`. ``` -------------------------------- ### Get all workspaces Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/workspaces.md Retrieves a list of all workspaces. Supports filtering by workspace type and creator. ```APIDOC ## GET /workspaces ### Description Retrieves a list of all workspaces. Supports filtering by workspace type and creator. ### Method GET ### Endpoint /workspaces ### Parameters #### Query Parameters - **workspaceTypeQuery** (string) - Optional - Filters workspaces by type. - **workspaceCreatedBy** (string) - Optional - Filters workspaces by creator. - **workspaceIncludeQuery** (string) - Optional - Includes additional details in the response. ### Responses #### Success Response (200) - **workspaces** (array) - List of workspaces. #### Error Responses - **401**: Unauthorized - **500**: Server Error ``` -------------------------------- ### Review Environment API Access and Parameter Naming Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/README.md This prompt focuses on reviewing the Postman MCP tools workspace API access against the Postman API summary, with a specific emphasis on request parameter naming and values for environments. ```prompt @/docs/api/summaries/environments.md Review the postman MCP tools workspace API access against the Postman API summary. Make corrections in our implementation, paying particular attention to the request parameter naming and values. ``` -------------------------------- ### Get Server Response Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/mocks.md Retrieves a specific server response by its ID for a given mock. ```APIDOC ## Get Server Response ### Description Retrieves a specific server response by its ID for a given mock. ### Method GET ### Endpoint `/mocks/{mockId}/server-responses/{serverResponseId}` ### Parameters #### Path Parameters - **mockId** (string) - Required - The ID of the mock. - **serverResponseId** (string) - Required - The ID of the server response. ### Responses #### Success Response (200) - **mockServerResponse** - Details about the server response. #### Error Response (400) - **serverResponseNotFound400Error** - Server response not found. #### Error Response (401) - **common401Error** - Unauthorized access. #### Error Response (404) - **mock400ErrorInstanceNotFound** - Mock instance not found. #### Error Response (500) - **common500ErrorServerError** - Server error. ``` -------------------------------- ### Publish and Unpublish Mock Server Source: https://context7.com/delano/postman-mcp-server/llms.txt Controls the visibility of a mock server. Use 'publish_mock' to make it visible and 'unpublish_mock' to hide it. Requires the mock server ID. ```json { "name": "publish_mock", "arguments": { "mockId": "mock-server-id" } } ``` ```json { "name": "unpublish_mock", "arguments": { "mockId": "mock-server-id" } } ``` -------------------------------- ### Get all monitors Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/monitors.md Retrieves a list of all monitors. Supports query parameters for filtering and pagination. ```APIDOC ## GET /monitors ### Description Retrieves a list of all monitors. ### Method GET ### Endpoint /monitors ### Parameters #### Query Parameters - `#/components/parameters/workspaceResultsQuery` ### Response #### Success Response (200) - `#/components/responses/getMonitors` #### Error Responses - 401: `#/components/responses/common401Error` - 403: `#/components/responses/featureUnavailable403Error` - 500: `#/components/responses/common500ErrorServerError` ``` -------------------------------- ### List Environments Source: https://context7.com/delano/postman-mcp-server/llms.txt List all available environments within a specified workspace. This is useful for retrieving environment IDs and names before performing other environment-related operations. ```json { "name": "list_environments", "arguments": { "workspace": "1f0df51a-8658-4ee8-a2a1-d2567dfa09a9" } } ``` -------------------------------- ### List Workspaces using Postman Tools Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/README.md This prompt instructs the use of Postman tools to list available workspaces. It is a foundational step for managing and interacting with Postman resources. ```prompt Use Postman tools to list our workspaces. ``` -------------------------------- ### Get all collections Source: https://github.com/delano/postman-mcp-server/blob/main/docs/api/summaries/collections.md Retrieves a list of all collections. Supports filtering by workspace, collection name, and pagination. ```APIDOC ## GET /collections ### Description Retrieves a list of all collections. Supports filtering by workspace, collection name, and pagination. Filtering by name is not supported when using limit/offset. An invalid workspace ID returns an empty array with a 200 status. ### Method GET ### Endpoint /collections ### Parameters #### Query Parameters - **workspaceQuery** (string) - Optional - Specifies the workspace to filter collections by. - **collectionNameQuery** (string) - Optional - Specifies the name to filter collections by. - **limitNoDefault** (integer) - Optional - The maximum number of collections to return. - **offsetNoDefault** (integer) - Optional - The number of collections to skip before returning results. ### Responses #### Success Response (200) - **collections** (array) - An array of collection objects. #### Error Response (401) - **error** (object) - Details of the authentication error. #### Error Response (500) - **error** (object) - Details of the server error. ```