Name: 模型上下文协议服务器
Author: pubnub

使用说明

PubNub MCP服务器

一个托管的模型上下文协议（MCP）服务器，它公开 PubNub SDK文档以及PubNub API资源到LLM驱动的工具。这提高了LLM AI Agent理解PubNub的SDK和API并与之交互的能力。使用HTTP传输和OAuth身份验证。

特征

📚 全面的SDK文档 -访问20多种编程语言的详细文档、代码示例和实现指南，包括JavaScript、Python、Java、Swift、Kotlin、C#、Ruby、Go等
🏗️ 应用程序和密钥集管理 -创建、配置和管理PubNub应用程序和密钥集，具有消息持久性、文件共享、状态跟踪和应用程序上下文等功能
💬 实时通信 -跨渠道发送和接收消息，实现实时聊天、通知和实时更新，同时支持消息和轻量级信号
👥 用户和渠道管理 -通过完整的CRUD操作管理用户配置文件、频道元数据和成员关系，以构建社区和社交功能。此外，您还可以在PubNub管理门户中查看和管理用户配置文件、频道和会员资格（这需要manage Premium）。
📍 状态和活动跟踪 -监控实时用户状态，查看渠道中的在线用户，并跟踪整个应用程序中的用户活动
📊 实时决策与分析 -在重要的时候触发正确的行动，衡量其影响，并随着条件的变化进行调整——所有这些都是实时的。需要照明。
📈 渠道、用户和消息分析 -发现聚合应用活动的模式，从顶级渠道和国家细分到新用户和经常用户以及设备分布，以了解参与度、使用率和性能。此外，在没有Manage Premium的情况下，PubNub管理门户中可查看的指标有限；完整的分析需要Manage Premium。
🔍 使用与监控 --跟踪应用程序和密钥集的计费使用情况，查看当前和历史消耗情况，并导出报告以了解成本驱动因素。
🔧 多平台集成 -适用于Cursor、Visual Studio Code、Claude Code和其他兼容MCP的AI助手
⚡ 开发者体验 -使用TypeScript构建类型安全，包括测试基础设施

快速开始

这托管服务器由PubNub管理，提供了最简单的入门方法——无需安装，身份验证通过OAuth自动处理。如果您的AI工具不支持远程MCP服务器，请使用本地安装版本 (npx @pubnub/mcp@latest)相反。

