postman-mcp-server

Postman MCP 服务器

版本： v0.2.0

提供对Postman API 访问权限的 MCP 服务器。其功能基于官方 OpenAPI 规范。有关更多信息，请参阅Postman API 文档。

该项目是 Anthropic 的模型上下文协议 (MCP) 计划的一部分。更多信息，请访问MCP GitHub 代码库和Anthropic 博客上的公告。

直接跳到安装说明

警告：此项目目前正在积极开发中。请谨慎使用，并注意可能发生的重大更改。

[!NOTE] AI 生成的代码。我使用了 Cline v2.2.2 和 Claude 3.5 Sonnet (2024-10-22)。请参阅 docs/README.md 以获取提示以及此代码生成的详细信息。

• 概述
• 特征
  • 收藏
  • 环境
  • 蜜蜂
  • 身份验证和授权
  • 附加功能
• 安装
  • 先决条件
  • 步骤
• 用法
  • 设置 API 密钥
  • 使用 Claude Desktop
  • 使用 Cline
  • 使用 Zed
• 文档
  • 项目概述
• 基本原理
• 发展
• 调试
• 其他 MCP 服务器
• 执照

概述

Postman MCP Server 是一个基于 TypeScript 的 MCP 服务器，它与 Postman API 集成，提供对 Postman 集合、环境和 API 的全面管理。

特征

收藏

• CRUD 操作：创建、检索、更新和删除 Postman 集合。
• 文件夹管��：将请求组织到集合内的文件夹中。
• 请求管理：添加、更新和删除集合内的请求。
• 响应管理：管理与请求相关的响应。
• 版本控制：分叉、合并和拉取集合的更改。
• 评论：添加和管理收藏的评论。

环境

• 管理环境：为不同的设置创建和检索环境。
• CRUD 操作：完全支持创建、更新和删除环境。

蜜蜂

• API 管理：创建、检索、更新和删除 API。
• 模式支持：通过多文件支持管理 API 模式。
• 标记：添加和管理 API 的标签。
• 评论：添加和管理 API 上的评论。

身份验证和授权

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

附加功能

• 私有 API 网络：管理私有 API 网络内的元素和文件夹。
• Webhooks ：创建 webhooks 以使用自定义有效负载触发收集。
• 企业功能：针对企业环境的高级角色控制和 SCIM 支持。

安装

通过 Smithery 安装

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

先决条件

• 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 帐户设置
   • 点击“生成 API 密钥”
   • 安全保存密钥 - 不会再次显示
2. 配置 API 密钥
   • 将密钥作为POSTMAN_API_KEY添加到您的环境中
   • 对于 Claude Desktop 或 Cline，将其包含在您的配置文件中（请参阅下面的配置示例）
   • 切勿将 API 密钥提交到版本控制
3. 验证访问权限
   • API 密钥提供对您有权限访问的所有 Postman 资源的权限
   • 通过运行简单查询（例如列出工作区）来测试访问

[!NOTE] 如果您直接使用Postman API 集合，请将您的 API 密钥存储为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 在启动时会缓存工具定义。

示例配置

使用 Cline

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

示例配置

与上面的克劳德相同。

使用 Zed

我仍在尝试让它工作。从Zed 文档来看，它似乎需要一个扩展（也参见此问题 #21455 ）。

文档

官方Postman API 文档可在Postman 公共工作区中找到。

项目概述

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. 人工智能驱动的自动化

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

3. 错误敏感操作

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

它对以下方面提供的价值较低：

1. 操作简单

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

2. 直接使用 CLI

• 开发者驱动的运营
• 本地测试
• 快速迭代

发展

安装依赖项：

构建服务器：

对于使用自动重建的开发：

调试

由于 MCP 服务器通过 stdio 进行通信，调试起来可能比较困难。我们推荐使用MCP Inspector ，它包含在包脚本中：

文档

检查器将提供一个 URL，用于在浏览器中访问调试工具： http://localhost:5173 。连接之前，您需要添加 POSTMAN_API_KEY。导航至“工具”即可开始使用。

其他 MCP 服务器

• AppCypher 提供的超棒 MCP 服务器
• PunkPeye 出品的超棒 MCP 服务器

执照

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