@postman/postman-mcp-server/dist/src/tools/updateMock.js

Postman MCP Server — connect AI agents (Claude Code, Cursor, VS Code Copilot, Gemini CLI) to your Postman collections, specifications, and environments via Model Context Protocol (MCP)

import { z } from 'zod';
import { ContentType } from '../clients/postman.js';
import { asMcpError, McpError } from './utils/toolHelpers.js';
export const method = 'updateMock';
export const title = 'Update a mock server';
export const description = "Updates a mock server.\n- Resource: Mock server entity associated with a collection UID.\n- Use this to change name, environment, privacy, or default server response.\n- To activate a server response, set \\`config.serverResponseId\\` to the server response's \\`id\\`. Pass \\`null\\` to deactivate.\n";
export const parameters = z.object({
    mockId: z.string().describe("The mock's ID."),
    mock: z
        .object({
        name: z.string().describe("The mock server's name.").optional(),
        environment: z.string().describe("The associated environment's unique ID.").optional(),
        description: z.string().describe("The mock server's description.").optional(),
        private: z
            .boolean()
            .describe('If true, the mock server is set private. By default, mock servers are public and can receive requests from anyone and anywhere.')
            .default(false),
        versionTag: z.string().describe("The API's version tag ID.").optional(),
        collection: z
            .string()
            .describe("The associated collection's unique ID. This is a mandatory parameter."),
        config: z
            .object({
            serverResponseId: z
                .string()
                .nullable()
                .describe('The server response ID. This sets the given server response as the default response for each request. To deactivate a server response, pass a null value.')
                .optional(),
        })
            .describe("The mock server's configuration settings.")
            .optional(),
    })
        .describe('The mock server fields to update.')
        .optional(),
});
export const annotations = {
    title: 'Update a mock server',
    readOnlyHint: false,
    openWorldHint: true,
    destructiveHint: false,
    idempotentHint: true,
};
export async function handler(args, extra) {
    try {
        const endpoint = `/mocks/${encodeURIComponent(String(args.mockId))}`;
        const query = new URLSearchParams();
        const url = query.toString() ? `${endpoint}?${query.toString()}` : endpoint;
        const bodyPayload = {};
        if (args.mock !== undefined)
            bodyPayload.mock = args.mock;
        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);
    }
}