Postman MCP 服务器

版本: v0.2.0

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

该项目是 Anthropic 的 Model Context Protocol (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。
Schema 支持: 支持多文件的 API 模式管理。
标签: 为 API 添加和管理标签。
评论: 在 API 上添加和管理评论。

认证与授权

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

额外功能

私有 API 网络: 在私有 API 网络中管理元素和文件夹。
Webhook: 创建带有自定义负载的 Webhook 来触发集合。
企业级特性: 针对企业环境的高级角色控制和 SCIM 支持。

安装

通过 Smithery 安装

要通过 Smithery 自动安装适用于 Claude Desktop 的 Postman MCP Server：

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 Servers 配置中：

示例配置

与上面的 Claude 相同。

使用 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 格式、提示要求和资源处理模式。对于从事将 Postman API 功能集成和增强到 MCP 服务器中的开发人员来说，本指南至关重要。

理由

Postman 工具的 MCP 包装器主要作为复杂多步骤操作的 AI 交互层，其中结构和安全性至关重要。然而，对于直接 CLI 或 API 使用就足够简单的操作来说，它可能过于复杂。MCP 包装器在以下情况下提供最大价值：

复杂操作

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

AI 驱动的自动化

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

对错误敏感的操作

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

它在以下情况下提供的价值较少：

简单操作

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

直接 CLI 使用

开发驱动的运维
本地测试
快速迭代

开发

安装依赖项：

pnpm install

构建服务器：

pnpm run build

开发时自动重建：

pnpm run watch

调试

由于MCP服务器通过标准输入输出进行通信，调试可能会比较困难。我们推荐使用MCP Inspector，它作为一个包脚本提供：

pnpm run inspector

文档

Inspector将提供一个URL以便在浏览器中访问调试工具：http://localhost:5173。您需要先添加POSTMAN_API_KEY才能连接。转到“工具”开始使用。

其他MCP服务器

许可证

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