This repository provides an MCP server that executes Postman collections using Newman, enabling LLMs to run API tests and receive detailed results through a standardized interface. This repository provides an
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.
Installation is possible via Smithery or manual installation. Manual installation involves cloning the repository, installing dependencies with pnpm install
, and building the project with pnpm build
.
To use, configure the server in Claude desktop by adding a postman-runner
entry in the claude_desktop_config.json
file, specifying the command as node
and providing the path to the built index.js
file.
The primary tool, run-collection
, executes a Postman collection, accepting parameters like collection path/URL, environment file, globals file, and iteration count. It returns a JSON response with success status, summary, failures, and timings.
The project structure includes src/
with the entry point, server implementation, and Newman runner, and test/
with server and runner tests. Key commands include pnpm test
for running tests, pnpm test:coverage
for coverage, pnpm build
for building, and pnpm clean
for cleaning artifacts.
Contributions are welcome via forking, creating a feature branch, committing changes, pushing to the branch, and opening a pull request.
ISC
shannonlal/mcp-postman
December 31, 2024
March 28, 2025
TypeScript