Postman MCP Server

Interactúa con la API de Postman a través de un servidor MCP. Requiere una clave de API de Postman.

GitHub
160
Prueba este MCPPatrocinado

Documentación

Servidor MCP de Postman

smithery badge Versión: v0.2.0

Un servidor MCP que proporciona acceso a la API de Postman. La funcionalidad se basa en la especificación oficial de OpenAPI. Para más información, consulta la documentación de la API de Postman.

Este proyecto forma parte de la iniciativa Model Context Protocol (MCP) de Anthropic. Para más información, visita el repositorio de MCP en GitHub y el anuncio en el blog de Anthropic.

Ir directamente a las instrucciones de instalación

postman-mcp-server - Cover Image

[!ADVERTENCIA] Este proyecto se encuentra actualmente en desarrollo activo. Úsalo con precaución y espera cambios importantes.

[!NOTA] Código generado por IA. Usé Cline v2.2.2 con Claude 3.5 Sonnet (2024-10-22). Consulta docs/README.md para ver los prompts y detalles sobre cómo se generó este código.

postman-mcp-server MCP server

Descripción general

Postman MCP Server es un servidor MCP basado en TypeScript que se integra con la API de Postman, proporcionando una gestión integral de colecciones, entornos y APIs de Postman.

Características

Colecciones

  • Operaciones CRUD: Crear, recuperar, actualizar y eliminar colecciones de Postman.
  • Gestión de carpetas: Organizar solicitudes en carpetas dentro de las colecciones.
  • Gestión de solicitudes: Agregar, actualizar y eliminar solicitudes dentro de las colecciones.
  • Gestión de respuestas: Gestionar respuestas asociadas a las solicitudes.
  • Control de versiones: Bifurcar, fusionar y extraer cambios de las colecciones.
  • Comentarios: Agregar y gestionar comentarios en las colecciones.

Entornos

  • Gestión de entornos: Crear y recuperar entornos para diferentes configuraciones.
  • Operaciones CRUD: Soporte completo para crear, actualizar y eliminar entornos.

APIs

  • Gestión de APIs: Crear, recuperar, actualizar y eliminar APIs.
  • Soporte de esquemas: Gestionar esquemas de API con soporte de múltiples archivos.
  • Etiquetado: Agregar y gestionar etiquetas para las APIs.
  • Comentarios: Agregar y gestionar comentarios en las APIs.

Autenticación y autorización

  • Autenticación con clave de API: Acceso seguro mediante claves de API.
  • Control de acceso basado en roles: Gestionar permisos a nivel de espacio de trabajo y colección.
  • Permisos de espacio de trabajo: Definir permisos específicos para los espacios de trabajo.

Características adicionales

  • Red privada de API: Gestionar elementos y carpetas dentro de una red privada de API.
  • Webhooks: Crear webhooks para activar colecciones con cargas útiles personalizadas.
  • Funciones empresariales: Controles de roles avanzados y soporte SCIM para entornos empresariales.

Instalación

Instalación mediante Smithery

Para instalar Postman MCP Server para Claude Desktop automáticamente mediante Smithery:

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

Requisitos previos

Pasos

  1. Clonar el repositorio:

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

  2. Instalar las dependencias:

    pnpm install

  3. Compilar el servidor:

    pnpm run build

  4. Ejecutar en modo de desarrollo con recompilación automática:

    pnpm run watch

Uso

Configuración de claves de API

  1. Genera tu clave de API

  2. Configura la clave de API

    • Agrega la clave a tu entorno como POSTMAN_API_KEY
    • Para Claude Desktop o Cline, inclúyela en tu archivo de configuración (consulta los ejemplos de configuración a continuación)
    • Nunca subas claves de API al control de versiones

  3. Verifica el acceso

    • La clave de API proporciona acceso a todos los recursos de Postman para los que tengas permisos
    • Prueba el acceso ejecutando una consulta simple (por ejemplo, listar espacios de trabajo)

[!NOTA] Si usas la colección de API de Postman directamente, guarda tu clave de API como una variable de colección postman-api-key.

Uso con Claude Desktop

Para usar con Claude Desktop, agrega la configuración del servidor:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%/Claude/claude_desktop_config.json

