MCP Postman

🚀 郵件投遞員 MCP 服務器

郵件投遞員 MCP 服務器是一個基於 Model Context Protocol (MCP) 的服務器，它支持使用 Newman 運行 Postman 集合。藉助該服務器，大語言模型（LLMs）能夠執行 API 測試，並通過標準化接口獲取詳細的測試結果。

🚀 快速開始

郵件投遞員 MCP 服務器可助力大語言模型執行 API 測試並獲取詳細結果。以下將為你介紹其安裝與使用方法。

✨ 主要特性

• 使用 Newman 執行 Postman 集合。
• 支持環境文件。
• 支持全局變量。
• 提供詳細的測試結果，涵蓋：
  • 整體成功/失敗狀態。
  • 測試摘要（總數、通過數、失敗數）。
  • 詳細的失敗信息。
  • 執行時間。

📦 安裝指南

使用 Smithery 安裝

通過 Smithery 可自動安裝 Postman Runner for Claude Desktop：

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. 使用 run-collection 工具。
2. 分析測試結果。
3. 提供一個友好的執行摘要。

📚 詳細文檔

項目結構

• src/：包含服務器的主要實現邏輯。
• build/：構建生成的文件。
• package.json：項目的依賴管理和構建腳本。
• README.md：項目文檔和使用說明。

貢獻指南

1. 克隆倉庫：首先，你需要克隆此倉庫到本地開發環境中。

   git clone <repository-url>
   cd mcp-postman
   

2. 安裝依賴項：使用 npm 或 pnpm 安裝項目所需的依賴項。

   pnpm install
   

3. 開發模式啟動：你可以使用以下命令啟動開發服務器。

   pnpm dev
   

4. 構建項目：在生產環境中，可以使用以下命令進行構建。

   pnpm build
   

5. 測試：運行測試套件以確保代碼的正確性。

   pnpm test
   

注意事項

⚠️ 重要提示

• 確保安裝 Node.js 和 npm 或 pnpm 的最新版本，以避免兼容性問題。
• 在生產環境中使用構建後的文件（位於 build/ 目錄），而不是開發模式下的文件。
• 遵循項目貢獻規範和代碼風格指南，確保代碼的一致性和可維護性。

📄 許可證

此項目遵循 MIT License 許可證。

通過以上步驟，你可以輕鬆地將 Postman 集合集成到你的開發流程中，並利用 MCP 服務器的強大功能來自動化和管理 API 測試。