Skip to content
Back to search

mcp-postman

MCP Server for running Postman Collections with Newman

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/shannonlal--mcp-postman/badge.svg)](/listings/shannonlal--mcp-postman)

HTML

<a href="/listings/shannonlal--mcp-postman"><img src="/api/listings/shannonlal--mcp-postman/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Installing via Smithery

To install Postman Runner for Claude Desktop automatically via [Smithery](https://smithery.ai/server/mcp-postman):

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

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 157 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # Postman MCP Server
  2. [![smithery badge](https://smithery.ai/badge/mcp-postman)](https://smithery.ai/server/mcp-postman)
  3. 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.
  4. [![MCP Postman Server Demo](https://img.youtube.com/vi/d1WgTqwMsog/0.jpg)](https://youtu.be/d1WgTqwMsog)
  5. <a href="https://glama.ai/mcp/servers/qfx34b2s2v"><img width="380" height="200" src="https://glama.ai/mcp/servers/qfx34b2s2v/badge" alt="Postman Server MCP server" /></a>
  6. ## AI Agent Listing
  7. [![Postman MCP Server on AI Agents Listing](https://aiagentslisting.com/postman-mcp-server-2/badge.svg?claim=c5d8ff3f60569ee9b3aa79b368b14860)](https://aiagentslisting.com/mcp/postman-mcp-server-2)
  8. ## Features
  9. - Run Postman collections using Newman
  10. - Support for environment files
  11. - Support for global variables
  12. - Detailed test results including:
  13. - Overall success/failure status
  14. - Test summary (total, passed, failed)
  15. - Detailed failure information
  16. - Execution timings
  17. ## Installation
  18. ### Installing via Smithery
  19. To install Postman Runner for Claude Desktop automatically via [Smithery](https://smithery.ai/server/mcp-postman):
  20. ```bash
  21. npx -y @smithery/cli install mcp-postman --client claude
  22. ```
  23. ### Manual Installation
  24. ```bash
  25. # Clone the repository
  26. git clone <repository-url>
  27. cd mcp-postman
  28. # Install dependencies
  29. pnpm install
  30. # Build the project
  31. pnpm build
  32. ```
  33. ## Usage
  34. ### Configuration
  35. Add the server to your Claude desktop configuration file at `~/Library/Application Support/Claude/claude_desktop_config.json`:
  36. ```json
  37. {
  38. "mcpServers": {
  39. "postman-runner": {
  40. "command": "node",
  41. "args": ["/absolute/path/to/mcp-postman/build/index.js"]
  42. }
  43. }
  44. }
  45. ```
  46. ### Available Tools
  47. #### run-collection
  48. Runs a Postman collection and returns the test results.
  49. **Parameters:**
  50. - `collection` (required): Path or URL to the Postman collection
  51. - `environment` (optional): Path or URL to environment file
  52. - `globals` (optional): Path or URL to globals file
  53. - `iterationCount` (optional): Number of iterations to run
  54. **Example Response:**
  55. ```json
  56. {
  57. "success": true,
  58. "summary": {
  59. "total": 5,
  60. "failed": 0,
  61. "passed": 5
  62. },
  63. "failures": [],
  64. "timings": {
  65. "started": "2024-03-14T10:00:00.000Z",
  66. "completed": "2024-03-14T10:00:01.000Z",
  67. "duration": 1000
  68. }
  69. }
  70. ```
  71. ### Example Usage in Claude
  72. You can use the server in Claude by asking it to run a Postman collection:
  73. "Run the Postman collection at /path/to/collection.json and tell me if all tests passed"
  74. Claude will:
  75. 1. Use the run-collection tool
  76. 2. Analyze the test results
  77. 3. Provide a human-friendly summary of the execution
  78. ## Development
  79. ### Project Structure
  80. ```
  81. src/
  82. ├── index.ts # Entry point
  83. ├── server/
  84. │ ├── server.ts # MCP Server implementation
  85. │ └── types.ts # Type definitions
  86. └── newman/
  87. └── runner.ts # Newman runner implementation
  88. test/
  89. ├── server.test.ts # Server tests
  90. ├── newman-runner.test.ts # Runner tests
  91. └── fixtures/ # Test fixtures
  92. └── sample-collection.json
  93. ```
  94. ### Running Tests
  95. ```bash
  96. # Run tests
  97. pnpm test
  98. # Run tests with coverage
  99. pnpm test:coverage
  100. ```
  101. ### Building
  102. ```bash
  103. # Build the project
  104. pnpm build
  105. # Clean build artifacts
  106. pnpm clean
  107. ```
  108. ## Contributing
  109. 1. Fork the repository
  110. 2. Create your feature branch (`git checkout -b feature/amazing-feature`)
  111. 3. Commit your changes (`git commit -m 'Add some amazing feature'`)
  112. 4. Push to the branch (`git push origin feature/amazing-feature`)
  113. 5. Open a Pull Request
  114. ## License
  115. ISC

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.