[!IMPORTANTE] Si estás actualizando este proveedor, Claude debe reiniciarse para que se apliquen los cambios de API del esquema de entrada (es decir, cuando los elementos ToolDefinition del servidor MCP hayan cambiado). Esto se debe a que Claude almacena en caché las definiciones de herramientas al iniciarse.

claude-desktop-settings

Ejemplo de configuración

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

Uso con Cline

Usando la misma configuración de ejemplo, agrega la configuración del servidor a tu configuración de servidores MCP de Cline:

cline-settings

Ejemplo de configuración

Igual que con Claude arriba.

Uso con Zed

Todavía estoy intentando que funcione. Según la documentación de Zed, parece que debe ser una extensión (también este problema #21455).

Documentación

La documentación oficial de la API de Postman está disponible en el Espacio de trabajo público de Postman.

Descripción general del proyecto

Referencias y resúmenes de la API de Postman

Este proyecto aprovecha el modelo Claude y la extensión Cline para convertir la especificación OpenAPI en código TypeScript, mejorando la seguridad de tipos y la integración dentro del servidor MCP.

Este proyecto de GitHub incluye documentación de referencias de API que proporciona una guía detallada sobre cómo utilizar la plataforma Postman mediante programación. Cubre tanto el SDK de colecciones para el desarrollo local como la API de Postman para la integración con la plataforma en la nube. Los temas clave incluyen mecanismos de autenticación, límites de velocidad y documentación detallada de todos los endpoints de API, incluidos espacios de trabajo, colecciones, entornos, servidores simulados, monitores y más. Además, la guía ofrece requisitos previos e instrucciones de inicio rápido para facilitar interacciones fluidas con la API.

El directorio docs/api/summaries contiene resúmenes completos en Markdown de la API de Postman. Estos documentos describen los endpoints de API, los formatos de solicitud/respuesta y los detalles de implementación esenciales para validar y garantizar la funcionalidad del servidor MCP. Consulta el README de resúmenes de API para obtener una descripción general de la estructura de la documentación y las estrategias de implementación.

Conversión de la especificación OpenAPI a código TypeScript con Claude

Compilación del servidor MCP

Consulta la documentación de handlers para obtener especificaciones detalladas sobre la implementación de handlers del servidor MCP. Esto incluye formatos de URI, requisitos de prompts y patrones de manejo de recursos. Esta guía es crucial para los desarrolladores que trabajan en la integración y mejora de las funcionalidades de la API de Postman dentro del servidor MCP.

Justificación

El envoltorio MCP para las herramientas de Postman tiene sentido principalmente como una capa de interacción de IA para operaciones complejas y de múltiples pasos donde la estructura y la seguridad son primordiales. Sin embargo, puede estar sobrediseñado para operaciones simples donde el uso directo de CLI o API sería suficiente. El envoltorio MCP proporciona el mayor valor cuando:

  1. Operaciones complejas
  • Gestión de múltiples colecciones
  • Coordinación de entornos
  • Generación de informes completos
  1. Automatización impulsada por IA
  • Flujos de trabajo de pruebas automatizadas
  • Mantenimiento de documentación de API
  • Gestión de entornos
  1. Operaciones sensibles a errores
  • Pruebas críticas de API
  • Implementaciones en producción
  • Verificación de cumplimiento

Proporciona menos valor para:

  1. Operaciones simples
  • Ejecuciones básicas de colecciones
  • Llamadas de API individuales
  • Verificaciones rápidas de entornos
  1. Uso directo de CLI
  • Operaciones impulsadas por desarrolladores
  • Pruebas locales
  • Iteraciones rápidas

Desarrollo

Instalar dependencias:

pnpm install

Compilar el servidor:

pnpm run build

Para desarrollo con recompilación automática:

pnpm run watch

Depuración

Dado que los servidores MCP se comunican a través de stdio, la depuración puede ser un desafío. Recomendamos usar el Inspector MCP, disponible como script de paquete:

pnpm run inspector

Documentación

El Inspector proporcionará una URL para acceder a las herramientas de depuración en tu navegador: http://localhost:5173. Deberás agregar la POSTMAN_API_KEY antes de conectarte. Navega a "Tools" para comenzar.

Otros servidores MCP

Licencia

Este proyecto está licenciado bajo la Licencia MIT. Consulta el archivo LICENSE para más detalles.