Postman API V3

by postmanv3

Not rated
GitHub

About

MCP server for Postman API v3

Details

Author
postmanv3
Categories
Web Scraping

Setup

Install Postman API V3 in your MCP client (Claude Desktop, Cursor, Windsurf, and others).

Repository: https://github.com/postmanv3/postman-mcp-server

Follow the installation instructions in the repository README, then restart your MCP client.

An MCP server that provides access to thePostmanAPI. Functionality is based on theofficial OpenAPI specification. For more information, see thePostman API documentation.

This project is part of the Model Context Protocol (MCP) initiative from Anthropic. For more information, visit theMCP GitHub repositoryand the announcement on theAnthropic blog.

[!WARNING] This project is currently under active development. Please use with caution and expect breaking changes.

[!NOTE] AI Generated Code. I used Cline v2.2.2 with Claude 3.5 Sonnet (2024-10-22). See docs/README.md for prompts and details about how this code was generated.

- Overview
-
Features

- Collections
-
Environments
-
APIs
-
Authentication & Authorization
-
Additional Features

- Setting up API Keys
-
Using Claude Desktop
-
Using Cline
-
Using Zed

Postman MCP Server is a TypeScript-based MCP server that integrates with the Postman API, providing comprehensive management of Postman collections, environments, and APIs.

- CRUD Operations: Create, retrieve, and update Postman collections.
- Folder Management: Organize requests into folders within collections.
- Request Management: Add and update requests within collections.
- Response Management: Manage responses associated with requests.
- Version Control: Fork, merge, and pull changes for collections.
- Comments: Add and manage comments on collections.

- Manage Environments: Create and retrieve environments for different setups.
- CRUD Operations: Full support for creating, updating, and deleting environments.

- API Management: Create, retrieve, update, and delete APIs.
- Schema Support: Manage API schemas with multi-file support.
- Tagging: Add and manage tags for APIs.
- Comments: Add and manage comments on APIs.

- API Key Authentication: Secure access using API keys.
- Role-Based Access Control: Manage permissions at workspace and collection levels.
- Workspace Permissions: Define permissions specific to workspaces.

- Private API Network: Manage elements and folders within a private API network.
- Webhooks: Create webhooks to trigger collections with custom payloads.
- Enterprise Features: Advanced role controls and SCIM support for enterprise environments.

npm install -g @postmanv3/postman-mcp-server
npm install @postmanv3/postman-mcp-server

To install Postman MCP Server for Claude Desktop automatically viaSmithery:

npx -y @smithery/cli install postman-api-server --client claude
git clone https://github.com/PostmanV3/postman-mcp-server.git cd postman-mcp-server

Run in development mode with auto-rebuild:

- VisitPostman Account Settings
- Click "Generate API Key"
- Save the key securely - it won't be shown again

- Add the key to your environment asPOSTMAN_API_KEY
- For Claude Desktop or Cline, include it in your config file (see configuration examples below)
- Never commit API keys to version control

- The API key provides access to all Postman resources you have permissions for
- Test access by running a simple query (e.g., list workspaces)

[!NOTE] If you're using thePostman API collectiondirectly, store your API key as apostman-api-keycollection variable.

To use with Claude Desktop, add the server config:

- macOS:~/Library/Application Support/Claude/claude_desktop_config.json
- Windows:%APPDATA%/Claude/claude_desktop_config.json

[!IMPORTANT] If you're updating this provider, Claude must be restarted to pick up API changes from the input schema (i.e. When the MCP server's ToolDefinition elements have changed). This is because Claude caches the tool definitions when it starts up.

Recommended: Using npx(works with both global and local installations):

{ "mcpServers": { "postman": { "command": "npx", "args": [ "-y", "@postmanv3/postman-mcp-server" ], "env": { "POSTMAN_API_KEY": "CHANGEME" } } } }

Alternative: Direct path(if installed locally):

{ "mcpServers": { "postman": { "command": "node", "args": [ "./node_modules/@postmanv3/postman-mcp-server/build/index.js" ], "env": { "POSTMAN_API_KEY": "CHANGEME" } } } }

Alternative: Global installation path(typical paths - find yours withnpm root -g):

{ "mcpServers": { "postman": { "command": "node", "args": [ "/usr/local/lib/node_modules/@postmanv3/postman-mcp-server/build/index.js" ], "env": { "POSTMAN_API_KEY": "CHANGEME" } } } }

[!NOTE] To find your global node_modules path, runnpm root -gand replace the path above accordingly.

[!TIP] Thenpxapproach is recommended as it automatically finds the package whether it's installed globally or locally, and handles updates automatically.

Using the same example configuration, add the server config to your Cline MCP Servers configuration:

I'm still trying to get this to work. From theZed docsit looks like it needs to be an extension (also this issue #21455).

The officialPostman API documentationis available in thePostman Public Workspace.

This project leverages the Claude model and Cline extension to convert the OpenAPI specification into TypeScript code, enhancing type safety and integration within the MCP server.

This GitHub project includesAPI References documentationthat provides detailed guidance on utilizing the Postman platform programmatically. It covers both the Collection SDK for local development and the Postman API for cloud platform integration. Key topics include authentication mechanisms, rate limits, and in-depth documentation of all API endpoints, including workspaces, collections, environments, and more. Additionally, the guide offers prerequisites and quick-start instructions to facilitate seamless API interactions.

Thedocs/api/summariesdirectory contains comprehensive Markdown summaries of the Postman API. These documents outline API endpoints, request/response formats, and implementation details essential for validating and ensuring the functionality of the MCP server. Refer to theAPI Summaries READMEfor an overview of the documentation structure and implementation strategies.

Converting OpenAPI Spec to TypeScript Code with Claude

Refer to theHandlers Documentationfor detailed specifications on implementing MCP server handlers. This includes URI formats, prompt requirements, and resource handling patterns. This guide is crucial for developers working on integrating and enhancing the Postman API functionalities within the MCP server.

The MCP wrapper for Postman tools makes sense primarily as an AI interaction layer for complex, multi-step operations where structure and safety are paramount. However, it may be overengineered for simple operations where direct CLI or API usage would suffice. The MCP wrapper provides most value when:

- Managing multiple collections
- Coordinating environments
- Generating comprehensive reports

- Automated testing workflows
- API documentation maintenance
- Environment management

- Critical API testing
- Production deployments
- Compliance checking

- Basic collection runs
- Single API calls
- Quick environment checks

- Developer-driven operations
- Local testing
- Quick iterations

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using theMCP Inspector, available as a package script:

npm run inspector # or pnpm run inspector

The Inspector will provide a URL to access debugging tools in your browser:http://localhost:5173. You will need to add the POSTMAN_API_KEY before connecting. Navigate to "Tools" to get started.

- Awesome MCP Servers by AppCypher
-
Awesome MCP Servers by PunkPeye

This project is licensed under the MIT License. See theLICENSEfile for details.

This MCP server is for research purposes only. Any data collection or monitoring will be conducted solely for security research purposes.

Enable AI agents to get structured data from unstructured web with AgentQL.

Web scraping, crawling, and change detection with AI

Official Apify MCP server for AI agents to run Actors, extract website data, and automate web scraping and crawling workflows.

1GB Free Trial, World's Leading Proxy Service Platform, Efficient Data Collection

Discover, extract, and interact with the web - one interface powering automated access across the public internet.

Automate browser interactions in the cloud (e.g. web navigation, data extraction, form filling, and more)

Easy web data access. Simplified retrieval of information from websites and online sources.

Adds powerful web scraping and search capabilities to LLM clients like Cursor and Claude.

Real-time web data, structured for agents

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.