Postman MCP Server

Postman MCP 服务

版本： v0.2.0

一个用于访问 Postman API 的 MCP 服务。其功能基于官方 OpenAPI 规范。如需了解更多信息，请参阅 Postman API 文档。

本项目是 Anthropic 发起的 Model Context Protocol（MCP）计划的一部分。如需了解更多信息，请访问 MCP GitHub 仓库和 Anthropic 博客上的公告。

跳转至安装说明

警告

本项目目前正处于积极开发阶段。请谨慎使用，并做好可能出现破坏性变更的准备。

说明

AI 生成的代码。我使用了 Cline v2.2.2 和 Claude 3.5 Sonnet（2024-10-22）。有关提示词以及代码生成详情，请参阅 docs/README.md。

---

• 概述
• 功能
  • 集合
  • 环境
  • API
  • 身份验证与授权
  • 其他功能
• 安装
  • 先决条件
  • 步骤
• 用法
  • 设置 API 密钥
  • 使用 Claude Desktop
  • 使用 Cline
  • 使用 Zed
• 文档
  • 项目概述
• 设计缘由
• 开发
• 调试
• 其他 MCP 服务
• 许可证

概述

Postman MCP 服务是一个基于 TypeScript 的 MCP 服务，可与 Postman API 集成，全面管理 Postman 集合、环境和 API。

功能

集合

• CRUD 操作：创建、获取、更新和删除 Postman 集合。
• 文件夹管理：在集合中将请求整理到文件夹。
• 请求管理：在集合中添加、更新和删除请求。
• 响应管理：管理与请求关联的响应。
• 版本控制：分叉、合并集合并拉取其更改。
• 评论：添加和管理集合评论。

环境

• 管理环境：为不同配置创建和获取环境。
• CRUD 操作：全面支持创建、更新和删除环境。

API

• API 管理：创建、获取、更新和删除 API。
• 架构支持：管理支持多文件的 API 架构。
• 标签：为 API 添加和管理标签。
• 评论：添加和管理 API 评论。

身份验证与授权

• API 密钥身份验证：使用 API 密钥安全访问。
• 基于角色的访问控制：管理工作区和集合级别的权限。
• 工作区权限：定义特定于工作区的权限。

其他功能

• 私有 API 网络：管理私有 API 网络中的元素和文件夹。
• Webhook：创建 Webhook，以自定义负载触发集合。
• 企业功能：为企业环境提供高级角色控制和 SCIM 支持。

安装

通过 Smithery 安装

要通过 Smithery 为 Claude Desktop 自动安装 Postman MCP 服务：

npx -y @smithery/cli install postman-api-server --client claude

前提条件

• 已安装 Node.js。

步骤

1. 克隆仓库：

   git clone https://github.com/delano/postman-api-server.git
   cd postman-api-server
   

2. 安装依赖：

   pnpm install
   

3. 构建服务：

   pnpm run build
   

4. 在开发模式下运行并自动重新构建：

   pnpm run watch
   

使用方法

设置 API 密钥

1. 生成 API 密钥

   • 访问 Postman 账户设置
   • 点击“Generate API Key”
   • 安全保存密钥——它不会再次显示

2. 配置 API 密钥

   • 将密钥添加到环境变量 POSTMAN_API_KEY 中
   • 对于 Claude Desktop 或 Cline，将其添加到配置文件中（参见下方的配置示例）
   • 切勿将 API 密钥提交到版本控制系统

3. 验证访问权限

   • API 密钥可访问你有权限使用的所有 Postman 资源
   • 运行简单查询（例如，列出工作区）来测试访问权限

说明

如果你直接使用 Postman API collection，请将 API 密钥保存为 collection 变量 postman-api-key。

使用 Claude Desktop

如需在 Claude Desktop 中使用，请添加服务配置：

• macOS： ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows： %APPDATA%/Claude/claude_desktop_config.json

重要

如果你正在更新此提供程序，必须重启 Claude，才能加载输入架构中的 API 变更（即 MCP 服务的 ToolDefinition 元素发生变化时）。这是因为 Claude 会在启动时缓存工具定义。

配置示例

{
  "mcpServers": {
    "postman": {
      "command": "node",
      "args": [
        "/path/to/postman-api-server/build/index.js"
      ],
      "env": {
        "POSTMAN_API_KEY": "CHANGEME"
      }
    }
  }
}

使用 Cline

使用相同的配置示例，将服务配置添加到 Cline 的 MCP 服务配置中：

配置示例

与上方 Claude 的配置相同。

使用 Zed

我还在尝试让它正常运行。从 Zed 文档来看，它似乎需要作为扩展来实现（还有这个 issue #21455）。

---

文档

官方的 Postman API 文档可在 Postman Public Workspace中查看。

项目概览

Postman API 参考与摘要

本项目利用 Claude 模型和 Cline 扩展将 OpenAPI 规范转换为 TypeScript 代码，从而增强 MCP 服务中的类型安全性和集成能力。

此 GitHub 项目包含 API 参考文档，其中详细介绍了如何以编程方式使用 Postman 平台。文档涵盖用于本地开发的 Collection SDK，以及用于云平台集成的 Postman API。主要主题包括身份验证机制、速率限制，以及所有 API 端点的详细文档，包括工作区、集合、环境、模拟服务、监视器等。此外，本指南还提供前置条件和快速入门说明，帮助你顺畅地进行 API 交互。

docs/api/summaries 目录中包含 Postman API 的完整 Markdown 摘要。这些文档概述了 API 端点、请求/响应格式和实现细节，对于验证并确保 MCP 服务正常运行至关重要。请参阅 API 摘要 README，了解文档结构和实现策略的概览。

使用 Claude 将 OpenAPI 规范转换为 TypeScript 代码

构建 MCP 服务

有关实现 MCP 服务处理程序的详细规范，请参阅处理程序文档。其中包括 URI 格式、提示词要求和资源处理模式。本指南对于在 MCP 服务中集成和增强 Postman API 功能的开发者至关重要。

---

理由

Postman 工具的 MCP 封装主要适用于复杂的多步骤操作，可作为 AI 交互层，在这类操作中，结构和安全性至关重要。不过，对于直接使用 CLI 或 API 即可完成的简单操作，这种封装可能过度设计了。MCP 封装在以下场景中最有价值：

1. 复杂操作

• 管理多个集合
• 协调环境
• 生成综合报告

2. AI 驱动的自动化

• 自动化测试工作流
• API 文档维护
• 环境管理

3. 对错误敏感的操作

• 关键 API 测试
• 生产部署
• 合规性检查

在以下场景中，它的价值较低：

1. 简单操作

• 基本集合运行
• 单次 API 调用
• 快速环境检查

2. 直接使用 CLI

• 开发者主导的操作
• 本地测试
• 快速迭代

开发

安装依赖项：

pnpm install

构建服务：

pnpm run build

在开发过程中启用自动重新构建：

pnpm run watch

调试

由于 MCP 服务通过 stdio 通信，调试可能颇具挑战。我们建议使用 MCP Inspector，它可通过包脚本运行：

pnpm run inspector

文档

Inspector 会提供一个 URL，供你在浏览器中访问调试工具：http://localhost:5173。连接前，你需要添加 POSTMAN_API_KEY。前往“Tools”即可开始使用。

其他 MCP 服务

• AppCypher 出品的 Awesome MCP Servers
• PunkPeye 出品的 Awesome MCP Servers

许可证

本项目采用 MIT 许可证。详情请参阅 LICENSE 文件。