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.

MCP de REST a Postman

Un servidor de Protocolo de Contexto de Modelo (MCP) que convierte código de API REST (p. ej., controladores NestJS, endpoints FastAPI/Flask) a colecciones y entornos de Postman. Esta herramienta ayuda a los desarrolladores a sincronizar automáticamente sus endpoints de API REST y las configuraciones de su entorno con Postman.

Características

  • Convertir puntos finales de la API REST en colecciones de Postman
  • Sincronizar variables de entorno con entornos de Postman
  • Compatibilidad con varios métodos de autenticación (por ejemplo, token de portador)
  • Fusión inteligente de nuevos puntos finales con colecciones existentes
  • Manejo automático de variables ambientales sensibles
  • Compatibilidad con los modos de transporte stdio y SSE

Prerrequisitos

  • Bun v1.2.2 o posterior
  • Clave API de Postman
  • ID del espacio de trabajo del cartero

Instalación y uso

Este es un servidor stdio de Protocolo de contexto de modelo (MCP) que requiere acceso a su espacio de trabajo de Postman para crear/actualizar colecciones y entornos.

Instalación mediante herrería

Para instalar REST-to-Postman MCP para Claude Desktop automáticamente a través de Smithery :

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

Ejecución del servidor MCP con npx

Para utilizar el servidor MCP con npx :

npx -y rest-to-postman@latest --postman-api-key your_api_key --postman-workspace-id your_workspace_id

O utilice variables de entorno:

export POSTMAN_API_KEY=your_api_key export POSTMAN_ACTIVE_WORKSPACE_ID=your_workspace_id npx -y rest-to-postman@latest

Puede integrar este comando con varios editores de código de IA que admiten MCP:

  • Escritorio de Claude
  • Cursor
  • Windsurf
  • Editor de Roo Cline

Nota importante : El servidor requiere las credenciales de la API de Postman para funcionar. Asegúrese de tener la clave de API y el ID del espacio de trabajo listos antes de iniciar el servidor.

Descripciones de herramientas

El servidor proporciona dos herramientas principales:

1. REST al entorno de Postman ( rest_to_postman_env )

Crea o actualiza un entorno Postman con las variables de entorno de su aplicación.

Parámetros de entrada:

  • envName (cadena): Nombre del entorno de Postman
  • envVars (objeto): pares clave-valor de variables de entorno

Ejemplo de entrada:

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

2. Colección REST a Postman ( rest_to_postman_collection )

Crea o actualiza una colección de Postman con sus puntos finales de API REST.

Parámetros de entrada:

  • collectionRequest (objeto): configuración de colección de Postman que contiene:
    • info : metadatos de la colección
    • auth : Configuración de autenticación
    • item : Matriz de puntos finales de API

Ejemplo de entrada:

{ "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"] } } } ] }

Formato de respuesta

Ambas herramientas devuelven un mensaje de éxito que confirma la creación/actualización del recurso Postman:

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

Utilice este MCP en el cursor

Puedes usar este servidor MCP en Cursor. Aquí tienes un ejemplo que genera una colección Postman basada en un controlador Typescript de Nest.js.

Inmediato :

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

Aquí está la colección de Cartero generada automáticamente:

Tenga en cuenta que se generan todos los puntos finales del controlador Campaign , junto con la configuración del token Bear.

Desarrollo

Configuración local

  1. Clonar el repositorio:
git clone https://github.com/runninghare/rest-to-postman.git cd rest-to-postman
  1. Instalar dependencias:
bun install
  1. Crea un archivo .env :
POSTMAN_API_KEY=your_api_key_here POSTMAN_ACTIVE_WORKSPACE_ID=your_workspace_id_here

Ejecutando en modo de desarrollo

Para el desarrollo, puedes ejecutar el servidor directamente usando Bun:

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

Edificio

Para construir el proyecto:

bun run build

Esto creará una salida empaquetada en el directorio dist .

Guiones

  • bun run build - Construye el proyecto
  • bun run dev - Ejecuta el servidor en modo de desarrollo
  • bun run startSSE : inicia el servidor en modo SSE

Contribuyendo

¡Agradecemos sus contribuciones! No dude en enviar una solicitud de incorporación de cambios.

Licencia

Este proyecto está licenciado bajo la licencia MIT: consulte el archivo de LICENCIA para obtener más detalles.

You must be authenticated.

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

Convierte el código de API REST (como los controladores NestJS o los puntos finales FastAPI) en colecciones y entornos de Postman, lo que ayuda a los desarrolladores a sincronizar automáticamente sus puntos finales de API con 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