MCP Postman

🚀 Postman MCP 服務器

Postman MCP 服務器是一個基於 Model Context Protocol (MCP) 的服務器，藉助 Newman 運行 Postman 集合。它允許大語言模型 (LLMs) 執行 API 測試，並通過統一接口獲取詳細測試結果，為 API 測試工作提供了高效且便捷的解決方案。

✨ 主要特性

• 利用 Newman 運行 Postman 集合。
• 支持環境文件，方便在不同環境下進行測試。
• 支持全局變量，靈活配置測試參數。
• 提供詳細的測試結果，具體包括：
  • 整體成功/失敗狀態，快速瞭解測試總體情況。
  • 測試摘要（總數，通過數，失敗數），清晰掌握測試結果分佈。
  • 詳細的失敗信息，便於定位問題。
  • 執行時間，評估測試效率。

📦 安裝指南

通過 Smithery 安裝

要通過 Smithery 自動安裝 Postman 運行器，可執行以下命令：

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

手動安裝

# 克隆倉庫
git clone <repository-url>
cd mcp-postman

# 安裝依賴
pnpm install

# 構建項目
pnpm build

💻 使用示例

配置

在你的 Claude 桌面配置文件 ~/Library/Application Support/Claude/claude_desktop_config.json 中添加此服務器：

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

可用工具

run-collection

運行 Postman 集合並返回測試結果。

參數：

• collection（必填）：Postman 集合的路徑或 URL
• environment（可選）：環境文件的路徑或 URL
• globals（可選）：全局變量文件的路徑或 URL
• iterationCount（可選）：迭代次數

示例響應：

{
  "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
  }
}

示例在 Claude 中使用

你可以在 Claude 中通過讓其運行一個 Postman 集合來實現： "運行位於 /path/to/collection.json 的 Postman 集合，並告訴我所有測試是否通過"

Claude 將會：

1. 使用 MCP 協議調用 run-collection 工具。
2. 收到詳細的測試結果。
3. 生成自然語言的測試報告。

🔧 技術細節

項目結構

- src/
  - CollectionRunner.ts # 處理 Postman 集合運行的主類
  - NewmanAdapter.ts     # Newman 的適配器接口
  - types.ts            # 定義 MCP 協議類型

運行測試

npm test

# 或者具體測試文件
npm test src/CollectionRunner.spec.ts

構建項目

pnpm build

🤝 貢獻指南

1. Fork 本倉庫。
2. 新建功能分支 git checkout -b feature/NewmanAdapter。
3. 提交你的修改 git commit -m 'feat: 添加 Newman 支持'。
4. 推送到遠端 git push origin feature/NewmanAdapter。
5. 創建 Pull Request。

📄 許可證

MIT