Postman MCP Server

🚀 Postman Project Documentation

This project is a Postman toolset designed for the Mail Delivery Protocol (MCP). It allows interaction with the Postman API through AI models to perform complex operational tasks.

🚀 Quick Start

Prerequisites

• Ensure you have pnpm installed on your system.

Installation

pnpm install

Build the Server

pnpm run build

Development Mode (Auto-rebuild)

pnpm run watch

✨ Features

• Utilize the Claude model and Cline extension to convert OpenAPI specifications into TypeScript code, enhancing type safety and integration.
• Provide a Collection SDK for local development and a Postman API for cloud platforms.
• Detail various authentication methods and rate limits for the Postman API.
• Offer comprehensive API endpoint documentation covering core functions such as workspaces, collections, environments, mock servers, and monitoring.

📦 Installation

Install Dependencies

pnpm install

Build the Server

pnpm run build

Development Mode (Auto-rebuild)

pnpm run watch

💻 Usage Examples

Claude Configuration

Add the following configuration to ~/.config/claude/mcp-servers.json in Claude:

{
  "postman": {
    "command": "node",
    "args": ["path/to/postman-api-server/build/index.js"],
    "env": {
      "POSTMAN_API_KEY": "your_api_key_here"
    }
  }
}

Cline Configuration

Add the following content to ~/.config/clinetl/mcp-servers.json in Cline:

{
  "postman": {
    "command": "node",
    "args": ["path/to/postman-api-server/build/index.js"],
    "env": {
      "POSTMAN_API_KEY": "your_api_key_here"
    }
  }
}

Zed Configuration

Currently, we are still trying to solve this problem. According to the Zed documentation, it needs to be used as an extension (refer to this issue #21455).

📚 Documentation

Project Overview

Postman API References and Summaries

This project uses the Claude model and Cline extension to convert OpenAPI specifications into TypeScript code, enhancing type safety and integration. The project includes API reference documentation on GitHub, providing detailed guidance on how to use the Postman platform programmatically.

The main contents include:

• Collection SDK for Local Development: For manual operations in the local environment.
• Postman API for Cloud Platforms: For operations on the online platform.
• Authentication Mechanisms: Detailed explanations of various authentication methods for the Postman API.
• Rate Limits: Explanations of the call frequency limits for the Postman API.
• Comprehensive API Endpoint Documentation: Covering core functions such as workspaces, collections, environments, mock servers, and monitoring.

In addition, the guide provides prerequisites and a quick start guide for using the Postman API. The docs/api/summaries directory contains detailed Markdown summary files, providing comprehensive technical support for developers.

🔧 Technical Details

Debugging Guide

Since the MCP server communicates through standard input and output, debugging is difficult. We recommend using the MCP Inspector, which provides a graphical interface to help developers debug.

Run the following command to start the Inspector:

pnpm run inspector

Access http://localhost:9001 to view real-time logs and debugging information.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for specific terms.