SuperAPI AI 工具集

postman-mcp-server

编程与开发

查看项目

更新于 11-11 03:27

技能介绍

Postman MCP Server 是 Postman 官方开发者关系团队(postman-devrel)维护的 postman-claude-code-plugin 插件中的一个知识参考模块,用于在 Claude Code 中配合 Postman MCP 工具使用时加载。它的定位不是独立可运行的服务,而是一份面向模型的概念与工具选择指南:当使用者借助 Postman MCP 工具操作 API 相关任务时,该模块提供上下文,帮助对工具选择与变通做法做出更好的判断。

用途

该模块主要解决两类问题:一是帮助使用者理解 Postman 的核心对象模型,二是在多个 MCP 工具并存时给出选择依据。资料给出的核心概念包括:集合(Collection,按文件夹组织的 API 请求组,是 Postman 的主要工作单元,包含请求、示例、测试与文档)、环境(Environment,按上下文如 dev、staging、prod 区分的键值对变量,用于切换基础 URL、鉴权令牌与配置)、工作区(Workspace,集合、环境与 Spec 的容器,可为个人、团队或公开)、Spec(Spec Hub,存储于 Postman 的 OpenAPI 或 AsyncAPI 定义,可生成集合并保持同步)、请求(Request,单次 API 调用的定义,含方法、URL、请求头、请求体、测试)、响应(Response,保存的示例响应,供模拟服务器与文档使用)、文件夹(Folder,集合内按资源分组的单位)、标签(Tags,用于归类与搜索集合)、监控器(Monitor,按计划运行的集合执行器,用于检查 API 健康状态)、模拟服务器(Mock Server,从集合示例响应提供服务的假 API)。

主要能力

在决策指南部分,模块按目标给出推荐做法,例如:将代码变更推送到 Postman 时,先在 Spec Hub 创建或更新 Spec,再同步到集合;消费 Postman API 时,读取集合并生成客户端代码;查找 API 时使用 searchPostmanElements 再深入细节;测试 API 时用 runCollection 运行集合;为前端创建假 API 时,基于带示例的集合创建模拟服务器;编写 API 文档时,分析集合完整度、补齐缺口并可选发布;审计 API 安全时,针对 Spec 或集合运行安全检查;学习 Postman 功能用法时,以 Full 模式搜索 Postman 学习中心。

在 MCP 工具选择部分,模块按类别列出可用工具,包括:工作区操作(getWorkspaces、getWorkspace、createWorkspace)、集合增删改查(getCollections、getCollection、createCollection、putCollection、patchCollection、deleteCollection)、请求与响应(getCollectionRequest、createCollectionRequest、updateCollectionRequest、getCollectionResponse、createCollectionResponse、updateCollectionResponse)、文件夹管理(getCollectionFolder、createCollectionFolder、updateCollectionFolder)、Spec Hub(getAllSpecs、getSpec、createSpec、getSpecDefinition、updateSpecFile、getSpecFiles)、同步(generateCollection、syncCollectionWithSpec、syncSpecWithCollection)、环境(getEnvironments、getEnvironment、createEnvironment、putEnvironment)、模拟(getMocks、getMock、createMock、publishMock、unpublishMock)、测试(runCollection)、文档(publishDocumentation、unpublishDocumentation)、搜索(searchPostmanElements、getTaggedEntities)、学习中心(searchLearningCenter,仅 Full 模式,用于检索 Postman 产品文档中的操作指引)、用户(getAuthenticatedUser)。

使用方式

资料表明该模块以参考文档形式组织。setup.md 说明如何搭建 Postman MCP 服务器与认证;其余参考文档各对应一个完整目标,给出仅有 MCP 工具(不使用 postman CLI)情况下的工具调用序列、每一步应呈现的内容以及错误处理方式,包括:首次运行认证(OAuth 或 API key)与工作区验证(setup.md)、跨工作区发现 API(search.md)、从 Spec 创建或更新集合或从集合变更反向同步 Spec(sync.md)、从集合或 Spec 创建模拟服务器(mock.md)、运行集合测试并诊断失败(test.md)、生成、改进并发布 API 文档(docs.md)、按 OWASP API Top 10 审计 Spec 或集合(security.md)、在 Postman 学习中心检索操作指引(learn.md)。另有 mcp-limitations.md 记录已知限制与变通方案。

适用场景与限制

该模块适用于需要借助 Claude Code 操作 Postman 资源的开发者与团队,覆盖 API 查找、测试、模拟、文档、同步与安全审计等任务。需要说明的是,资料未提供安装命令、收费与价格、支持的平台范围或任何效果数据,这些内容暂未提供;模块本身依赖可用的 Postman MCP 服务器与认证配置,具体步骤需参照 setup.md 等参考文档。