@postman/postman-mcp-server/dist/src/tools/getStatusOfAnAsyncApiTask.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 { asMcpError, McpError } from './utils/toolHelpers.js';
export const method = 'getStatusOfAnAsyncApiTask';
export const title = 'Get status of an async API task';
export const description = 'Gets the status of an asynchronous task.';
export const parameters = z.object({
    apiId: z.string().describe("The API's ID."),
    taskId: z.string().describe("The task's ID."),
    Accept: z
        .literal('application/vnd.api.v10+json')
        .describe('The `application/vnd.api.v10+json` request header required to use the endpoint.'),
});
export const annotations = {
    title: 'Get status of an async API task',
    readOnlyHint: true,
    openWorldHint: false,
    destructiveHint: false,
    idempotentHint: true,
};
export async function handler(args, extra) {
    try {
        const endpoint = `/apis/${encodeURIComponent(String(args.apiId))}/tasks/${encodeURIComponent(String(args.taskId))}`;
        const query = new URLSearchParams();
        const url = query.toString() ? `${endpoint}?${query.toString()}` : endpoint;
        const options = {
            headers: extra.headers,
        };
        const result = await extra.client.get(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);
    }
}