@postman/postman-mcp-server 2.7.0 → 2.8.0

package/dist/src/tools/updateCollectionResponse.js

@@ -7,6 +7,75 @@ export const parameters = z.object({
     responseId: z.string().describe("The response's ID."),
     collectionId: z.string().describe("The collection's ID."),
     name: z.string().describe("The response's name.").optional(),
+    description: z.string().nullable().describe("The response's description.").optional(),
+    url: z.string().nullable().describe("The associated request's URL.").optional(),
+    method: z
+        .enum([
+        'GET',
+        'PUT',
+        'POST',
+        'PATCH',
+        'DELETE',
+        'COPY',
+        'HEAD',
+        'OPTIONS',
+        'LINK',
+        'UNLINK',
+        'PURGE',
+        'LOCK',
+        'UNLOCK',
+        'PROPFIND',
+        'VIEW',
+    ])
+        .describe("The request's HTTP method.")
+        .optional(),
+    headers: z
+        .array(z
+        .object({
+        key: z
+            .string()
+            .describe("The header's key, such as `Content-Type` or `X-Custom-Header`."),
+        value: z.string().describe("The header key's value."),
+        description: z.string().nullable().describe("The header's description.").optional(),
+    })
+        .describe('Information about the header.'))
+        .describe('A list of headers.')
+        .optional(),
+    dataMode: z
+        .enum(['raw', 'urlencoded', 'formdata', 'binary', 'graphql'])
+        .describe("The associated request body's data mode.")
+        .optional(),
+    rawModeData: z
+        .string()
+        .nullable()
+        .describe("The associated request body's raw mode data.")
+        .optional(),
+    dataOptions: z
+        .object({
+        raw: z
+            .object({ language: z.string().describe("The raw mode data's language type.").optional() })
+            .describe('Options for the `raw` data mode.')
+            .optional(),
+        urlencoded: z
+            .record(z.string(), z.unknown())
+            .describe('Options for the `urlencoded` data mode.')
+            .optional(),
+        params: z
+            .record(z.string(), z.unknown())
+            .describe('Options for the `params` data mode.')
+            .optional(),
+        binary: z
+            .record(z.string(), z.unknown())
+            .describe('Options for the `binary` data mode.')
+            .optional(),
+        graphql: z
+            .record(z.string(), z.unknown())
+            .describe('Options for the `graphql` data mode.')
+            .optional(),
+    })
+        .nullable()
+        .describe("Additional configurations and options set for the request body's various data modes.")
+        .optional(),
     responseCode: z
         .object({
         code: z.number().describe("The response's HTTP response status code.").optional(),
@@ -14,6 +83,20 @@ export const parameters = z.object({
     })
         .describe("The response's HTTP response code information.")
         .optional(),
+    status: z.string().nullable().describe("The response's HTTP status text.").optional(),
+    time: z
+        .string()
+        .describe('The time taken by the request to complete, in milliseconds.')
+        .optional(),
+    cookies: z.string().nullable().describe("The response's cookie data.").optional(),
+    mime: z.string().nullable().describe("The response's MIME type.").optional(),
+    text: z.string().describe('The raw text of the response body.').optional(),
+    language: z.string().describe("The response body's language type.").optional(),
+    rawDataType: z.string().nullable().describe("The response's raw data type.").optional(),
+    requestObject: z
+        .string()
+        .describe('A JSON-stringified representation of the associated request.')
+        .optional(),
 });
 export const annotations = {
     title: 'Updates a response in a collection. For a complete list of properties, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).',
@@ -29,8 +112,38 @@ export async function handler(args, extra) {
         const bodyPayload = {};
         if (args.name !== undefined)
             bodyPayload.name = args.name;
+        if (args.description !== undefined)
+            bodyPayload.description = args.description;
+        if (args.url !== undefined)
+            bodyPayload.url = args.url;
+        if (args.method !== undefined)
+            bodyPayload.method = args.method;
+        if (args.headers !== undefined)
+            bodyPayload.headers = args.headers;
+        if (args.dataMode !== undefined)
+            bodyPayload.dataMode = args.dataMode;
+        if (args.rawModeData !== undefined)
+            bodyPayload.rawModeData = args.rawModeData;
+        if (args.dataOptions !== undefined)
+            bodyPayload.dataOptions = args.dataOptions;
         if (args.responseCode !== undefined)
             bodyPayload.responseCode = args.responseCode;
+        if (args.status !== undefined)
+            bodyPayload.status = args.status;
+        if (args.time !== undefined)
+            bodyPayload.time = args.time;
+        if (args.cookies !== undefined)
+            bodyPayload.cookies = args.cookies;
+        if (args.mime !== undefined)
+            bodyPayload.mime = args.mime;
+        if (args.text !== undefined)
+            bodyPayload.text = args.text;
+        if (args.language !== undefined)
+            bodyPayload.language = args.language;
+        if (args.rawDataType !== undefined)
+            bodyPayload.rawDataType = args.rawDataType;
+        if (args.requestObject !== undefined)
+            bodyPayload.requestObject = args.requestObject;
         const options = {
             body: JSON.stringify(bodyPayload),
             contentType: ContentType.Json,

package/dist/src/tools/updateWorkspace.js

@@ -2,7 +2,7 @@ import { z } from 'zod';
 import { ContentType } from '../clients/postman.js';
 import { asMcpError, McpError } from './utils/toolHelpers.js';
 export const method = 'updateWorkspace';
-export const description = 'Updates a workspace.\n\n**Note:**\n\n- There are rate limits when publishing public workspaces.\n- Public team workspace names must be unique.\n\n### Important\n\nWe deprecated linking collections or environments between workspaces. We do not recommend that you do this.\n\nIf you have a linked collection or environment, note the following:\n- The endpoint does not create a clone of a collection or environment.\n- Any changes you make to a linked collection or environment changes them in all workspaces.\n- If you delete a collection or environment linked between workspaces, the system deletes it in all the workspaces.\n';
+export const description = 'Updates a workspace.\n\n**Note:**\n\n- This endpoint does not support the following visibility changes:\n  - \\`private\\` to \\`public\\`, \\`public\\` to \\`private\\`, and \\`private\\` to \\`personal\\` for **Free** and **Solo** [plans](https://www.postman.com/pricing/).\n  - \\`public\\` to \\`personal\\` for team users only.\n- There are rate limits when publishing public workspaces.\n- Public team workspace names must be unique.\n';
 export const parameters = z.object({
     workspaceId: z.string().describe("The workspace's ID."),
     workspace: z

package/dist/src/tools/utils/errorTemplateRenderer.js

@@ -0,0 +1,23 @@
+import { existsSync } from 'node:fs';
+import { join } from 'node:path';
+import nunjucks from 'nunjucks';
+export function createErrorTemplateRenderer(errorsDir) {
+    const env = nunjucks.configure(errorsDir, {
+        autoescape: false,
+        noCache: false,
+        throwOnUndefined: false,
+    });
+    env.addFilter('default', (val, defaultVal = '') => val === undefined || val === null ? defaultVal : val);
+    return (toolName, statusCode, context) => {
+        const templateFile = `${toolName}.${statusCode}.njk`;
+        const templatePath = join(errorsDir, templateFile);
+        if (!existsSync(templatePath))
+            return null;
+        try {
+            return env.render(templateFile, context);
+        }
+        catch {
+            return null;
+        }
+    };
+}

package/dist/src/views/errors/getCollectionFolder.404.njk

@@ -0,0 +1,5 @@
+Collection folder not found: {{ args.folderId }} in collection {{ args.collectionId }}
+{% if error and (error.detail or error.message) %}
+API detail: {{ error.detail or error.message }}
+{% endif %}
+Verify both the collection ID and folder ID are correct.

package/dist/src/views/errors/getCollectionRequest.404.njk

@@ -0,0 +1,5 @@
+Collection request not found: {{ args.requestId }} in collection {{ args.collectionId }}
+{% if error and (error.detail or error.message) %}
+API detail: {{ error.detail or error.message }}
+{% endif %}
+Verify both the collection ID and request ID are correct.

package/dist/src/views/errors/getCollectionResponse.404.njk

@@ -0,0 +1,5 @@
+Collection response not found: {{ args.responseId }} in collection {{ args.collectionId }}
+{% if error and (error.detail or error.message) %}
+API detail: {{ error.detail or error.message }}
+{% endif %}
+Verify both the collection ID and response ID are correct.

package/dist/src/views/errors/getEnvironment.404.njk

@@ -0,0 +1,5 @@
+Environment not found: {{ args.environmentId }}
+{% if error and (error.detail or error.message) %}
+API detail: {{ error.detail or error.message }}
+{% endif %}
+Verify the environment ID is correct. Use getEnvironments to list available environments.

package/dist/src/views/errors/getMock.404.njk

@@ -0,0 +1,5 @@
+Mock server not found: {{ args.mockId }}
+{% if error and (error.detail or error.message) %}
+API detail: {{ error.detail or error.message }}
+{% endif %}
+Verify the mock ID is correct. Use getMocks to list available mock servers.

package/dist/src/views/errors/getMonitor.404.njk

@@ -0,0 +1,5 @@
+Monitor not found: {{ args.monitorId }}
+{% if error and (error.detail or error.message) %}
+API detail: {{ error.detail or error.message }}
+{% endif %}
+Verify the monitor ID is correct. Use getMonitors to list available monitors.

package/dist/src/views/errors/getSpec.404.njk

@@ -0,0 +1,5 @@
+API specification not found: {{ args.specId }}
+{% if error and (error.detail or error.message) %}
+API detail: {{ error.detail or error.message }}
+{% endif %}
+Verify the spec ID is correct. Use getAllSpecs to list available specifications.

package/dist/src/views/errors/getWorkspace.404.njk

@@ -0,0 +1,5 @@
+Workspace not found: {{ args.workspaceId }}
+{% if error and (error.detail or error.message) %}
+API detail: {{ error.detail or error.message }}
+{% endif %}
+Verify the workspace ID is correct and that your API key has access to this workspace.

package/dist/src/views/getWorkspaces.njk

@@ -1,6 +1,6 @@
 # Workspaces
 
-| id | name | type | visibility | createdBy | scim |
-|---|---|---|---|---|---|
-{% for item in workspaces %}| {{ item.id }} | {{ item.name }} | {{ item.type }} | {{ item.visibility }} | {{ item.createdBy }} | {{ item.scim | dump }} |
+| id | name | type | visibility | createdBy | about | createdAt | updatedAt | scim |
+|---|---|---|---|---|---|---|---|---|
+{% for item in workspaces %}| {{ item.id }} | {{ item.name }} | {{ item.type }} | {{ item.visibility }} | {{ item.createdBy }} | {{ item.about }} | {{ item.createdAt }} | {{ item.updatedAt }} | {{ item.scim | dump }} |
 {% endfor %}

package/package.json

@@ -1,22 +1,10 @@
 {
   "name": "@postman/postman-mcp-server",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "A simple MCP server to operate on the Postman API",
   "mcpName": "com.postman/postman-mcp-server",
   "main": "dist/src/index.js",
   "type": "module",
-  "scripts": {
-    "start:stdio": "node dist/src/index.js",
-    "build": "eslint --fix ./src && prettier --write \"src/**/*.ts\" && tsc",
-    "prepack": "npm run build",
-    "test": "vitest",
-    "lint": "eslint",
-    "lint:fix": "eslint --fix",
-    "preversion": "npm run build",
-    "version": "git add dist/",
-    "release": "npm version",
-    "release-custom": "node scripts/release.js"
-  },
   "bin": "dist/src/index.js",
   "files": [
     "dist",
@@ -27,23 +15,23 @@
     "access": "public"
   },
   "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.25.2",
-    "dotenv": "^17.2.3",
-    "newman": "^6.2.0",
+    "@modelcontextprotocol/sdk": "^1.27.1",
+    "dotenv": "^17.3.1",
+    "newman": "^6.2.2",
     "nunjucks": "^3.2.4",
     "uuid": "^13.0.0",
     "zod": "^3.25.76"
   },
   "devDependencies": {
-    "@eslint/js": "^9.39.1",
+    "@eslint/js": "^10.0.1",
     "@types/node": "^24",
-    "eslint": "^9.39.1",
+    "eslint": "^10.0.2",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-unused-imports": "^4.3.0",
-    "prettier": "^3.6.2",
+    "eslint-plugin-unused-imports": "^4.4.1",
+    "prettier": "^3.8.1",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.48.0",
-    "vitest": "^4.0.13"
+    "typescript-eslint": "^8.56.1",
+    "vitest": "^4.0.18"
   },
   "engines": {
     "node": ">=20.0.0"
@@ -57,5 +45,17 @@
   "bugs": {
     "url": "https://github.com/postmanlabs/postman-mcp-server/issues"
   },
-  "homepage": "https://github.com/postmanlabs/postman-mcp-server#readme"
-}
+  "homepage": "https://github.com/postmanlabs/postman-mcp-server#readme",
+  "scripts": {
+    "preinstall": "npx only-allow pnpm",
+    "start:stdio": "node dist/src/index.js",
+    "build": "eslint --fix ./src && prettier --write \"src/**/*.ts\" && tsc",
+    "test": "vitest",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    "preversion": "pnpm run build",
+    "version": "git add dist/",
+    "release": "pnpm version",
+    "release-custom": "node scripts/release.js"
+  }
+}

package/dist/src/tools/deletePanElementOrFolder.js

@@ -1,41 +0,0 @@
-import { z } from 'zod';
-import { asMcpError, McpError } from './utils/toolHelpers.js';
-export const method = 'deletePanElementOrFolder';
-export const description = "Removes an element or delete a folder from your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).\n\n**Note:**\n\nRemoving an API, collection, or workspace element does not delete it. It only removes it from the Private API Network folder.\n";
-export const parameters = z.object({
-    elementId: z
-        .string()
-        .describe("The element's ID or UUID. For Postman Collections you must pass the collection's UID (`userId`-`collectionId`) value."),
-    elementType: z.enum(['api', 'folder', 'collection', 'workspace']).describe('The element type.'),
-});
-export const annotations = {
-    title: "Removes an element or delete a folder from your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).",
-    readOnlyHint: false,
-    destructiveHint: true,
-    idempotentHint: true,
-};
-export async function handler(args, extra) {
-    try {
-        const endpoint = `/network/private/${args.elementType}/${args.elementId}`;
-        const query = new URLSearchParams();
-        const url = query.toString() ? `${endpoint}?${query.toString()}` : endpoint;
-        const options = {
-            headers: extra.headers,
-        };
-        const result = await extra.client.delete(url, options);
-        return {
-            content: [
-                {
-                    type: 'text',
-                    text: `${typeof result === 'string' ? result : JSON.stringify(result, null, 2)}`,
-                },
-            ],
-        };
-    }
-    catch (e) {
-        if (e instanceof McpError) {
-            throw e;
-        }
-        throw asMcpError(e);
-    }
-}

package/dist/src/tools/postPanElementOrFolder.js

@@ -1,84 +0,0 @@
-import { z } from 'zod';
-import { ContentType } from '../clients/postman.js';
-import { asMcpError, McpError } from './utils/toolHelpers.js';
-export const method = 'postPanElementOrFolder';
-export const description = "Publishes a element or creates a folder in your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). An element is a Postman API, collection, or workspace.\n\n**Note:**\n\nYou can only pass one element object type per call. For example, you cannot pass both \\`api\\` and \\`collection\\` in a single request.\n";
-export const parameters = z.object({
-    body: z.union([
-        z.object({
-            api: z
-                .object({
-                id: z.string().describe("The API's ID."),
-                parentFolderId: z.number().int().describe("The API's parent folder ID."),
-            })
-                .optional(),
-        }),
-        z.object({
-            collection: z
-                .object({
-                id: z.string().describe("The collection's ID."),
-                parentFolderId: z.number().int().describe("The collection's parent folder ID."),
-                environments: z
-                    .array(z.string().describe("An environment's UID."))
-                    .describe('A list of environment UIDs (`userId`-`environmentId`) to add to the collection.')
-                    .optional(),
-            })
-                .optional(),
-        }),
-        z.object({
-            workspace: z
-                .object({
-                id: z.string().describe("The workspace's ID."),
-                parentFolderId: z.number().int().describe("The workspace's parent folder ID."),
-            })
-                .optional(),
-        }),
-        z.object({
-            folder: z
-                .object({
-                name: z.string().describe("The folder's name."),
-                description: z.string().describe("The folder's description.").optional(),
-                parentFolderId: z
-                    .number()
-                    .int()
-                    .describe("The folder's parent folder ID. This value defaults to `0`. To create a folder at the root level, omit this property.")
-                    .default(0),
-            })
-                .optional(),
-        }),
-    ]),
-});
-export const annotations = {
-    title: "Publishes a element or creates a folder in your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). An element is a Postman API, collection, or workspace.",
-    readOnlyHint: false,
-    destructiveHint: false,
-    idempotentHint: false,
-};
-export async function handler(args, extra) {
-    try {
-        const endpoint = `/network/private`;
-        const query = new URLSearchParams();
-        const url = query.toString() ? `${endpoint}?${query.toString()}` : endpoint;
-        const bodyPayload = args.body;
-        const options = {
-            body: JSON.stringify(bodyPayload),
-            contentType: ContentType.Json,
-            headers: extra.headers,
-        };
-        const result = await extra.client.post(url, options);
-        return {
-            content: [
-                {
-                    type: 'text',
-                    text: `${typeof result === 'string' ? result : JSON.stringify(result, null, 2)}`,
-                },
-            ],
-        };
-    }
-    catch (e) {
-        if (e instanceof McpError) {
-            throw e;
-        }
-        throw asMcpError(e);
-    }
-}

package/dist/src/tools/updatePanElementOrFolder.js

@@ -1,100 +0,0 @@
-import { z } from 'zod';
-import { ContentType } from '../clients/postman.js';
-import { asMcpError, McpError } from './utils/toolHelpers.js';
-export const method = 'updatePanElementOrFolder';
-export const description = "Updates an element or folder in your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).\n\n**Note:**\n\nYou can only pass one element object type per call. For example, you cannot pass both \\`api\\` and \\`collection\\` in a single request.\n";
-export const parameters = z.object({
-    elementId: z
-        .string()
-        .describe("The element's ID or UUID. For Postman Collections you must pass the collection's UID (`userId`-`collectionId`) value."),
-    elementType: z.enum(['api', 'folder', 'collection', 'workspace']).describe('The element type.'),
-    body: z.union([
-        z.object({
-            api: z
-                .object({
-                parentFolderId: z.number().int().describe("The API's new parent folder ID.").optional(),
-            })
-                .optional(),
-        }),
-        z.object({
-            collection: z
-                .object({
-                parentFolderId: z
-                    .number()
-                    .int()
-                    .describe("The collection's new parent folder ID.")
-                    .optional(),
-                environments: z
-                    .object({
-                    $add: z
-                        .array(z.string().describe('The ID of environment to add to the collection.'))
-                        .optional(),
-                    $remove: z
-                        .array(z.string().describe('The ID of environment to remove from the collection.'))
-                        .optional(),
-                })
-                    .describe("The collection's updated environments.")
-                    .optional(),
-            })
-                .optional(),
-        }),
-        z.object({
-            workspace: z
-                .object({
-                parentFolderId: z
-                    .number()
-                    .int()
-                    .describe("The workspace's new parent folder ID.")
-                    .optional(),
-            })
-                .optional(),
-        }),
-        z.object({
-            folder: z
-                .object({
-                name: z.string().describe("The folder's new name.").optional(),
-                description: z.string().describe("The folder's updated description.").optional(),
-                parentFolderId: z
-                    .number()
-                    .int()
-                    .describe("The folder's new parent folder ID.")
-                    .optional(),
-            })
-                .optional(),
-        }),
-    ]),
-});
-export const annotations = {
-    title: "Updates an element or folder in your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).",
-    readOnlyHint: false,
-    destructiveHint: false,
-    idempotentHint: true,
-};
-export async function handler(args, extra) {
-    try {
-        const endpoint = `/network/private/${args.elementType}/${args.elementId}`;
-        const query = new URLSearchParams();
-        const url = query.toString() ? `${endpoint}?${query.toString()}` : endpoint;
-        const bodyPayload = args.body;
-        const options = {
-            body: JSON.stringify(bodyPayload),
-            contentType: ContentType.Json,
-            headers: extra.headers,
-        };
-        const result = await extra.client.put(url, options);
-        return {
-            content: [
-                {
-                    type: 'text',
-                    text: `${typeof result === 'string' ? result : JSON.stringify(result, null, 2)}`,
-                },
-            ],
-        };
-    }
-    catch (e) {
-        if (e instanceof McpError) {
-            throw e;
-        }
-        throw asMcpError(e);
-    }
-}