Skip to main content
Glama
Sign In
enesjakozh

postman-mcp-server

by delano
GitHub
TypeScript
MIT License
28
  • Apple
RedditDiscord
OverviewInspectNewSchemaRelated ServersReviewsScore
Need Help?View Source CodeReport Issue

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

  • Provides access to the Postman API, enabling comprehensive management of Postman collections, environments, APIs, and other Postman resources, with features like CRUD operations for collections, folder management, request management, environment management, API management, schema support, and authentication capabilities

Servidor MCP de Postman

Versión: v0.2.0

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

Este proyecto forma parte de la iniciativa del Protocolo de Contexto de Modelo (MCP) de Anthropic. Para más información, visite el repositorio de MCP en GitHub y el anuncio en el blog de Anthropic .

Salte a las instrucciones de instalación

[!ADVERTENCIA] Este proyecto se encuentra actualmente en desarrollo. Úselo con precaución y prepárese para cambios importantes.

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

Descripción general

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

Características

Colecciones

  • Operaciones CRUD : crear, recuperar, actualizar y eliminar colecciones de Postman.
  • Gestión de carpetas : organice las solicitudes en carpetas dentro de las colecciones.
  • Gestión de solicitudes : agregue, actualice y elimine solicitudes dentro de las colecciones.
  • Gestión de respuestas : gestione las respuestas asociadas a las solicitudes.
  • Control de versiones : bifurcar, fusionar y extraer cambios para colecciones.
  • Comentarios : Agrega y administra comentarios en las colecciones.

Entornos

  • Administrar entornos : cree y recupere entornos para diferentes configuraciones.
  • Operaciones CRUD : Soporte completo para crear, actualizar y eliminar entornos.

API

  • Gestión de API : crear, recuperar, actualizar y eliminar API.
  • Compatibilidad con esquemas : administre esquemas de API con soporte para múltiples archivos.
  • Etiquetado : agregue y administre etiquetas para API.
  • Comentarios : agregue y administre comentarios en las API.

Autenticación y autorización

  • Autenticación de clave API : acceso seguro mediante claves API.
  • Control de acceso basado en roles : administre permisos en los niveles de espacio de trabajo y de colección.
  • Permisos del espacio de trabajo : define permisos específicos para los espacios de trabajo.

Características adicionales

  • Red API privada : administre elementos y carpetas dentro de una red API privada.
  • Webhooks : crea webhooks para activar colecciones con cargas útiles personalizadas.
  • Funciones empresariales : controles de roles avanzados y compatibilidad con SCIM para entornos empresariales.

Instalación

Instalación mediante herrería

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

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

Prerrequisitos

Pasos

  1. Clonar el repositorio:
    git clone https://github.com/delano/postman-api-server.git cd postman-api-server
  2. Instalar dependencias:
    pnpm install
  3. Construir el servidor:
    pnpm run build
  4. Ejecutar en modo de desarrollo con reconstrucción automática:
    pnpm run watch

Uso

Configuración de claves API

  1. Genera tu clave API
  2. Configurar la clave API
    • Agregue la clave a su entorno como POSTMAN_API_KEY
    • Para Claude Desktop o Cline, inclúyalo en su archivo de configuración (vea los ejemplos de configuración a continuación)
    • Nunca envíe claves API al control de versiones
  3. Verificar el acceso
    • La clave API proporciona acceso a todos los recursos de Postman para los que tiene permisos
    • Pruebe el acceso ejecutando una consulta simple (por ejemplo, enumerar espacios de trabajo)

[!NOTA] Si está utilizando la colección API de Postman directamente, almacene su clave API como una variable de colección postman-api-key .

Uso de Claude Desktop

Para utilizar con Claude Desktop, agregue la configuración del servidor:

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

[!IMPORTANTE] Si está actualizando este proveedor, debe reiniciar Claude para que se apliquen los cambios de la 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.

Ejemplo de configuración

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

Usando Cline

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

Ejemplo de configuración

Lo mismo que Claude arriba.

Usando Zed

Sigo intentando que funcione. Según la documentación de Zed, parece que necesita una extensión ( también este problema n.° 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 el uso programático de la plataforma Postman. Abarca tanto el SDK de colecciones para el desarrollo local como la API de Postman para la integración en la nube. Los temas clave incluyen mecanismos de autenticación, límites de velocidad y documentación detallada de todos los puntos finales de la API, incluyendo espacios de trabajo, colecciones, entornos, servidores simulados, monitores y más. Además, la guía ofrece prerrequisitos e instrucciones de inicio rápido para facilitar la interacción fluida con la API.

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

Conversión de especificaciones OpenAPI a código TypeScript con Claude

Construyendo el servidor MCP

Consulte la Documentación de Controladores para obtener especificaciones detalladas sobre la implementación de controladores del servidor MCP. Esto incluye formatos de URI, requisitos de solicitud y patrones de gestión 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 en el servidor MCP.

Razón fundamental

El contenedor MCP para herramientas Postman es útil principalmente como capa de interacción con IA para operaciones complejas de varios pasos donde la estructura y la seguridad son primordiales. Sin embargo, puede estar sobredimensionado para operaciones simples donde el uso directo de CLI o API sería suficiente. El contenedor MCP ofrece mayor valor cuando:

  1. Operaciones complejas
  • Administrar múltiples colecciones
  • Entornos de coordinación
  • Generar informes completos
  1. Automatización impulsada por IA
  • Flujos de trabajo de pruebas automatizados
  • Mantenimiento de la documentación de la API
  • Gestión del medio ambiente
  1. Operaciones sensibles a errores
  • Pruebas de API críticas
  • Despliegues de producción
  • Comprobación de cumplimiento

Proporciona menos valor para:

  1. Operaciones simples
  • Ejecuciones de recolección básicas
  • Llamadas API únicas
  • Comprobaciones rápidas del entorno
  1. Uso directo de la CLI
  • Operaciones impulsadas por desarrolladores
  • Pruebas locales
  • Iteraciones rápidas

Desarrollo

Instalar dependencias:

pnpm install

Construir el servidor:

pnpm run build

Para desarrollo con reconstrucció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 complicada. Recomendamos usar el Inspector MCP , disponible como script de paquete:

pnpm run inspector

Documentos

El Inspector proporcionará una URL para acceder a las herramientas de depuración en su navegador: http://localhost:5173 . Deberá agregar la clave POSTMAN_API_KEY antes de conectarse. Vaya a "Herramientas" para comenzar.

Otros servidores MCP

Licencia

Este proyecto está licenciado bajo la Licencia MIT. Consulte el archivo de LICENCIA para más detalles.

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

Tools

View all tools

Proporciona acceso sin inconvenientes a Postman .

  1. Overview
    1. Features
      1. Collections
      2. Environments
      3. APIs
      4. Authentication & Authorization
      5. Additional Features
    2. Installation
      1. Installing via Smithery
      2. Prerequisites
      3. Steps
    3. Usage
      1. Setting up API Keys
      2. Using Claude Desktop
      3. Using Cline
      4. Using Zed
    4. Documentation
      1. Project Overview
    5. Rationale
      1. Development
        1. Debugging
          1. Other MCP Servers
            1. License

              Appeared in Searches

              ID: zoig549xfd