Postman MCP 服务器

一个基于 Model Context Protocol (MCP) 的服务器，通过 Newman 实现运行 Postman 集合。此服务器允许大语言模型 (LLMs) 执行 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