Postman MCP 服务器

版本: v0.2.0

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

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

跳转到安装说明

postman-mcp-server - 封面图片

[!WARNING] 此项目目前处于积极开发中。请谨慎使用，并预期可能存在破坏性变更。

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

概述
功能
- 集合
- 环境
- API
- 认证 & 授权
- 其他功能
安装
- 前提条件
- 步骤
使用
文档
- 项目概述
理由
开发
调试
其他 MCP 服务器
许可证

概述

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

功能

集合

CRUD 操作：创建、检索、更新和删除 Postman 集合。
文件夹管理：在集合中组织请求到文件夹。
请求管理：在集合中添加、更新和删除请求。
响应管理：管理与请求关联的响应。
版本控制：为集合进行分支、合并和拉取更改。
评论：在集合上添加和管理评论。

环境

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

API

API 管理：创建、检索、更新和删除 API。
模式支持：管理 API 模式，支持多文件。
标签：为 API 添加和管理标签。
评论：在 API 上添加和管理评论。

认证 & 授权

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

其他功能

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

安装

通过 Smithery 安装

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

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

前提条件

安装 Node.js。

步骤

克隆仓库:

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

安装依赖:
```
pnpm install
```
构建服务器:
```
pnpm run build
```
以开发模式运行并自动重建:
```
pnpm run watch
```

使用

设置 API 密钥

生成您的 API 密钥
- 访问 Postman 账户设置
- 点击“生成 API 密钥”
- 安全保存密钥 - 它将不再显示
配置 API 密钥
- 将密钥添加到您的环境作为 POSTMAN_API_KEY
- 对于 Claude Desktop 或 Cline，将其包含在配置文件中（见下文配置示例）
- 永远不要将 API 密钥提交到版本控制
验证访问
- 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

[!IMPORTANT] 如果您正在更新此提供程序，Claude 必须重新启动才能从输入模式（即当 MCP 服务器的 ToolDefinition 元素发生变化时）获取 API 更改。这是因为 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 文档看起来它需要是一个扩展（这也是问题 #21455）。

文档

官方 Postman API 文档可在 Postman 公共工作区中获取。

项目概述

Postman API 引用 & 摘要

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

此 GitHub 项目包括 API 引用文档，它提供了有关如何以编程方式使用 Postman 平台的详细指导。它涵盖了本地开发的集合 SDK 和云平台集成的 Postman API。关键主题包括认证机制、速率限制以及所有 API 端点的深入文档，包括工作区、集合、环境、模拟服务器、监视器等。此外，该指南提供了前提条件和快速入门说明，以促进无缝 API 交互。

docs/api/summaries 目录包含 Postman API 的全面 Markdown 摘要。这些文档概述了 API 端点、请求/响应格式和实施细节，这些细节对于验证和确保 MCP 服务器的功能至关重要。有关文档结构和实施策略的概述，请参阅 API 摘要 README。

将 OpenAPI 规范转换为 TypeScript 代码 with Claude

构建 MCP 服务器

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

理由

Postman 工具的 MCP 包装器主要作为复杂、多步骤操作的 AI 交互层，其中结构和安全性至关重要。然而，对于简单的操作，直接使用 CLI 或 API 可能更合适。MCP 包装器在以下情况下最有价值：

复杂操作

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

AI 驱动的自动化

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

错误敏感操作

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

它对以下情况的价值较低：

简单操作

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

直接 CLI 使用

开发者驱动的操作
本地测试
快速迭代

开发

安装依赖:

pnpm install

构建服务器:

pnpm run build

用于开发并自动重建:

pnpm run watch

调试

由于 MCP 服务器通过 stdio 通信，调试可能具有挑战性。我们建议使用 MCP 检查器，它可用作包脚本:

pnpm run inspector

文档

检查器将提供一个 URL，您可以通过浏览器访问调试工具：http://localhost:5173。您需要在连接前添加 POSTMAN_API_KEY。导航到“工具”以开始。

其他 MCP 服务器

许可证

本项目根据 MIT 许可证授权。详情请参阅 LICENSE 文件。

delano/postman-mcp-server

星标增长

证据时间轴

Postman MCP 服务器

概述

功能

集合

环境

API

认证 & 授权

其他功能

安装

通过 Smithery 安装

前提条件

步骤

使用

设置 API 密钥

使用 Claude Desktop

示例配置

使用 Cline

示例配置

使用 Zed

文档

项目概述

Postman API 引用 & 摘要

将 OpenAPI 规范转换为 TypeScript 代码 with Claude

构建 MCP 服务器

理由

开发

调试

其他 MCP 服务器

许可证