PubNub

Accede a la documentación del SDK de PubNub y a los recursos de API para aplicaciones de comunicación en tiempo real.

Documentación

Servidor MCP de PubNub

Un servidor de Model Context Protocol (MCP) alojado que expone la documentación del SDK de PubNub y los recursos de la API de PubNub a herramientas impulsadas por LLM. Esto mejora la capacidad del agente de IA LLM para comprender e interactuar con los SDK y las API de PubNub. Utiliza transporte HTTP con autenticación OAuth.

PubNub MCP Server

Características

  • 📚 Documentación completa del SDK - Accede a documentación detallada, ejemplos de código y guías de implementación para más de 20 lenguajes de programación, incluidos JavaScript, Python, Java, Swift, Kotlin, C#, Ruby, Go y más
  • 🏗️ Gestión de aplicaciones y keysets - Crea, configura y gestiona aplicaciones y keysets de PubNub con funciones como persistencia de mensajes, uso compartido de archivos, seguimiento de presencia y contexto de aplicación
  • 💬 Comunicación en tiempo real - Envía y recibe mensajes a través de canales, implementa chat en vivo, notificaciones y actualizaciones en tiempo real con soporte tanto para mensajes como para señales ligeras
  • 👥 Gestión de usuarios y canales - Gestiona perfiles de usuario, metadatos de canales y relaciones de membresía con operaciones CRUD completas para crear funciones comunitarias y sociales. Además, existe la opción de ver y gestionar perfiles de usuario, canales y membresías en el Portal de Administración de PubNub (esto requiere Manage Premium).
  • 📍 Seguimiento de presencia y actividad - Supervisa la presencia de usuarios en tiempo real, ve quién está en línea en los canales y rastrea la actividad de los usuarios en tu aplicación
  • 📊 Decisiones y análisis en tiempo real - Activa la acción correcta cuando sea importante, mide su impacto y ajústala según cambien las condiciones, todo en tiempo real. Requiere Illuminate.
  • 📈 Análisis de canales, usuarios y mensajes - Detecta patrones en la actividad agregada de la aplicación, desde los canales principales y desgloses por país hasta usuarios nuevos frente a recurrentes y distribución de dispositivos, para comprender la participación, el uso y el rendimiento. Además, hay métricas limitadas disponibles para ver en el Portal de Administración de PubNub sin Manage Premium; el análisis completo requiere Manage Premium.
  • 🔍 Uso y monitoreo — Realiza un seguimiento del uso facturable en aplicaciones y keysets, revisa el consumo actual e histórico y exporta informes para comprender los factores de costo.
  • 🔧 Integración multiplataforma - Funciona con Cursor, Visual Studio Code, Claude Code y otros asistentes de IA compatibles con MCP
  • ⚡ Experiencia de desarrollador - Construido con TypeScript para seguridad de tipos, incluye infraestructura de pruebas

Inicio rápido

El servidor alojado está gestionado por PubNub y ofrece la forma más fácil de comenzar: no requiere instalación y la autenticación se maneja automáticamente mediante OAuth. Si tu herramienta de IA no admite servidores MCP remotos, usa la versión instalada localmente (npx @pubnub/mcp@latest) en su lugar.

