Postman MCP Server 使用说明

项目简介

Postman MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器，它充当 LLM 客户端和 Postman API 之间的桥梁。通过此服务器，用户可以使用支持 MCP 协议的 LLM 客户端（如 Claude Desktop 或 Cline）以标准化的方式访问和操作 Postman 中的各种资源，例如管理 API 集合、配置环境、以及处理 API 定义等。该服务器基于 Postman 官方 OpenAPI 规范构建，旨在为 LLM 应用提供安全、可扩展的 Postman 上下文服务框架。

主要功能点

集合管理: 创建、读取、更新和删除 Postman 集合，管理集合内的文件夹和请求。
环境管理: 创建、读取、更新和删除 Postman 环境，管理不同配置的环境变量。
API 管理: 创建、读取、更新和删除 Postman API 定义，支持 API Schema 和标签管理。
安全认证: 使用 Postman API 密钥进行身份验证，保障 API 访问安全。
灵活部署: 支持通过 Smithery 或手动方式安装，可与 Claude Desktop, Cline 等 MCP 客户端集成。

安装步骤

克隆仓库:

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

安装依赖:
```
pnpm install
```
构建服务器:
```
pnpm run build
```

服务器配置

MCP 服务器需要配置 Postman API 密钥才能正常工作。以下是 MCP 客户端（如 Claude Desktop 或 Cline）所需的服务器配置信息（JSON 格式）：

{
  "mcpServers": {
    "postman": {  // 服务器名称，可以自定义
      "command": "node",  // 启动服务器的命令，这里使用 Node.js
      "args": [
        "/path/to/postman-api-server/build/index.js"  // 服务器入口文件路径，请替换为实际路径
      ],
      "env": {
        "POSTMAN_API_KEY": "YOUR_POSTMAN_API_KEY"  // Postman API 密钥，请替换为您的密钥
      }
    }
  }
}

配置参数说明:

'server name': 服务器的名称，例如 "postman"，用于在 MCP 客户端中标识和引用该服务器。
'command': 启动 MCP 服务器的命令。由于该服务器是 Node.js 应用，这里设置为 "node"。
'args': 传递给启动命令的参数，指向编译后的服务器入口文件 'build/index.js' 的绝对路径。请务必将 '/path/to/postman-api-server' 替换为您实际的仓库克隆路径。
'env': 环境变量配置。'POSTMAN_API_KEY' 是必需的环境变量，用于存储您的 Postman API 密钥。请将 'YOUR_POSTMAN_API_KEY' 替换为您在 Postman 官网生成的 API 密钥。

如何获取 Postman API Key:

访问 Postman Account Settings。
点击 "Generate API Key" (生成 API 密钥)。
安全地保存生成的 API 密钥。

MCP 客户端配置:

Claude Desktop: 将上述 JSON 配置添加到 '~/Library/Application Support/Claude/claude_desktop_config.json' (macOS) 或 '%APPDATA%/Claude/claude_desktop_config.json' (Windows) 文件中。
Cline: 将上述 JSON 配置添加到 Cline MCP 服务器配置文件中。

基本使用方法

确保已正确安装和配置 Postman MCP Server，并已配置 Postman API 密钥。
启动 MCP 服务器 (开发模式可以使用 'pnpm run watch')。
启动支持 MCP 协议的 LLM 客户端（如 Claude Desktop 或 Cline）。
在 LLM 客户端中配置并连接到 Postman MCP Server。
使用 LLM 客户端提供的工具或指令，通过 MCP 协议与 Postman API 进行交互，例如列出工作区、检索集合信息、创建环境等。

示例：在 Claude Desktop 中使用 配置完成后，在 Claude Desktop 中，您应该能够通过集成的工具或命令访问和操作 Postman 资源。具体的交互方式取决于 Claude Desktop 提供的 MCP 客户端功能。您可以尝试使用自然语言指令，例如 "列出我的 Postman 工作区" 或 "获取名为 '我的集合' 的集合详情" 等，来与 Postman MCP Server 交互。

调试: 如果遇到问题，可以使用 MCP Inspector 工具进行调试，运行 'pnpm run inspector' 启动 Inspector，并按照提示配置 'POSTMAN_API_KEY' 进行连接和调试。

关键词