使用说明

项目简介

Postman MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,它扩展了大型语言模型 (LLM) 的能力,使其能够执行和分析 API 测试。该服务器利用 Newman,Postman 的命令行 Collection Runner,允许 LLM 通过标准化的 MCP 接口运行 Postman Collections,并获取详细的测试结果。这使得 LLM 可以自动化 API 交互,验证 API 的行为,并基于测试结果做出决策。

主要功能点

  • 运行 Postman Collections: 支持通过 LLM 指令运行 Postman Collection,无论是本地文件路径还是 URL。
  • 支持环境和全局变量: 允许在运行 Collection 时指定 Postman 环境变量文件和全局变量文件,以适应不同的测试场景。
  • 详细的测试结果: 返回全面的测试执行报告,包括:
    • 总体成功/失败状态
    • 测试摘要(总数、通过数、失败数)
    • 详细的失败信息 (如果存在)
    • 执行时间信息

安装步骤

  1. 克隆仓库:
    git clone https://github.com/Gechmind/mcp-postman
    cd mcp-postman
  2. 安装依赖:
    pnpm install
  3. 构建项目:
    pnpm build

服务器配置

要将 Postman MCP Server 集成到 MCP 客户端(例如 Claude),您需要在客户端的配置文件中添加服务器配置信息。以下是一个典型的配置示例,以 Claude Desktop 的 'claude_desktop_config.json' 为例:

{
  "mcpServers": {
    "postman-runner": {  // 服务器名称,在客户端中引用
      "command": "node", // 启动服务器的命令,这里使用 node
      "args": ["/absolute/path/to/mcp-postman/build/index.js"] // 命令参数,指向构建后的服务器入口文件
      // 请将 "/absolute/path/to/mcp-postman" 替换为 Postman MCP Server 仓库在您系统中的绝对路径
    }
  }
}

注意: 请务必将 '"args"' 数组中的路径 '/absolute/path/to/mcp-postman/build/index.js' 替换为 'Postman MCP Server' 项目在您本地文件系统中的绝对路径。您可以通过 'pwd' 命令获取当前目录的绝对路径,并据此修改配置。

基本使用方法

配置完成后,在支持 MCP 协议的客户端(例如 Claude)中,您可以使用自然语言指令来调用 'Postman MCP Server' 提供的工具。例如,您可以指示 LLM 运行一个 Postman Collection 并获取测试结果:

用户指令示例:

"运行位于 '/path/to/your/collection.json' 的 Postman Collection,并告诉我所有测试是否通过了。"

Claude (或其他 MCP 客户端) 的处理流程:

  1. 客户端识别到需要运行 Postman Collection 的意图。
  2. 客户端调用 'Postman MCP Server' 注册的 'run-collection' 工具。
  3. 客户端将 Collection 路径 '/path/to/your/collection.json' 作为参数传递给 'run-collection' 工具。
  4. 'Postman MCP Server' 使用 Newman 运行指定的 Collection。
  5. 'Postman MCP Server' 返回包含测试结果的 JSON 响应给客户端。
  6. 客户端解析 JSON 结果,并以人类友好的形式将结果呈现给用户,例如:"所有测试都已通过。" 或 "有 2 个测试失败,详细信息如下..."

通过这种方式,LLM 可以无缝地利用 Postman Collection 进行 API 测试,并将测试结果用于后续的自然语言处理和决策制定。

信息

分类

开发者工具