Postman MCP Server

What is Postman MCP Server about?

Runs Postman collections using Newman through an MCP interface, delivering detailed execution outcomes such as success status, test summary, failures, and timings.

How to use Postman MCP Server?

1. Installation – install via Smithery or manually clone, run pnpm install and pnpm build.
2. Configuration – add the server entry to Claude Desktop configuration:

{
  "mcpServers": {
    "postman-runner": {
      "command": "node",
      "args": ["/absolute/path/to/mcp-postman/build/index.js"]
    }
  }
}

3. Running a collection – invoke the run-collection tool with required collection parameter and optional environment, globals, iterationCount.
4. Result handling – the tool returns a JSON payload containing success, summary, failures, and timings.

Key Features of Postman MCP Server

• Direct execution of Postman collections via Newman.
• Support for environment and global variable files.
• Configurable iteration count.
• Comprehensive result payload: overall status, pass/fail counts, detailed failure messages, timestamps and duration.
• Simple MCP‑compatible command‑line integration for LLMs.

Use Cases of Postman MCP Server

• Automated API testing in AI‑driven workflows.
• LLM‑guided debugging where a model triggers tests and interprets results.
• Continuous integration pipelines that need a lightweight, programmatic way to run Postman suites.
• Education and demos showcasing how AI can interact with API test suites.

FAQ from the Postman MCP Server

Q: Do I need a Postman account? A: No, only the collection, environment, and globals files are required.

Q: Which runtimes are supported? A: Node.js environments; the server is built with TypeScript and compiled to JavaScript.

Q: Can I run multiple iterations? A: Yes, specify iterationCount in the tool parameters.

Q: How are results formatted? A: As a JSON object containing success, summary, failures, and timings fields.

Q: Is there a way to view detailed logs? A: The server logs Newman output to the console; you can capture it or extend the runner for custom logging.

Postman MCP Server

An MCP (Model Context Protocol) server that enables running Postman collections using Newman. This server allows LLMs to execute API tests and get detailed results through a standardized interface.

Features

• Run Postman collections using Newman
• Support for environment files
• Support for global variables
• Detailed test results including:
  • Overall success/failure status
  • Test summary (total, passed, failed)
  • Detailed failure information
  • Execution timings

Installation

Installing via Smithery

To install Postman Runner for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install mcp-postman --client claude

Manual Installation

# Clone the repository
git clone <repository-url>
cd mcp-postman

# Install dependencies
pnpm install

# Build the project
pnpm build

Usage

Configuration

Add the server to your Claude desktop configuration file at ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "postman-runner": {
      "command": "node",
      "args": ["/absolute/path/to/mcp-postman/build/index.js"]
    }
  }
}

Available Tools

run-collection

Runs a Postman collection and returns the test results.

Parameters:

• collection (required): Path or URL to the Postman collection
• environment (optional): Path or URL to environment file
• globals (optional): Path or URL to globals file
• iterationCount (optional): Number of iterations to run

Example Response:

{
  "success": true,
  "summary": {
    "total": 5,
    "failed": 0,
    "passed": 5
  },
  "failures": [],
  "timings": {
    "started": "2024-03-14T10:00:00.000Z",
    "completed": "2024-03-14T10:00:01.000Z",
    "duration": 1000
  }
}

Example Usage in Claude

You can use the server in Claude by asking it to run a Postman collection:

"Run the Postman collection at /path/to/collection.json and tell me if all tests passed"

Claude will:

1. Use the run-collection tool
2. Analyze the test results
3. Provide a human-friendly summary of the execution

Development

Project Structure

src/
  ├── index.ts           # Entry point
  ├── server/
  │   ├── server.ts     # MCP Server implementation
  │   └── types.ts      # Type definitions
  └── newman/
      └── runner.ts     # Newman runner implementation
test/
  ├── server.test.ts    # Server tests
  ├── newman-runner.test.ts  # Runner tests
  └── fixtures/         # Test fixtures
      └── sample-collection.json

Running Tests

# Run tests
pnpm test

# Run tests with coverage
pnpm test:coverage

Building

# Build the project
pnpm build

# Clean build artifacts
pnpm clean

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

ISC