REST-to-Postman MCP

一个模型上下文协议 (MCP) 服务器，用于将 REST API 代码（例如，NestJS 控制器、FastAPI/Flask 端点）转换为 Postman 集合和环境。此工具帮助开发者自动将他们的 REST API 端点和环境配置与 Postman 同步。

特性

• 将 REST API 端点转换为 Postman 集合
• 将环境变量与 Postman 环境同步
• 支持各种身份验证方法（例如，Bearer token）
• 智能地将新端点与现有集合合并
• 自动处理敏感环境变量
• 支持 stdio 和 SSE 传输模式

前提条件

• Bun v1.2.2 或更高版本
• Postman API 密钥
• Postman 工作区 ID

安装与使用

这是一个模型上下文协议 (MCP) stdio 服务器，需要访问您的 Postman 工作区才能创建/更新集合和环境。

通过 Smithery 安装

要通过 Smithery 为 Claude Desktop 自动安装 REST-to-Postman MCP：

npx -y @smithery/cli install @runninghare/rest-to-postman-mcp --client claude

运行 MCP 服务器

要在生产环境中使用 MCP 服务器：

1. 全局安装该包：

npm install -g rest-to-postman-mcp

2. 使用您的 Postman 凭据运行服务器：

rest-to-postman-mcp --postman-api-key your_api_key --postman-workspace-id your_workspace_id

或者使用环境变量：

export POSTMAN_API_KEY=your_api_key
export POSTMAN_ACTIVE_WORKSPACE_ID=your_workspace_id
rest-to-postman-mcp

您可以将此命令与支持 MCP 的各种 AI 代码编辑器集成：

• Claude Desktop
• Cursor
• Windsurf
• Roo Cline Editor

重要提示：服务器需要 Postman API 凭据才能运行。在启动服务器之前，请确保您已准备好 API 密钥和工作区 ID。

工具描述

服务器提供两个主要工具：

1. REST to Postman Environment (rest_to_postman_env)

使用您的应用程序的环境变量创建或更新 Postman 环境。

输入参数：

• envName (string): Postman 环境的名称
• envVars (object): 环境变量的键值对

输入示例：

{
    "envName": "REST Environment",
    "envVars": {
        "API_URL": "https://api.example.com",
        "API_TOKEN": "secret-token-1"
    }
}

2. REST to Postman Collection (rest_to_postman_collection)

使用您的 REST API 端点创建或更新 Postman 集合。

输入参数：

• collectionRequest (object): Postman 集合配置，包含：
  • info: 集合元数据
  • auth: 身份验证设置
  • item: API 端点数组

输入示例：

{
    "info": {
        "name": "REST Collection",
        "description": "REST Collection", 
        "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
    },
    "auth": {
        "type": "bearer",
        "bearer": [
            {   
                "key": "Authorization",
                "value": "Bearer {{API_TOKEN}}",
                "type": "string"
            }
        ]
    },  
    "item": [
        {
            "name": "Get Users",
            "request": {
                "method": "GET",    
                "url": {
                    "raw": "{{API_URL}}/users",
                    "protocol": "https",
                    "host": ["api", "example", "com"],
                    "path": ["users"]
                }   
            }
        }
    ]
}

响应格式

这两个工具都返回一个成功消息，确认 Postman 资源的创建/更新：

{
    "content": [{
        "type": "text",
        "text": "Successfully created/updated Postman environment: REST Environment"
    }]
}

开发

本地设置

1. 克隆存储库：

git clone https://github.com/yourusername/rest-to-postman-mcp.git
cd rest-to-postman-mcp

2. 安装依赖项：

bun install

3. 创建一个 .env 文件：

POSTMAN_API_KEY=your_api_key_here
POSTMAN_ACTIVE_WORKSPACE_ID=your_workspace_id_here

在开发模式下运行

对于开发，您可以直接使用 Bun 运行服务器：

# 在 stdio 模式下启动（默认）
bun run src/mcp.ts

# 在 SSE 模式下启动
bun run src/mcp.ts --sse

构建

要构建项目：

bun run build

这将在 dist 目录中创建一个捆绑输出。

脚本

• bun run build - 构建项目
• bun run dev - 在开发模式下运行服务器
• bun run startSSE - 在 SSE 模式下启动服务器

贡献

欢迎贡献！请随时提交 Pull Request。

许可证

该项目根据 MIT 许可证获得许可 - 有关详细信息，请参阅 LICENSE 文件。