Postman Runner MCP Server 使用说明

项目简介

Postman Runner MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它使得大型语言模型 (LLM) 能够利用 Newman 执行 Postman Collection 测试。通过这个服务器，LLM 可以方便地运行 API 测试套件，并以结构化的方式获取测试结果，从而实现基于 LLM 的自动化 API 测试和问题诊断。

主要功能点

执行 Postman Collection: 使用 Newman 作为测试引擎，支持运行各种 Postman Collection，包括 API 请求、断言和工作流。
详细测试结果: 返回全面的测试执行报告，包括总体成功/失败状态、测试摘要（总数、通过数、失败数）、详细的失败信息以及执行时间。
支持环境变量和全局变量: 允许在 Postman Collection 中使用环境变量和全局变量，提高测试的灵活性和可配置性。
标准 MCP 接口: 通过 MCP 协议与 LLM 客户端通信，提供标准化的工具调用和结果返回机制，易于集成到各种支持 MCP 的 LLM 应用中。

安装步骤

克隆仓库:

git clone <仓库URL>  # 将仓库URL替换为 https://github.com/shannonlal/mcp-postman
cd mcp-postman

安装依赖: 确保你已经安装了 pnpm。如果没有安装，请先安装 pnpm。
```
pnpm install
```
构建项目:
```
pnpm build
```

服务器配置

要将 Postman Runner MCP Server 添加到 MCP 客户端（例如 Claude Desktop），你需要配置客户端的 MCP 服务器列表。配置信息通常是一个 JSON 文件，例如 'claude_desktop_config.json'。

以下是配置 Postman Runner MCP Server 的示例 JSON 配置，你需要将其添加到你的 MCP 客户端配置文件中：

{
  "mcpServers": {
    "postman-runner": {  // 服务器名称，可以自定义
      "command": "node",  // 启动服务器的命令，这里使用 Node.js 运行时
      "args": ["/absolute/path/to/mcp-postman/build/index.js"] // 启动参数，指向构建后的服务器入口文件 (index.js)。请将 "/absolute/path/to/mcp-postman" 替换为你的本地仓库绝对路径
    }
  }
}

配置参数说明:

'"postman-runner"': 这是你为该服务器定义的名称，在客户端配置中用于标识和引用该服务器。你可以自定义这个名称。
'"command": "node"': 指定用于启动服务器的命令。由于该服务器是 Node.js 应用，所以这里使用 'node' 命令。
'"args": ["/absolute/path/to/mcp-postman/build/index.js"]': 指定传递给启动命令的参数。
- '"[/absolute/path/to/mcp-postman/build/index.js]"': 这是服务器入口文件 'build/index.js' 的绝对路径。请务必将其替换为你本地 'mcp-postman' 仓库 'build/index.js' 文件的实际绝对路径。 例如，如果你的仓库在 '/Users/yourname/mcp-postman'，则该路径应为 '/Users/yourname/mcp-postman/build/index.js'。

重要提示: 请确保将 '/absolute/path/to/mcp-postman' 替换为你机器上 'mcp-postman' 仓库的实际绝对路径。错误的路径会导致 MCP 客户端无法启动服务器。

基本使用方法

配置完成后，你的 MCP 客户端（如 Claude）应该能够识别并连接到 Postman Runner MCP Server。你可以通过自然语言指令指示 LLM 使用 'run-collection' 工具来执行 Postman Collection 测试。

例如，在 Claude 中，你可以这样指示：

"Run the Postman collection at /path/to/collection.json and tell me if all tests passed"

或者更具体地指定环境变量文件：

"Run the Postman collection at https://example.com/collection.json using environment file at /path/to/environment.json and check the test summary"

工具名称和参数：

工具名称: 'run-collection'
参数:
- 'collection' (必需): Postman Collection 的路径或 URL。
- 'environment' (可选): 环境变量文件的路径或 URL。
- 'globals' (可选): 全局变量文件的路径或 URL。
- 'iterationCount' (可选): 迭代次数。

LLM 客户端会将你的自然语言指令转换为对 'run-collection' 工具的调用，并将 Collection 路径等参数传递给 Postman Runner MCP Server。服务器执行测试后，会将结构化的测试结果返回给 LLM 客户端，然后 LLM 就可以根据结果进行分析和反馈。

关键词