Postman MCP Server Aio

A Postman MCP service based on Cloudflare Worker, providing the function of accessing Postman collections and environments through the Claude AI interface, supporting operations such as collection management, environment variable configuration, and test execution.

Developer tools Cloud platform #Postman Integration #API Testing #Cloud Service #AI - Assisted .TypeScript

rating : 2.5 points

downloads : 10.0K

update time : 2025-04-23

Open Site

What is the Postman MCP Server?

The Postman MCP Server is a tool based on Cloudflare Workers that allows you to interact with Postman collections and environments through Claude AI's MCP (Model Control Plane) interface. This enables you to easily manage, test, and run your APIs while integrating them into broader AI workflows.

How to use the Postman MCP Server?

To get started, simply deploy the server and add your Postman API key to the environment variables. Then, you can use the CLI or API to manage and execute Postman collections and environments.

Use Cases

The Postman MCP Server is well - suited for workflows that require automated API testing, documentation generation, and API management. Both developers and teams can use it to simplify the API development process.

Main Features

Get Collections

List all available Postman collections.

Create Collection

Create a new Postman collection to store API requests.

Run Collection

Run a collection in a specified environment and view test results.

Add Request

Add a new API request to an existing collection.

Manage Environment

Get, create, and modify Postman environment variables.

Advantages

Simplify API management through AI - driven tools.

Support quick integration into existing workflows.

Start using without complex configuration.

Flexibly support multiple Postman functions.

Limitations

Require a valid Postman API key.

May have limited performance for large - scale API collections.

Some advanced features may require additional setup.

How to Use

Clone the Project Repository

First, clone the code of this project to your local machine.

Install Dependencies

Make sure Node.js and npm are installed, then install the required dependencies.

Configure Environment Variables

Copy the .env.example file to .env and add your Postman API key.

Deploy to Cloudflare Workers

Use the Wrangler tool to deploy the server to Cloudflare Workers.

Usage Examples

Example 1: Get Collections

Use mcp__get_collections() to get all collections in the current account.

Example 2: Create Collection

Create a new collection through mcp__create_collection().

Frequently Asked Questions

How to get a Postman API key?

Can I run multiple collections?

Related Resources

Postman Official Documentation

Learn more features and best practices of Postman.

Cloudflare Workers Official Website

Learn how to use Cloudflare Workers to build efficient services.

🚀 Postman MCP Server

A Cloudflare Worker that provides API access to Postman collections and environments through Claude AI's MCP (Model Control Plane) interface.

🚀 Quick Start

Clone this repository.
Install dependencies: npm install.
Copy .env.example to .env and add your Postman API key.
Deploy to Cloudflare Workers: wrangler deploy.

✨ Features

This server allows Claude AI to interact with your Postman collections and environments to perform the following operations:

Get all collections.
Get detailed information about a specific collection.
Create a new collection.
Add requests to a collection.
Run a collection and get test results. This enables Claude to assist you with API testing, documentation writing, and management tasks.

📦 Installation

Clone this repository.
Install dependencies: npm install.
Copy .env.example to .env and add your Postman API key.
Deploy to Cloudflare Workers: wrangler deploy.

💻 Usage Examples

Basic Usage

To run the server locally for development:

npm run dev

This will start the server locally using wrangler.

Advanced Usage

To deploy to Cloudflare Workers:

npm run deploy

Make sure your wrangler.toml file is configured correctly.

📚 Documentation

Current Methods

The Postman MCP server provides the following methods:

Basic Utility Methods

mcp__sayHello(name) - Returns a greeting with the provided name.
mcp__reverseString(input) - Reverses the character order in a string.

Collection Methods

mcp__get_collections() - Gets all collections in your Postman account.
mcp__get_collection(collectionId) - Gets detailed information about a specific collection.
mcp__create_collection(name, description) - Creates a new collection.
mcp__add_request(collectionId, name, method, url, ...) - Adds a request to a collection.

Environment Methods

mcp__get_environments() - Gets all environments in your Postman account.
mcp__get_environment(environmentId) - Gets detailed information about a specific environment.
mcp__create_environment(name, variables) - Creates a new environment with variables.

Test Execution

mcp__run_collection(collectionId, environmentId) - Runs a collection with an optional environment.

🔧 Technical Details

Project Structure

/src - Source code
- /interfaces - TypeScript interfaces
- /services - Service classes
- index.ts - Main worker program entry point
/test - Unit tests
/examples - Example usage
/docs - Additional documentation

Example

Refer to the examples/postman-examples.md file for detailed examples of how to use the Postman MCP server in conjunction with Claude AI.

📄 License

No license information provided in the original README.

⚠️ Important Note

This server requires a Postman API key to run. Ensure that the key is securely stored in Cloudflare Worker environment variables and not committed to version control.