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 测试。