用途
Postman Agent Skill 为 Claude 提供与 Postman API 交互的能力,用于管理完整的 API 生命周期。它适用于需要发现工作区资源、执行测试集合、分析监控、管理 API 规范等场景。
主要能力
- 发现(Discover):列出工作区中的集合、API、规范、环境和监控器。
- 设计(Design):管理 API 规范,校验 schema,比较版本,定义 API。Spec Hub 支持创建和管理 API 规范(OpenAPI 3.0、AsyncAPI 2.0),支持多文件模块化规范,并可在规范与集合之间双向生成。
- 构建(Build):创建、更新、删除集合和环境。v1.1 新增类似 Git 的版本控制:fork 集合、创建拉取请求、合并更改,以及带完整元数据的智能复制。
- 测试(Test):使用 Newman 运行集合测试套件并分析结果。
- 安全(Secure):检查认证配置与安全设置,自动检测敏感变量并标记为 secret,在操作中保留 secret 类型。
- 部署(Deploy):创建和管理用于 API 原型设计的 mock 服务器。
- 观察(Observe):创建、管理和分析监控器,查看运行历史、成功率和性能指标。
- 分发(Distribute):查看和评估 API 文档质量。
使用方式
该技能要求一个包含 Postman API Key 的 .env 文件,脚本运行时会自动加载。API Key 可在 https://web.postman.co/settings/me/api-keys 生成,以 PMAK- 开头。
.env 中可选的配置项包括:
POSTMAN_API_KEY=PMAK-your-key-here
POSTMAN_WORKSPACE_ID=your-workspace-id
POSTMAN_RATE_LIMIT_DELAY=60
POSTMAN_MAX_RETRIES=3
POSTMAN_TIMEOUT=30
# POSTMAN_USE_PROXY=false # Keep this false to bypass proxies (default)
首次使用时,Claude 会自动运行 python scripts/validate_setup.py 进行设置校验与诊断。
所有 Postman API 调用必须通过 Python 脚本进行,不能直接使用 HTTP 请求调用 api.postman.com,否则会因浏览器环境的 CORS 限制而失败。正确示例:
python /path/to/postman-skill/scripts/list_collections.py
常用脚本包括:
python scripts/list_collections.py
python scripts/manage_collections.py --list
python scripts/manage_collections.py --create --name "My API Tests"
支持的环境:Claude 网页界面(完全支持,需配置代理)、Claude API 代码执行(完全支持,无网络限制)、本地 Python 脚本(完全支持)、Claude Desktop(有限支持,需将 api.getpostman.com 加入网络允许列表)。默认情况下技能会绕过所有代理服务器,以避免常见的 403 Forbidden 代理错误;企业环境如需使用代理,可在 .env 中添加 POSTMAN_USE_PROXY=true。
适用场景
当用户提及 Postman、集合、API 规范或 API 测试时;需要创建或管理 API 规范(OpenAPI、AsyncAPI、Swagger);需要上传或导入 API 规范到 Postman;需要从规范生成集合或从集合生成规范;需要校验 API schema 或比较版本;需要创建、更新或删除集合或环境;需要复制或组织集合与环境;需要检查认证或安全配置;需要创建 mock 服务器;需要运行测试或查看测试结果;需要查看可用的 API/集合/规范;需要创建、管理或分析监控器;需要了解 API 可用性、监控或可观测性;需要查看监控器状态或运行历史;需要了解 API 文档质量或访问情况。
限制
- 需要 Postman API Key 和
.env文件;若技能提示需要 API Key,说明.env文件缺失、为空、格式错误或脚本无法读取。 - 所有 API 调用必须通过 Python 脚本,直接 HTTP 调用会因 CORS 失败。
- 运行集合测试需要安装 Newman CLI。
- Fork、拉取请求、合并等版本控制功能需要 Postman v10+。
- Claude Desktop 需要将 api.getpostman.com 加入网络允许列表。
- 该技能支持 Postman v10+,对 v9 提供优雅降级。
版本信息
版本 1.1.0(Phase 1 - Core API Compatibility)。v1.1 新增增强的错误处理、类似 Git 的工作流、自动 secret 检测、智能复制、API 版本检测和改进的开发者体验。