PubNub

Acesse a documentação do SDK PubNub e os recursos da API para aplicações de comunicação em tempo

Documentação

Servidor MCP PubNub

Um servidor hospedado do Model Context Protocol (MCP) que expõe a documentação do SDK PubNub e recursos da API PubNub para ferramentas baseadas em LLM. Isso melhora a capacidade do Agente de IA LLM de entender e interagir com os SDKs e APIs da PubNub. Usa transporte HTTP com autenticação OAuth.

PubNub MCP Server

Recursos

📚 Documentação Abrangente do SDK - Acesse documentação detalhada, exemplos de código e guias de implementação para mais de 20 linguagens de programação, incluindo JavaScript, Python, Java, Swift, Kotlin, C#, Ruby, Go e outras
🏗️ Gerenciamento de Aplicações e Keysets - Crie, configure e gerencie aplicações e keysets da PubNub com recursos como persistência de mensagens, compartilhamento de arquivos, rastreamento de presença e contexto de aplicação
💬 Comunicação em Tempo Real - Envie e receba mensagens em canais, implemente chat ao vivo, notificações e atualizações em tempo real com suporte para mensagens e sinais leves
👥 Gerenciamento de Usuários e Canais - Gerencie perfis de usuários, metadados de canais e relações de associação com operações CRUD completas para construir recursos comunitários e sociais. Além disso, há uma opção para visualizar e gerenciar perfis de usuários, canais e associações no Portal Admin da PubNub (isso requer o Manage Premium).
📍 Rastreamento de Presença e Atividade - Monitore a presença de usuários em tempo real, veja quem está online nos canais e acompanhe a atividade dos usuários em sua aplicação
📊 Decisão e Análise em Tempo Real - Acione a ação certa no momento certo, meça seu impacto e ajuste conforme as condições mudam — tudo em tempo real. Requer Illuminate.
📈 Análise de Canais, Usuários e Mensagens - Identifique padrões na atividade agregada do aplicativo, desde canais principais e divisões por país até usuários novos vs. recorrentes e distribuição de dispositivos, para entender engajamento, uso e desempenho. Além disso, métricas limitadas estão disponíveis para visualização no Portal Admin da PubNub sem o Manage Premium; análises completas exigem o Manage Premium.
🔍 Uso e Monitoramento — Acompanhe o uso faturável em aplicações e keysets, revise o consumo atual e histórico e exporte relatórios para entender os fatores de custo.
🔧 Integração Multiplataforma - Funciona com Cursor, Visual Studio Code, Claude Code e outros assistentes de IA compatíveis com MCP
⚡ Experiência do Desenvolvedor - Construído com TypeScript para segurança de tipos, inclui infraestrutura de testes

Início Rápido

O servidor hospedado é gerenciado pela PubNub e oferece a maneira mais fácil de começar — sem necessidade de instalação, e a autenticação é tratada automaticamente via OAuth. Se sua ferramenta de IA não suporta servidores MCP remotos, use a versão instalada localmente (npx @pubnub/mcp@latest) em vez disso.

