Postman MCP Server

Postman MCP Server

site icon
2025.01.29 69
TypeScriptAPI 管理自动化测试开发效率
Postman MCP Server 是一个基于 TypeScript 的 MCP 服务器,集成了 Postman API,提供对 Postman 集合、环境和 API 的全面管理。它支持集合的 CRUD 操作、文件夹管理、请求管理、响应管理、版本控制等功能,同时还支持环境管理、API 管理、认证授权等高级功能。该服务器适用于复杂、多步骤的操作,特别是在需要结构化和安全性的场景下,如自动化测试工作流、API 文档维护和环境管理等。
View on GitHub

Overview

基本能力

产品定位

Postman MCP Server 是一个 MCP 服务器,旨在通过 MCP 协议提供对 Postman API 的访问和管理功能,特别适用于 AI 驱动的自动化操作和复杂 API 管理场景。

核心功能

  1. 集合管理
  2. CRUD 操作:创建、检索、更新和删除 Postman 集合。
  3. 文件夹管理:在集合内组织请求到文件夹中。
  4. 请求管理:在集合中添加、更新和删除请求。
  5. 响应管理:管理与请求关联的响应。
  6. 版本控制:分支、合并和拉取集合的更改。
  7. 评论:在集合上添加和管理评论。

  8. 环境管理

  9. 管理环境:为不同设置创建和检索环境。
  10. CRUD 操作:完全支持创建、更新和删除环境。

  11. API 管理

  12. API 管理:创建、检索、更新和删除 API。
  13. 模式支持:支持多文件 API 模式管理。
  14. 标签:为 API 添加和管理标签。
  15. 评论:在 API 上添加和管理评论。

  16. 认证与授权

  17. API 密钥认证:使用 API 密钥保护访问。
  18. 基于角色的访问控制:在工作区和集合级别管理权限。
  19. 工作区权限:定义特定于工作区的权限。

  20. 附加功能

  21. 私有 API 网络:管理私有 API 网络中的元素和文件夹。
  22. Webhooks:创建 webhooks 以触发带有自定义负载的集合。
  23. 企业功能:高级角色控制和 SCIM 支持,适用于企业环境。

适用场景

  1. 复杂操作
  2. 管理多个集合
  3. 协调环境
  4. 生成综合报告

  5. AI 驱动的自动化

  6. 自动化测试工作流
  7. API 文档维护
  8. 环境管理

  9. 错误敏感操作

  10. 关键 API 测试
  11. 生产部署
  12. 合规性检查

工具列表

  1. Smithery:用于自动安装 Postman MCP Server。
  2. Claude Desktop:通过配置文件使用 Postman MCP Server。
  3. Cline:通过配置文件使用 Postman MCP Server。
  4. MCP Inspector:用于调试 MCP 服务器。

常见问题解答

  1. 如何设置 API 密钥?
  2. 访问 Postman 账户设置生成 API 密钥,并将其配置为环境变量 POSTMAN_API_KEY
  3. 如何调试 MCP 服务器?
  4. 使用 MCP Inspector 进行调试,运行 pnpm run inspector 并访问 http://localhost:5173。
  5. 如何更新服务器配置?
  6. 更新配置文件后,需要重启 Claude 以获取 API 更改。

使用教程

使用依赖

  • 安装 Node.js:https://nodejs.org/

安装教程

  1. 通过 Smithery 安装 bash npx -y @smithery/cli install postman-api-server --client claude

  2. 手动安装 bash git clone https://github.com/delano/postman-api-server.git cd postman-api-server pnpm install pnpm run build pnpm run watch

调试方式

  1. 使用 MCP Inspector bash pnpm run inspector 然后访问 http://localhost:5173 进行调试。

  2. 验证访问

  3. 运行简单查询(如列出工作区)以测试 API 密钥是否正常工作。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。