REST-to-Postman MCP

by runninghare
Verified

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Converts FastAPI endpoints to Postman collections, enabling automatic synchronization of API definitions with Postman for documentation and testing.

  • Extracts Flask endpoints and converts them to Postman collections, allowing developers to automatically keep their Postman workspace in sync with their Flask API code.

  • Parses NestJS controllers to extract REST API endpoints and convert them into Postman collections, maintaining authentication settings and endpoint structures.

REST 到 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

使用npx运行 MCP 服务器

要将 MCP 服务器与npx一起使用:

npx -y rest-to-postman@latest --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 npx -y rest-to-postman@latest

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

  • 克劳德桌面
  • 光标
  • 风帆冲浪
  • Roo Cline 编辑

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

工具描述

该服务器提供两个主要工具:

1. REST 到 Postman 环境( rest_to_postman_env

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

输入参数:

  • envName (字符串):Postman 环境的名称
  • envVars (对象):环境变量的键值对

示例输入:

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

2. REST 到 Postman 集合( rest_to_postman_collection

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

输入参数:

  • collectionRequest (对象):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" }] }

在 Cursor 中使用此 MCP

您可以在 Cursor 中使用此 MCP 服务器。以下示例基于 Nest.js Typescript 控制器生成 Postman Collection。

迅速的

Create a postman collection named "Campaign Endpoints" based on this next.js controller. The baseUrl is `http://localhost:7022`. The collection should have a Bear token which applies to all the endpoints

这是自动生成的 Postman Collection:

请注意, Campaign Controller 的所有端点都已生成,同时还生成了 Bear 令牌设置。

发展

本地设置

  1. 克隆存储库:
git clone https://github.com/runninghare/rest-to-postman.git cd rest-to-postman
  1. 安装依赖项:
bun install
  1. 创建.env文件:
POSTMAN_API_KEY=your_api_key_here POSTMAN_ACTIVE_WORKSPACE_ID=your_workspace_id_here

以开发模式运行

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

# Start in stdio mode (default) bun run src/mcp.ts # Start in SSE mode bun run src/mcp.ts --sse

建筑

要构建项目:

bun run build

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

脚本

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

贡献

欢迎贡献代码!欢迎提交 Pull 请求。

执照

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

You must be authenticated.

A
security – no known vulnerabilities
F
license - not found
A
quality - confirmed to work

将 REST API 代码(如 NestJS 控制器或 FastAPI 端点)转换为 Postman 集合和环境,帮助开发人员自动将其 API 端点与 Postman 同步。

  1. Features
    1. Prerequisites
      1. Installation & Usage
        1. Installing via Smithery
        2. Running the MCP Server with npx
        3. Tool Descriptions
        4. Response Format
        5. Use this MCP in Cursor
      2. Development
        1. Local Setup
        2. Running in Development Mode
        3. Building
        4. Scripts
      3. Contributing
        1. License
          ID: a5094t3jl9