注：切换到托管服务器(https://mcp.pubnub.com)，首先从AI客户端中删除旧的本地配置，然后按照以下设置步骤进行操作。

托管PubNub MCP服务器

将您的AI助手连接到 https://mcp.pubnub.com --无需安装。身份验证是通过OAuth自动处理的。

VS Code

单击上面的按钮，然后选择 在Visual Studio代码中打开.返回VS Code，单击安装，然后选择要授权的组织并单击 允许访问.

或者，将以下内容添加到您的VS代码中 settings.json 手动：

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

在VS Code文档中了解更多信息

光标

单击上面的按钮，然后选择 打开的游标。在光标中，单击安装，选择要授权的组织，然后单击 允许访问。导航到光标设置→ 工具和MCP 验证PubNub是否已启用。

或者，添加以下内容 .cursor/mcp.json （或 ~/.cursor/mcp.json 用于全局配置）手动：

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

保存文件时，会显示一条通知。点击启用以激活MCP服务器。在Cursor文档中了解更多信息

克劳德代码

在终端中，运行：

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

然后运行 claude 打开克劳德代码并输入 /mcp。选择 普布纳布那么验证，然后单击 允许访问 以完成授权。在Claude Code文档中了解更多信息

克劳德桌面

注：以下说明适用于 专业版 和 马克斯 计划。对于企业计划中，设置由您的组织管理员配置。参见 Anthropic的文件了解详情。

在Claude Desktop中，导航到 定制→ 连接器.
点击 + 并选择 添加自定义连接器.
进入 https://mcp.pubnub.com 作为连接器URL。
在系统提示时完成OAuth登录。

在Claude Desktop文档中了解更多信息

法典

在终端中，运行：

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

然后运行 codex mcp login pubnub 要进行身份验证，请选择要授权的组织，然后单击 允许访问. 在Codex文档中了解更多信息

Codex桌面

导航至 设置→ MCP服务器 然后单击 +添加服务器.
选择 可流式传输的HTTP 作为运输类型。
进入 https://mcp.pubnub.com 作为服务器URL。
按照OAuth登录提示完成授权。

在Codex Desktop文档中了解更多信息

Gemini CLI

在终端中，运行：

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

然后运行 gemini 打开Gemini CLI并运行 /mcp auth pubnub 以进行身份验证。在Gemini CLI文档中了解更多信息

开源代码

添加以下内容 ~/.config/opencode/config.json:

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

然后运行 opencode mcp auth pubnub 以进行身份验证。在OpenCode文档中了解更多信息

本地PubNub MCP服务器

如果您的AI工具不支持远程MCP服务器，请使用以下命令在本地运行服务器：

npx @pubnub/mcp@latest

API密钥

在您开始之前，我们强烈建议创建服务集成在PubNub管理门户中，并将您的API密钥提供给MCP服务器。虽然一些基本功能在没有它的情况下可以工作，但添加API密钥可以解锁更多功能。或者，请参阅本地服务器配置有关配置服务器以使用单个PubNub密钥集的说明。

MCP服务器的安装过程取决于您使用的AI助手。对于标准设置，您需要 Node.js （v20.0.0或更高版本）。

VS Code

只需单击上面的链接，然后在显示的页面上选择“在Visual Studio代码中打开”。回到VS Code，点击“安装”。系统将提示您输入您的PubNub API密钥。一旦提供，您的MCP服务器就可以使用了。有关其他配置选项，请参阅本地服务器配置.

光标

单击上面的链接，然后在出现的页面上选择“打开光标”。回到Cursor，有一个“安装MCP服务器？”提示。确保为持有PubNub API密钥的变量提供值。完成后，单击“安装”。您的MCP服务器现在可以使用了。有关其他配置选项，请参阅本地服务器配置.

克劳德代码

安装了Claude Code后，运行此命令将MCP添加到您的配置中。确保替换以下值 <your-api-key>:

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

服务器被添加到“用户”范围中，这意味着它将在所有项目中可用。有关其他配置选项，请参阅本地服务器配置.

法典

安装Codex后，运行此命令将MCP添加到您的配置中。确保替换以下值 <your-api-key>:

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

有关其他配置选项，请参阅本地服务器配置.

Gemini CLI

Gemini CLI不支持自动MCP安装。您必须手动编辑您的 settings.json 文件并添加下面的部分。确保替换以下值 <your-api-key>:

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

有关其他配置选项，请参阅本地服务器配置 PubNub文档中的部分。

发展

先决条件

Node.js>=20.0.0

在本地运行

npm install
npm run dev

环境变量

变量	描述	必填
`PORT`	HTTP服务器端口（默认值：3000）	否
`MCP_OAUTH_ENABLED`	启用OAuth身份验证	是（用于生产）
`OAUTH_ISSUER`	OAuth授权服务器URL	启用OAuth时
`OAUTH_CLIENT_ID`	OAuth客户端ID	启用OAuth时
`OAUTH_CLIENT_SECRET`	OAuth客户端机密	启用OAuth时
`ADMIN_API_RESOURCE_URL`	管理员API资源标识符	启用OAuth时
`MCP_RESOURCE_URL`	MCP资源URL	启用OAuth时
`MCP_CLOUD_MODE`	云部署模式	否
`MCP_SESSION_SUPPORT`	启用会话持久性	否
`ADMIN_API_V2_URL`	覆盖管理员API v2终结点	否
`PUBNUB_ORIGIN`	覆盖PubNub来源	否
`SDK_DOCS_API_URL`	覆盖文档API端点	否

测试

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

api参考

此PubNub MCP服务器提供了一套全面的工具、资源和提示，以帮助您构建实时应用程序。以下是所有可用功能的完整参考：

工具

文档访问

get_sdk_documentation -获取特定编程语言和功能的PubNub Core SDK文档
get_chat_sdk_documentation -获取特定编程语言和功能的PubNub Chat SDK文档
how_to -获取特定用例和集成的PubNub概念指南
write_pubnub_app -获取涵盖架构、安全、渠道建模和优化的PubNub最佳实践指南
get_sdk_migration_guide -获取SDK版本迁移指南
get_general_migration_guide -获取通用平台迁移指南

应用程序和密钥集管理

manage_apps -管理PubNub应用程序（列表、创建、更新）
manage_keysets -管理PubNub密钥集（获取、列出、创建、更新）
get_usage_metrics -获取帐户、应用程序或密钥集的使用指标

实时通信

send_pubnub_message -实时向PubNub频道发送消息或轻量级信号
subscribe_and_receive_pubnub_messages -订阅频道并接收具有可配置超时和消息限制的实时消息
get_pubnub_messages -从一个或多个PubNub频道获取历史消息
get_pubnub_presence -使用HereNow（频道占用率）或WhereNow（用户频道）获取在线状态数据
manage_app_context -使用完整的CRUD操作管理用户、渠道和成员资格的PubNub应用程序上下文（对象API）

照亮分析和自动化

manage_illuminate -通过完整的CRUD、激活、分析查询、操作日志检查和测试数据发布来管理PubNub Illuminate资源（业务对象、查询、指标、决策、仪表板）

洞察分析

insights -查询PubNub Insights以获取聚合分析指标：独特渠道/用户、消息量、前N名排名（渠道、用户、消息类型）、国家细分、新用户与重复用户趋势、用户持续时间和设备类型分布。需要一个服务集成API密钥，具有会计级Insights Read访问权限和Insights Premium层。

提示

医疗保健和HIPAA合规性

hipaa-chat-short -快速提示创建符合HIPAA标准的聊天应用程序
hipaa-chat-long -使用Pub/Sub、Presence和App Context进行HIPAA兼容聊天的详细提示

React开发

react-app-short -使用PubNub Pub/Sub和Presence构建React应用程序
react-app-long -具有实时消息、状态指示器和用户元数据的全面React应用程序

游戏应用

gamelobby-short -通过聊天和在线状态构建多人游戏大厅
gamelobby-long -先进的多人大厅，具有团队任务和实时功能

OEM和多租户解决方案

oem-client-management -为OEM客户端部署创建应用程序并配置密钥集
multi-tenant-onboarding-short -为SaaS应用程序实施自动租户入职
multi-tenant-onboarding-long -企业级多租户入职培训，具有数据隔离和错误处理功能

照亮分析和自动化

illuminate-spam-detection -通过逐步升级的审核操作建立一个照亮垃圾邮件检测管道
illuminate-reward-engagement -为现场活动和游戏建立Illuminate参与奖励渠道
illuminate-use-case -指导任何Illuminate分析和自动化用例的设置
illuminate-test-verify -端到端测试和验证现有的Illuminate配置

洞察分析

insights-snapshot -日期范围的快速高级分析快照：唯一渠道、唯一用户、消息量、按消息排列的前20个渠道和异常标注
insights-channel-analysis -通过排名类别、渠道命名模式和跨类别参与度比较深入了解顶级渠道
insights-user-growth -新用户与重复用户趋势、每日/每周/每月细分、主要国家和鲸鱼用户识别
insights-engagement-deep-dive -平均用户持续时间、会话长度桶直方图、按用户分钟划分的顶级频道以及发布、订阅者和唯一用户的设备类型细分

资源

pubnub_sdk_docs -通过URI方案访问PubNub SDK文档： pubnub-docs://sdk/{language}/{feature}

支持的语言：asyncio、c-core、c-sharp、dart、freertos、go、java、javascript、kotlin、mbed、objective-c、php、posix-c、posix-cpp、python、ruby、rust、swift、unity、real、windows-c、windowscpp

支持的功能：访问管理器、访问管理器v2、通道组、配置、加密、文件、消息操作、杂项、移动推送、对象、状态、发布和订阅、存储和回放

pubnub_chat_sdk_docs -通过URI方案访问PubNub Chat SDK文档： pubnub-docs://chat-sdk/{language}/{feature}

支持的语言：javascript、kotlin、swift、团结、虚幻

支持的功能：频道创建、频道删除、频道详细信息、频道邀请、频道加入、频道离开、频道列表、频道成员资格、频道引用、频道键入指示器、频道更新、频道监视、连接管理、自定义事件、错误记录、消息删除、消息详细信息、消息草稿、消息文件、消息转发、消息历史记录、消息链接、消息审核、消息固定、消息引用、消息反应、消息读取回执、消息还原、消息发送接收、消息线程、未读消息、消息更新、审核、推送通知、用户创建、用户删除、用户详细信息、用户列表、用户提及、用户审核、用户审核用户、用户权限、用户存在、用户更新、实用方法

使用说明

PubNub MCP服务器

特征

快速开始

托管PubNub MCP服务器

VS Code

光标

克劳德代码

克劳德桌面

法典

Codex桌面

Gemini CLI

开源代码

本地PubNub MCP服务器

API密钥

VS Code

光标

克劳德代码

法典

Gemini CLI

发展

先决条件

在本地运行

环境变量

测试

api参考

工具

文档访问

应用程序和密钥集管理

实时通信

照亮分析和自动化

洞察分析

提示

医疗保健和HIPAA合规性

React开发

游戏应用

OEM和多租户解决方案

照亮分析和自动化

洞察分析

资源

相关 MCP

APISIX MCP服务器

API测试管理工具

NodeMCU设备管理服务

OpenAPI拆分工具

API管理工具

集成开发助手服务