Nota: Para alternar para o servidor hospedado (https://mcp.pubnub.com), remova a configuração local antiga do seu cliente de IA primeiro e siga as etapas de configuração abaixo.

Servidor MCP PubNub Hospedado

Conecte seu assistente de IA ao https://mcp.pubnub.com — sem necessidade de instalação. A autenticação é tratada automaticamente via OAuth.

VS Code

Clique no botão acima e selecione Abrir no Visual Studio Code. De volta ao VS Code, clique em Instalar, selecione a organização que deseja autorizar e clique em Permitir acesso.

Alternativamente, adicione o seguinte ao seu settings.json do VS Code manualmente:

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

Saiba mais na documentação do VS Code

Cursor

Clique no botão acima e selecione Abrir Cursor. No Cursor, clique em Instalar, selecione a organização que deseja autorizar e clique em Permitir acesso. Navegue até Configurações do Cursor → Ferramentas e MCP para verificar se o PubNub está habilitado.

Alternativamente, adicione o seguinte ao .cursor/mcp.json (ou ~/.cursor/mcp.json para configuração global) manualmente:

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

Ao salvar o arquivo, uma notificação é exibida. Clique em Ativar para ativar o servidor MCP. Saiba mais na documentação do Cursor

Claude Code

No terminal, execute:

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

Em seguida, execute claude para abrir o Claude Code e digite /mcp. Selecione pubnub, depois autenticar e clique em Permitir acesso para concluir a autorização. Saiba mais na documentação do Claude Code

Claude Desktop

Nota: As instruções a seguir se aplicam aos planos Pro e Max. Para planos Enterprise, a configuração é feita pelo administrador da sua organização. Consulte a documentação da Anthropic para obter detalhes.

No Claude Desktop, navegue até Personalizar → Conectores.
Clique em + e selecione Adicionar conector personalizado.
Digite https://mcp.pubnub.com como URL do conector.
Conclua o login OAuth quando solicitado.

Saiba mais na documentação do Claude Desktop

Codex

No terminal, execute:

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

Em seguida, execute codex mcp login pubnub para autenticar, selecione a organização que deseja autorizar e clique em Permitir acesso. Saiba mais na documentação do Codex

Codex Desktop

Navegue até Configurações → Servidores MCP e clique em + Adicionar servidor.
Selecione Streamable HTTP como tipo de transporte.
Digite https://mcp.pubnub.com como URL do servidor.
Siga o prompt de login OAuth para concluir a autorização.

Saiba mais na documentação do Codex Desktop

Gemini CLI

No terminal, execute:

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

Em seguida, execute gemini para abrir o Gemini CLI e execute /mcp auth pubnub para autenticar. Saiba mais na documentação do Gemini CLI

OpenCode

Adicione o seguinte ao ~/.config/opencode/config.json:

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

Em seguida, execute opencode mcp auth pubnub para autenticar. Saiba mais na documentação do OpenCode

Servidor MCP PubNub Local

Se sua ferramenta de IA não suporta servidores MCP remotos, execute o servidor localmente com:

npx @pubnub/mcp@latest

Chave de API

Antes de começar, recomendamos fortemente criar uma Integração de Serviço no Portal Admin da PubNub e fornecer sua chave de API ao servidor MCP. Embora alguns recursos básicos funcionem sem ela, adicionar uma chave de API desbloqueia muito mais funcionalidades. Alternativamente, consulte Configuração do servidor local para obter instruções sobre como configurar o servidor para trabalhar com um único keyset da PubNub.

O processo de instalação de um servidor MCP depende do assistente de IA que você está usando. Para a configuração padrão, você precisará do Node.js (v20.0.0 ou superior).

VS Code

Basta clicar no link acima e selecionar "Abrir no Visual Studio Code" na página que aparece. De volta ao VS Code, clique em "Instalar". Você será solicitado a inserir sua Chave de API PubNub. Uma vez fornecida, seu servidor MCP está pronto para uso. Para opções de configuração adicionais, consulte Configuração do servidor local.

Cursor

Clique no link acima e selecione "Abrir Cursor" na página que aparece. De volta ao Cursor, há um prompt "Instalar Servidor MCP?". Certifique-se de fornecer o valor da variável que contém sua Chave de API PubNub. Depois de fazer isso, clique em "Instalar". Seu servidor MCP está agora pronto para uso. Para opções de configuração adicionais, consulte Configuração do servidor local.

Claude Code

Com o Claude Code instalado, execute este comando para adicionar o MCP à sua configuração. Certifique-se de substituir o 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

O servidor é adicionado no escopo "Usuário", o que significa que estará disponível em todos os projetos. Para opções de configuração adicionais, consulte Configuração do servidor local.

Codex

Com o Codex instalado, execute este comando para adicionar o MCP à sua configuração. Certifique-se de substituir o valor de <your-api-key>:

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

Para opções de configuração adicionais, consulte Configuração do servidor local.

Gemini CLI

O Gemini CLI não suporta instalações automáticas de MCP. Você terá que editar manualmente seu arquivo settings.json e adicionar a seção abaixo. Certifique-se de substituir o valor de <your-api-key>:

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

Para opções de configuração adicionais, consulte a seção Configuração do servidor local na documentação da PubNub.

Desenvolvimento

Pré-requisitos

Node.js >= 20.0.0

Executando localmente

npm install
npm run dev

Variáveis de ambiente

Variável	Descrição	Obrigatória
`PORT`	Porta do servidor HTTP (padrão: 3000)	Não
`MCP_OAUTH_ENABLED`	Habilitar autenticação OAuth	Sim (para produção)
`OAUTH_ISSUER`	URL do servidor de autorização OAuth	Quando OAuth habilitado
`OAUTH_CLIENT_ID`	ID do cliente OAuth	Quando OAuth habilitado
`OAUTH_CLIENT_SECRET`	Segredo do cliente OAuth	Quando OAuth habilitado
`ADMIN_API_RESOURCE_URL`	Identificador do recurso da API Admin	Quando OAuth habilitado
`MCP_RESOURCE_URL`	URL do recurso MCP	Quando OAuth habilitado
`MCP_CLOUD_MODE`	Modo de implantação em nuvem	Não
`MCP_SESSION_SUPPORT`	Habilitar persistência de sessão	Não
`ADMIN_API_V2_URL`	Substituir endpoint da API Admin v2	Não
`PUBNUB_ORIGIN`	Substituir origem PubNub	Não
`SDK_DOCS_API_URL`	Substituir endpoint da API de documentação	Não

Testes

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

Referência da API

Este servidor MCP PubNub fornece um conjunto abrangente de ferramentas, recursos e prompts para ajudá-lo a construir aplicações em tempo real. Abaixo está uma referência completa de toda a funcionalidade disponível:

Ferramentas

Acesso à Documentação

get_sdk_documentation - Obtenha documentação do SDK Core PubNub para linguagens de programação e recursos específicos
get_chat_sdk_documentation - Obtenha documentação do SDK Chat PubNub para linguagens de programação e recursos específicos
how_to - Obtenha guias conceituais da PubNub para casos de uso e integrações específicos
write_pubnub_app - Obtenha o guia de melhores práticas da PubNub cobrindo arquitetura, segurança, modelagem de canais e otimização
get_sdk_migration_guide - Obtenha guias de migração de versão do SDK
get_general_migration_guide - Obtenha guias gerais de migração de plataforma

Gerenciamento de Aplicações e Keysets

manage_apps - Gerencie aplicações PubNub (listar, criar, atualizar)
manage_keysets - Gerencie keysets PubNub (obter, listar, criar, atualizar)
get_usage_metrics - Busque métricas de uso para uma conta, aplicação ou keyset

Comunicação em Tempo Real

send_pubnub_message - Envie mensagens ou sinais leves para canais PubNub em tempo real
subscribe_and_receive_pubnub_messages - Assine canais e receba mensagens em tempo real com tempo limite configurável e limites de mensagens
get_pubnub_messages - Busque mensagens históricas de um ou mais canais PubNub
get_pubnub_presence - Obtenha dados de presença usando HereNow (ocupação do canal) ou WhereNow (canais do usuário)
manage_app_context - Gerencie o Contexto de Aplicação PubNub (API de Objetos) para usuários, canais e associações com operações CRUD completas

Análise e Automação Illuminate

manage_illuminate - Gerencie recursos PubNub Illuminate (objetos de negócios, consultas, métricas, decisões, painéis) com CRUD completo, ativação, consultas de análise, inspeção de log de ações e publicação de dados de teste

Análise de Insights

insights - Consulte o PubNub Insights para métricas de análise agregadas: canais/usuários únicos, volume de mensagens, classificações top-N (canais, usuários, tipos de mensagem), divisões por país, tendências de usuários novos vs. recorrentes, duração do usuário e distribuições por tipo de dispositivo. Requer uma chave de API de Integração de Serviço com acesso de Leitura de Insights em nível de conta e nível Insights Premium.

Prompts

Saúde e Conformidade HIPAA

hipaa-chat-short - Prompt rápido para criar aplicações de chat em conformidade com HIPAA
hipaa-chat-long - Prompt detalhado para chat em conformidade com HIPAA com Pub/Sub, Presença e Contexto de Aplicação

Desenvolvimento React

react-app-short - Estruture um aplicativo React com PubNub Pub/Sub e Presença
react-app-long - Aplicativo React abrangente com mensagens em tempo real, indicadores de presença e metadados de usuário

Aplicações de Jogos

gamelobby-short - Crie um lobby de jogo multiplayer com chat e presença
gamelobby-long - Lobby multiplayer avançado com atribuição de times e recursos em tempo real

Soluções OEM e Multi-Tenant

oem-client-management - Crie aplicativos e configure keysets para implantações de clientes OEM
multi-tenant-onboarding-short - Implemente onboarding automatizado de tenants para aplicações SaaS
multi-tenant-onboarding-long - Onboarding multi-tenant de nível empresarial com isolamento de dados e tratamento de erros

Illuminate Analytics e Automação

illuminate-spam-detection - Configure um pipeline de detecção de spam do Illuminate com ações de moderação escalonadas
illuminate-reward-engagement - Crie um pipeline de recompensas de engajamento do Illuminate para eventos ao vivo e jogos
illuminate-use-case - Configuração guiada de qualquer caso de uso de análise e automação do Illuminate
illuminate-test-verify - Teste e verifique uma configuração Illuminate existente de ponta a ponta

Insights Analytics

insights-snapshot - Instantâneo rápido de análise de alto nível para um intervalo de datas: canais únicos, usuários únicos, volume de mensagens, top 20 canais por mensagens e alertas de anomalias
insights-channel-analysis - Análise aprofundada dos principais canais por categoria de classificação, padrões de nomenclatura de canais e comparações de engajamento entre categorias
insights-user-growth - Tendências de usuários novos vs. recorrentes, detalhamentos diários/semanais/mensais, principais países e identificação de usuários whale
insights-engagement-deep-dive - Duração média do usuário, histograma de intervalos de duração de sessão, principais canais por minutos de usuário e detalhamento por tipo de dispositivo entre publicadores, assinantes e usuários únicos

Recursos

pubnub_sdk_docs - Acesse a documentação do SDK PubNub via esquema de URI: pubnub-docs://sdk/{language}/{feature}

Idiomas suportados: 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

Recursos suportados: 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 - Acesse a documentação do SDK de Chat PubNub via esquema de URI: pubnub-docs://chat-sdk/{language}/{feature}

Idiomas suportados: javascript, kotlin, swift, unity, unreal

Recursos suportados: 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