@postman/postman-mcp-server/dist/src/tools/getCollections.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 = 'getCollections';
export const title = 'Get all collections';
export const description = 'The workspace ID query is required for this endpoint. If not provided, the LLM should ask the user to provide it.';
export const parameters = z.object({
    workspace: z.string().describe("The workspace's ID."),
    name: z
        .string()
        .describe('Filter results by collections whose name exactly matches the given value. Partial or substring matches are not supported.')
        .optional(),
    limit: z
        .number()
        .int()
        .gte(1)
        .lte(99)
        .describe('The maximum number of rows to return in the response.')
        .optional(),
    offset: z
        .number()
        .int()
        .describe('The zero-based offset of the first item to return.')
        .optional(),
});
export const annotations = {
    title: 'Get all collections',
    readOnlyHint: true,
    openWorldHint: false,
    destructiveHint: false,
    idempotentHint: true,
};
export async function handler(args, extra) {
    try {
        const endpoint = `/collections`;
        const query = new URLSearchParams();
        if (args.workspace !== undefined)
            query.set('workspace', String(args.workspace));
        if (args.name !== undefined)
            query.set('name', String(args.name));
        if (args.limit !== undefined)
            query.set('limit', String(args.limit));
        if (args.offset !== undefined)
            query.set('offset', String(args.offset));
        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);
    }
}