Nota: Para cambiar al servidor alojado (https://mcp.pubnub.com), elimina primero la configuración local anterior de tu cliente de IA y luego sigue los pasos de configuración a continuación.

Servidor MCP de PubNub alojado

Conecta tu asistente de IA a https://mcp.pubnub.com: no requiere instalación. La autenticación se maneja automáticamente mediante OAuth.

VS Code

Open in VS Code

Haz clic en el botón de arriba y luego selecciona Abrir en Visual Studio Code. De vuelta en VS Code, haz clic en Instalar, luego selecciona la organización que deseas autorizar y haz clic en Permitir acceso.

Alternativamente, agrega lo siguiente a tu settings.json de VS Code manualmente:

{
  "mcp": {
    "servers": {
      "pubnub": {
        "url": "https://mcp.pubnub.com"
      }
    }
  }
}

Aprende más en la documentación de VS Code

Cursor

Add to Cursor

Haz clic en el botón de arriba y luego selecciona Abrir Cursor. En Cursor, haz clic en Instalar, selecciona la organización que deseas autorizar y haz clic en Permitir acceso. Navega a Configuración de Cursor → Herramientas y MCP para verificar que PubNub esté habilitado.

Alternativamente, agrega lo siguiente a .cursor/mcp.json (o ~/.cursor/mcp.json para configuración global) manualmente:

{
  "mcpServers": {
    "pubnub": {
      "url": "https://mcp.pubnub.com"
    }
  }
}

Cuando guardes el archivo, se mostrará una notificación. Haz clic en Habilitar para activar el servidor MCP. Aprende más en la documentación de Cursor

Claude Code

En la terminal, ejecuta:

claude mcp add --scope user --transport http pubnub https://mcp.pubnub.com

Luego ejecuta claude para abrir Claude Code e ingresa /mcp. Selecciona pubnub, luego autenticar y haz clic en Permitir acceso para completar la autorización. Aprende más en la documentación de Claude Code

Claude Desktop

Nota: Las siguientes instrucciones aplican a los planes Pro y Max. Para planes Enterprise, la configuración la realiza el administrador de tu organización. Consulta la documentación de Anthropic para obtener más detalles.

  1. En Claude Desktop, navega a Personalizar → Conectores.
  2. Haz clic en + y selecciona Agregar conector personalizado.
  3. Ingresa https://mcp.pubnub.com como la URL del conector.
  4. Completa el inicio de sesión de OAuth cuando se te solicite.

Aprende más en la documentación de Claude Desktop

Codex

En la terminal, ejecuta:

codex mcp add pubnub --url https://mcp.pubnub.com

Luego ejecuta codex mcp login pubnub para autenticarte, selecciona la organización que deseas autorizar y haz clic en Permitir acceso. Aprende más en la documentación de Codex

Codex Desktop

  1. Navega a Configuración → Servidores MCP y haz clic en + Agregar servidor.
  2. Selecciona Streamable HTTP como tipo de transporte.
  3. Ingresa https://mcp.pubnub.com como la URL del servidor.
  4. Sigue el mensaje de inicio de sesión de OAuth para completar la autorización.

Aprende más en la documentación de Codex Desktop

Gemini CLI

En la terminal, ejecuta:

gemini mcp add pubnub --scope user --transport http https://mcp.pubnub.com

Luego ejecuta gemini para abrir Gemini CLI y ejecuta /mcp auth pubnub para autenticarte. Aprende más en la documentación de Gemini CLI

OpenCode

Agrega lo siguiente a ~/.config/opencode/config.json:

{
  "mcp": {
    "pubnub": {
      "type": "remote",
      "url": "https://mcp.pubnub.com",
      "enabled": true
    }
  }
}

Luego ejecuta opencode mcp auth pubnub para autenticarte. Aprende más en la documentación de OpenCode

Servidor MCP de PubNub local

Si tu herramienta de IA no admite servidores MCP remotos, ejecuta el servidor localmente con:

npx @pubnub/mcp@latest

Clave de API

Antes de comenzar, recomendamos encarecidamente crear una Service Integration en el Portal de Administración de PubNub y proporcionar tu clave de API al servidor MCP. Si bien algunas funciones básicas funcionarán sin ella, agregar una clave de API desbloquea mucha más funcionalidad. Alternativamente, consulta Configuración del servidor local para obtener instrucciones sobre cómo configurar el servidor para trabajar con un solo keyset de PubNub.

El proceso de instalación de un servidor MCP depende del asistente de IA que estés usando. Para la configuración estándar, necesitarás Node.js (v20.0.0 o superior).

VS Code

Open in VS Code

Simplemente haz clic en el enlace de arriba y luego selecciona "Abrir en Visual Studio Code" en la página que aparece. De vuelta en VS Code, haz clic en "Instalar". Se te pedirá que ingreses tu clave de API de PubNub. Una vez proporcionada, tu servidor MCP estará listo para usar. Para opciones de configuración adicionales, consulta Configuración del servidor local.

Cursor

Add to Cursor

Haz clic en el enlace de arriba y luego selecciona "Abrir Cursor" en la página que aparece. De vuelta en Cursor, verás un mensaje de "¿Instalar servidor MCP?". Asegúrate de proporcionar el valor de la variable que contiene tu clave de API de PubNub. Una vez que lo hagas, haz clic en "Instalar". Tu servidor MCP ya está listo para usar. Para opciones de configuración adicionales, consulta Configuración del servidor local.

Claude Code

Con Claude Code instalado, ejecuta este comando para agregar el MCP a tu configuración. Asegúrate de reemplazar el valor de <your-api-key>:

claude mcp add pubnub --env PUBNUB_API_KEY=<your-api-key> --scope user --transport stdio -- npx -y @pubnub/mcp@latest

El servidor se agrega en el ámbito "Usuario", lo que significa que estará disponible en todos los proyectos. Para opciones de configuración adicionales, consulta Configuración del servidor local.

Codex

Con Codex instalado, ejecuta este comando para agregar el MCP a tu configuración. Asegúrate de reemplazar el valor de <your-api-key>:

codex mcp add pubnub --env PUBNUB_API_KEY=<your-api-key> -- npx -y @pubnub/mcp@latest

Para opciones de configuración adicionales, consulta Configuración del servidor local.

Gemini CLI

Gemini CLI no admite instalaciones automáticas de MCP. Tendrás que editar manualmente tu archivo settings.json y agregar la sección a continuación. Asegúrate de reemplazar el valor de <your-api-key>:

"mcpServers": {
  "pubnub": {
    "command": "npx",
    "args": [
      "-y",
      "@pubnub/mcp@latest"
    ],
    "env": {
      "PUBNUB_API_KEY": "<your-api-key>"
    }
  }
}

Para opciones de configuración adicionales, consulta la sección Configuración del servidor local en la documentación de PubNub.

Desarrollo

Requisitos previos

  • Node.js >= 20.0.0

Ejecución local

npm install
npm run dev

Variables de entorno

VariableDescripciónRequerida
PORTPuerto del servidor HTTP (predeterminado: 3000)No
MCP_OAUTH_ENABLEDHabilitar autenticación OAuthSí (para producción)
OAUTH_ISSUERURL del servidor de autorización OAuthCuando OAuth está habilitado
OAUTH_CLIENT_IDID de cliente OAuthCuando OAuth está habilitado
OAUTH_CLIENT_SECRETSecreto de cliente OAuthCuando OAuth está habilitado
ADMIN_API_RESOURCE_URLIdentificador de recurso de la API de administraciónCuando OAuth está habilitado
MCP_RESOURCE_URLURL del recurso MCPCuando OAuth está habilitado
MCP_CLOUD_MODEModo de implementación en la nubeNo
MCP_SESSION_SUPPORTHabilitar persistencia de sesiónNo
ADMIN_API_V2_URLAnular el endpoint de la API de administración v2No
PUBNUB_ORIGINAnular el origen de PubNubNo
SDK_DOCS_API_URLAnular el endpoint de la API de documentaciónNo

Pruebas

npm run test:unit        # Unit tests
npm run test:integration # Integration tests (requires build)
npm run test:coverage    # Coverage report

Referencia de la API

Este servidor MCP de PubNub proporciona un conjunto completo de herramientas, recursos y prompts para ayudarte a crear aplicaciones en tiempo real. A continuación se muestra una referencia completa de toda la funcionalidad disponible:

Herramientas

Acceso a documentación

  • get_sdk_documentation - Obtén documentación del SDK principal de PubNub para lenguajes de programación y funciones específicos
  • get_chat_sdk_documentation - Obtén documentación del SDK de Chat de PubNub para lenguajes de programación y funciones específicos
  • how_to - Obtén guías conceptuales de PubNub para casos de uso e integraciones específicos
  • write_pubnub_app - Obtén la guía de mejores prácticas de PubNub que cubre arquitectura, seguridad, modelado de canales y optimización
  • get_sdk_migration_guide - Obtén guías de migración de versiones del SDK
  • get_general_migration_guide - Obtén guías generales de migración de plataforma

Gestión de aplicaciones y keysets

  • manage_apps - Gestiona aplicaciones de PubNub (listar, crear, actualizar)
  • manage_keysets - Gestiona keysets de PubNub (obtener, listar, crear, actualizar)
  • get_usage_metrics - Obtén métricas de uso para una cuenta, aplicación o keyset

Comunicación en tiempo real

  • send_pubnub_message - Envía mensajes o señales ligeras a canales de PubNub en tiempo real
  • subscribe_and_receive_pubnub_messages - Suscríbete a canales y recibe mensajes en tiempo real con tiempo de espera y límites de mensajes configurables
  • get_pubnub_messages - Obtén mensajes históricos de uno o más canales de PubNub
  • get_pubnub_presence - Obtén datos de presencia usando HereNow (ocupación del canal) o WhereNow (canales del usuario)
  • manage_app_context - Gestiona el contexto de la aplicación de PubNub (API de objetos) para usuarios, canales y membresías con operaciones CRUD completas

Análisis y automatización de Illuminate

  • manage_illuminate - Gestiona recursos de PubNub Illuminate (objetos de negocio, consultas, métricas, decisiones, paneles) con CRUD completo, activación, consultas de análisis, inspección de registros de acciones y publicación de datos de prueba

Análisis de Insights

  • insights - Consulta PubNub Insights para obtener métricas de análisis agregadas: canales/usuarios únicos, volumen de mensajes, clasificaciones top-N (canales, usuarios, tipos de mensaje), desgloses por país, tendencias de usuarios nuevos frente a recurrentes, duración de usuarios y distribuciones por tipo de dispositivo. Requiere una clave de API de Service Integration con acceso de lectura de Insights a nivel de cuenta y el nivel Insights Premium.

Prompts

Salud y cumplimiento de HIPAA

  • hipaa-chat-short - Prompt rápido para crear aplicaciones de chat compatibles con HIPAA
  • hipaa-chat-long - Prompt detallado para chat compatible con HIPAA con Pub/Sub, Presence y App Context

Desarrollo de React

  • react-app-short - Genera una aplicación React con PubNub Pub/Sub y Presence
  • react-app-long - Aplicación React completa con mensajería en tiempo real, indicadores de presencia y metadatos de usuario

Aplicaciones de juegos

  • gamelobby-short - Crea un lobby de juego multijugador con chat y presencia
  • gamelobby-long - Lobby multijugador avanzado con asignación de equipos y funciones en tiempo real

Soluciones OEM y Multiinquilino

  • oem-client-management - Crea aplicaciones y configura conjuntos de claves para implementaciones de clientes OEM
  • multi-tenant-onboarding-short - Implementa la incorporación automatizada de inquilinos para aplicaciones SaaS
  • multi-tenant-onboarding-long - Incorporación multiinquilino de nivel empresarial con aislamiento de datos y manejo de errores

Análisis y Automatización de Illuminate

  • illuminate-spam-detection - Configura un pipeline de detección de spam de Illuminate con acciones de moderación escalonadas
  • illuminate-reward-engagement - Crea un pipeline de recompensas de participación de Illuminate para eventos en vivo y juegos
  • illuminate-use-case - Configuración guiada de cualquier caso de uso de análisis y automatización de Illuminate
  • illuminate-test-verify - Prueba y verifica una configuración de Illuminate existente de principio a fin

Análisis de Insights

  • insights-snapshot - Instantánea rápida de análisis de alto nivel para un rango de fechas: canales únicos, usuarios únicos, volumen de mensajes, los 20 canales principales por mensajes y avisos de anomalías
  • insights-channel-analysis - Análisis profundo de los canales principales por categoría de clasificación, patrones de nombres de canales y comparaciones de participación entre categorías
  • insights-user-growth - Tendencias de usuarios nuevos frente a recurrentes, desgloses diarios/semanales/mensuales, principales países e identificación de usuarios destacados
  • insights-engagement-deep-dive - Duración promedio de usuario, histograma de intervalos de duración de sesión, canales principales por minutos de usuario y desglose por tipo de dispositivo entre publicadores, suscriptores y usuarios únicos

Recursos

  • pubnub_sdk_docs - Accede a la documentación del SDK de PubNub mediante el esquema URI: pubnub-docs://sdk/{language}/{feature}

Lenguajes compatibles: asyncio, c-core, c-sharp, dart, freertos, go, java, javascript, kotlin, mbed, objective-c, php, posix-c, posix-cpp, python, ruby, rust, swift, unity, unreal, windows-c, windows-cpp

Funciones compatibles: access-manager, access-manager-v2, channel-groups, configuration, encryption, files, message-actions, misc, mobile-push, objects, presence, publish-and-subscribe, storage-and-playback

  • pubnub_chat_sdk_docs - Accede a la documentación del SDK de Chat de PubNub mediante el esquema URI: pubnub-docs://chat-sdk/{language}/{feature}

Lenguajes compatibles: javascript, kotlin, swift, unity, unreal

Funciones compatibles: channels-create, channels-delete, channels-details, channels-invite, channels-join, channels-leave, channels-list, channels-membership, channels-references, channels-typing-indicator, channels-updates, channels-watch, connection-management, custom-events, error-logging, messages-delete, messages-details, messages-drafts, messages-files, messages-forward, messages-history, messages-links, messages-moderation, messages-pinned, messages-quotes, messages-reactions, messages-read-receipts, messages-restore, messages-send-receive, messages-threads, messages-unread, messages-updates, moderation, push-notifications, users-create, users-delete, users-details, users-list, users-mentions, users-moderation, users-moderation-user, users-permissions, users-presence, users-updates, utility-methods