使用说明

项目简介

Postman MCP Server 是一个基于 Cloudflare Workers 构建的 MCP 服务器,旨在通过 Model Context Protocol (MCP) 接口,将 Postman 的 API 集合和环境管理能力赋予大型语言模型(LLM),例如 Claude AI。借助此服务器,LLM 可以自动化执行 API 测试、管理 API 文档和工作流程等任务。

主要功能点

  • 集合与环境管理:支持检索、创建和管理 Postman 集合(Collections)和环境(Environments)。
  • 请求操作:允许向指定的 Postman 集合添加新的 API 请求。
  • 测试执行:能够运行 Postman 集合,并返回测试执行结果,实现 API 自动化测试。

安装步骤

  1. 克隆仓库

    git clone https://github.com/freebeiro/mcp-postman.git
    cd mcp-postman
  2. 安装依赖 确保已安装 Node.js 和 npm,然后运行:

    npm install
  3. 配置环境变量 复制 '.env.example' 文件并重命名为 '.env',然后编辑 '.env' 文件,填入您的 Postman API 密钥。您需要在 Postman 官网申请 API 密钥。

    POSTMAN_API_KEY=YOUR_POSTMAN_API_KEY
  4. 部署到 Cloudflare Workers 确保已安装 Wrangler CLI 并已登录 Cloudflare 账户。运行以下命令将服务器部署到 Cloudflare Workers:

    wrangler deploy

    部署成功后,Cloudflare Workers 会为您提供一个服务器 URL,该 URL 将作为 MCP 客户端连接的地址。

服务器配置

MCP 客户端需要配置以下服务器连接信息,以便与 Postman MCP Server 建立连接:

{
  "serverName": "PostmanMCP",
  "command": "wrangler",
  "args": ["deploy"]
  // "serverName":自定义服务器名称,用于在 MCP 客户端中标识该服务器。
  // "command":MCP 服务器的启动命令,这里使用 "wrangler" Cloudflare Workers 的 CLI 工具。
  // "args":启动命令的参数,"deploy" 命令用于部署 Cloudflare Worker。
  // 注意:实际服务器地址由 Cloudflare Workers 部署后分配,无需在此配置。
}

基本使用方法

  1. 获取服务器 URL:部署成功后,从 Cloudflare Workers 获取分配给您的 Postman MCP Server 的 URL。

  2. 配置 MCP 客户端:在您的 MCP 客户端中,根据服务器配置信息添加 PostmanMCP 服务器,并填入 Cloudflare Workers 分配的服务器 URL。

  3. 调用 MCP 功能:通过 MCP 客户端,您可以调用 Postman MCP Server 提供的各种功能,例如:

    • 使用 'mcp__get_collections' 获取 Postman 集合列表。
    • 使用 'mcp__get_collection' 获取指定 ID 的 Postman 集合详情。
    • 使用 'mcp__create_collection' 创建新的 Postman 集合。
    • 使用 'mcp__add_request' 向 Postman 集合添加新的请求。
    • 使用 'mcp__run_collection' 运行 Postman 集合并获取测试结果。

    具体的功能调用和参数请参考仓库 README.md 文件中 "Current Methods" 部分的说明。

信息

分类

开发者工具