UNPKG

@postman/postman-mcp-server

Version:

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)

55 lines (54 loc) • 2.07 kB
import { z } from 'zod'; import { asMcpError, McpError } from './utils/toolHelpers.js'; export const method = 'getPackages'; export const title = 'Get all packages'; export const description = "Lists active packages available to the authenticated user.\nReturns package metadata but does not include index script content. Use getPackage with a returned\npackage ID when you also need the current script. Use the response cursor to fetch\nthe next page when more packages are available.\nDo not use this tool to retrieve a package's script content; use getPackage instead.\n"; export const parameters = z.object({ limit: z .number() .int() .gte(1) .lte(100) .describe('The maximum number of packages to return.') .default(100), cursor: z .string() .describe('The pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter.') .optional(), }); export const annotations = { title: 'Get all packages', readOnlyHint: true, openWorldHint: false, destructiveHint: false, idempotentHint: true, }; export async function handler(args, extra) { try { const endpoint = `/packages`; const query = new URLSearchParams(); if (args.limit !== undefined) query.set('limit', String(args.limit)); if (args.cursor !== undefined) query.set('cursor', String(args.cursor)); 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); } }