AI导哈

Postman API服务

一个基于TypeScript的MCP服务器，提供对Postman API的访问，支持集合、环境和API的全面管理。

  • by delano
  • TypeScript
  • 本地部署
  • 156 星标
  • 更新于
在 GitHub 查看 delano/postman-mcp-server

使用说明

邮递员MCP服务器

版本： v0.2.0版本

提供对以下内容的访问的MCP服务器 邮递员 API功能基于 官方OpenAPI规范。有关更多信息，请参阅 邮递员API文件.

该项目是Anthropic的模型上下文协议（MCP）倡议的一部分。有关更多信息，请访问 MCP GitHub存储库 以及关于 Anthropic博客.

跳过安装说明

[！警告] 该项目目前正在积极开发中。请谨慎使用，并期待突破性的变化。

[！注意] AI生成的代码。我使用克莱恩v2.2.2和克劳德3.5十四行诗（2024-10-22）。有关如何生成此代码的提示和详细信息，请参阅docs/README.md。

概述

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

特性

集合

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

环境

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

应用程序编程接口

  • API管理：创建、检索、更新和删除API。
  • 架构支持：使用多文件支持管理API架构。
  • 标记：为API添加和管理标签。
  • 评论：添加和管理API上的注释。

身份验证和授权

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

附加功能

  • 专用API网络：在专用API网络中管理元素和文件夹。
  • 网页插件：创建webhooks以触发具有自定义有效载荷的集合。
  • 企业功能：为企业环境提供高级角色控制和SCIM支持。

安装

通过Smithery安装

通过以下方式自动安装克劳德桌面版Postman MCP服务器 史密瑟里:

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

先决条件

步骤

  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密钥

  2. 配置API密钥

    • 将密钥添加到您的环境中 POSTMAN_API_KEY
    • 对于Claude Desktop或Cline，请将其包含在配置文件中（请参阅下面的配置示例）
    • 永远不要将API密钥提交到版本控制

  3. 验证访问权限

    • API密钥提供对您拥有权限的所有Postman资源的访问
    • 通过运行一个简单的查询来测试访问权限（例如，列出工作区）

[！注意] 如果你正在使用 邮差API系列 直接将API密钥存储为 postman-api-key 集合变量。

使用克劳德桌面

要与Claude Desktop一起使用，请添加服务器配置：

  • macOS： ~/Library/Application Support/Claude/claude_desktop_config.json
  • 窗户： %APPDATA%/Claude/claude_desktop_config.json

[！重要] 如果您正在更新此提供程序，则必须重新启动Claude以从输入模式中获取API更改（即，当MCP服务器的ToolDefinition元素发生更改时）。这是因为Claude在启动时缓存了工具定义。

配置示例

{
  "mcpServers": {
    "postman": {
      "command": "node",
      "args": [
        "/path/to/postman-api-server/build/index.js"
      ],
      "env": {
        "POSTMAN_API_KEY": "CHANGEME"
      }
    }
  }
}

使用Cline

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

配置示例

和上面的克劳德一样。

使用Zed

我仍在努力使其发挥作用 Zed文档 看起来它需要一个扩展(还有这个问题#21455).

文档

官方的 邮递员API文件 可在 邮差公共工作区.

项目概述

邮政署长API参考资料及摘要

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

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

这 docs/api/summaries 该目录包含Postman API的全面Markdown摘要。这些文档概述了API端点、请求/响应格式以及验证和确保MCP服务器功能所必需的实施细节。请参阅 API自述摘要 了解文档结构和实施策略的概述。

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

构建MCP服务器

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

依据

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

  1. 复杂操作
  • 管理多个集合
  • 协调环境
  • 生成综合报告
  1. 人工智能驱动的自动化
  • 自动化测试工作流程
  • API文件维护
  • 环境管理
  1. 错误敏感操作
  • API关键测试
  • 生产部署
  • 合规性检查

它为以下方面提供的价值较小：

  1. 简单的操作
  • 基本收集运行
  • 单个API调用
  • 快速环境检查
  1. 直接CLI使用
  • 开发人员驱动的运营
  • 局部测试
  • 快速迭代

发展

安装依赖项：

pnpm install

构建服务器：

pnpm run build

对于自动重建的开发：

pnpm run watch

调试

由于MCP服务器通过stdio进行通信，调试可能具有挑战性。我们建议使用 MCP检查员，作为包脚本提供：

pnpm run inspector

文档

检查器将提供一个URL来访问浏览器中的调试工具：http://localhost:5173.在进行连接之前，您需要添加POSTMAN_API_KEY。导航到“工具”开始。

其他MCP服务器

许可证

该项目根据MIT许可证获得许可。请参阅 许可证 文件以获取详细信息。

相关 MCP