View as Markdown

Postman Integration

Manage Postman workspaces, collections, and environments via the Postman API

The Postman integration provides access to manage Postman workspaces, collections, and environments via the Postman API through the Integrate MCP server.

Installation

The Postman integration is included with the SDK:

import { postmanIntegration } from "integrate-sdk/server";

Setup

Add Postman to your server configuration. Provide credentials via environment variables or integration config:

import { createMCPServer, postmanIntegration } from "integrate-sdk/server";
 
export const { client: serverClient } = createMCPServer({
  apiKey: process.env.INTEGRATE_API_KEY,
  integrations: [
    postmanIntegration({
      // See configuration options below
    }),
  ],
});

Client-Side Usage

import { client } from "integrate-sdk";
 
const result = await client.postman.getMe({});
 
console.log(result);

Environment Variables

  • POSTMAN_API_KEY (when supported by this integration)

Configuration Options

export interface PostmanIntegrationOptions {
  /** Postman API key (defaults to POSTMAN_API_KEY env var) */
  apiKey?: string;

Tools

postman_get_me

Get me

No parameters.

postman_list_workspaces

List workspaces

export interface PostmanListWorkspacesParams { type?: string;

postman_get_workspace

Get workspace

export interface PostmanGetWorkspaceParams { workspace_id: string }

postman_list_collections

List collections

export interface PostmanListCollectionsParams { workspace?: string }

postman_get_collection

Get collection

export interface PostmanGetCollectionParams { collection_uid: string }

postman_delete_collection

Delete collection

export interface PostmanDeleteCollectionParams { collection_uid: string }

postman_list_environments

List environments

export interface PostmanListEnvironmentsParams { workspace?: string }

postman_get_environment

Get environment

export interface PostmanGetEnvironmentParams { environment_uid: string }

postman_create_collection

Create collection

export interface PostmanCreateCollectionParams { workspace: string;

Notes

  • Category: Engineering
  • Authentication mode: API key