PubNub MCP服务器v2
此存储库提供了一个基于CLI的模型上下文协议（MCP）服务器，该服务器公开 PubNub SDK文档 以及PubNub API资源到LLM驱动的工具。这提高了LLM AI Agent理解PubNub的SDK和API并与之交互的能力。
特性
- 📚 全面的SDK文档 -访问20多种编程语言的详细文档、代码示例和实现指南，包括JavaScript、Python、Java、Swift、Kotlin、C#、Ruby、Go等
- 🏗️ 应用程序和密钥集管理 -创建、配置和管理PubNub应用程序和密钥集，具有消息持久性、文件共享、状态跟踪和应用程序上下文等功能
- 💬 实时通信 -跨渠道发送和接收消息，实现实时聊天、通知和实时更新，同时支持消息和轻量级信号
- 👥 用户和渠道管理 -通过完整的CRUD操作管理用户配置文件、频道元数据和成员关系，以构建社区和社交功能
- 📍 状态和活动跟踪 -监控实时用户状态，查看渠道中的在线用户，并跟踪整个应用程序中的用户活动
- 📊 照亮分析和自动化 -配置Illuminate业务对象、查询、指标、决策和仪表板，以构建实时分析管道和事件驱动的自动化
- 🔧 多平台集成 -适用于Cursor、Visual Studio Code、Claude Code和其他兼容MCP的AI助手
- ⚡ 开发者体验 -使用TypeScript构建类型安全，包括测试基础设施，可以作为Node包或Docker镜像安装
快速开始
API密钥
在您开始之前，我们强烈建议 创建服务集成 在PubNub管理门户中，并将您的API密钥提供给MCP服务器。虽然一些基本功能在没有它的情况下可以工作，但添加API密钥可以解锁更多功能。或者，请参阅 高级用法 有关配置服务器以使用单个PubNub密钥集的说明。
MCP服务器的安装过程取决于您使用的AI助手。对于标准设置，您需要 （v20.0.0或更高版本）。
VS Code
只需单击上面的链接，然后在显示的页面上选择“在Visual Studio代码中打开”。回到VS Code，点击“安装”。系统将提示您输入您的PubNub API密钥。一旦提供，您的MCP服务器就可以使用了。有关其他配置选项，请参阅 高级用法.
光标
单击上面的链接，然后在出现的页面上选择“打开光标”。回到Cursor，有一个“安装MCP服务器？”提示。确保为持有PubNub API密钥的变量提供值。完成后，单击“安装”。您的MCP服务器现在可以使用了。有关其他配置选项，请参阅 高级用法.
克劳德代码
安装了Claude Code后，运行此命令将MCP添加到您的配置中。确保替换以下值 ``:
claude mcp add PubNub --env PUBNUB_API_KEY= --scope user --transport stdio -- npx -y @pubnub/mcp@latest服务器被添加到“用户”范围中，这意味着它将在所有项目中可用。有关其他配置选项，请参阅 高级用法.
法典
安装Codex后，运行此命令将MCP添加到您的配置中。确保替换以下值 ``:
codex mcp add PubNub --env PUBNUB_API_KEY= -- npx -y @pubnub/mcp@latest有关其他配置选项，请参阅 高级用法.
Gemini CLI
Gemini CLI不支持自动MCP安装。您将手动编辑您的 settings.json 文件并添加下面的部分。确保替换以下值 ``:
"mcpServers": {
"pubnub": {
"command": "npx",
"args": [
"-y",
"@pubnub/mcp@latest"
],
"env": {
"PUBNUB_API_KEY": ""
}
}
}有关其他配置选项，请参阅 高级用法.
高级用法
配置
PUBNUB_API_KEY-您的PubNub API密钥。与您的帐户/密钥集相关的所有操作都需要PUBNUB_PUBLISH_KEY-用于实时操作的可选PubNub发布密钥PUBNUB_SUBSCRIBE_KEY-用于实时操作的可选PubNub订阅密钥PUBNUB_USER_ID-可选变量，可用于更改SDK（实时）操作的用户ID（默认值：pubnub-mcp)PUBNUB_EMAIL-（已弃用-请改用API密钥）您的PubNub帐户电子邮件。与您的帐户/密钥集相关的所有操作都需要PUBNUB_PASSWORD-（已弃用-请改用API密钥）您的PubNub帐户密码。与您的帐户/密钥集相关的所有操作都需要
PubNub密钥配置
MCP服务器支持两种处理PubNub发布/订阅密钥的模式：
动态模式（未设置环境键）
当 PUBNUB_PUBLISH_KEY 和 PUBNUB_SUBSCRIBE_KEY 是 未提供，服务器以动态模式运行：
- 工具将在每次调用中请求密钥作为参数
- AI代理可以与 多个密钥集 在一次会议中
- 密钥可以通过以下方式动态发现
manage_keysets工具 - 更自主-代理根据上下文决定使用哪个密钥集
当您希望AI帮助管理多个应用程序或应在运行时确定密钥集时，此模式是理想的。
固定模式（环境键集）
当两者都 PUBNUB_PUBLISH_KEY 和 PUBNUB_SUBSCRIBE_KEY 是 提供，服务器以固定模式运行：
- PubSub密钥参数为 隐藏 完全基于工具模式
- 所有实时操作都自动使用配置的密钥
- 操作是 仅限于一个密钥集
此模式非常适合于使用特定应用程序并希望简化交互的集中工作流。
固定按键配置示例：
{
"env": {
"PUBNUB_API_KEY": "",
"PUBNUB_PUBLISH_KEY": "pub-c-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"PUBNUB_SUBSCRIBE_KEY": "sub-c-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}基于Docker的使用
如果您更喜欢通过Docker运行MCP服务器，请在编辑器的配置文件中使用以下代码段 mcpServers 或 servers mcp.json的一部分：
{
"mcpServers": {
"PubNub": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"PUBNUB_API_KEY",
"pubnub/pubnub-mcp-server"
],
"env": {
"PUBNUB_API_KEY": "",
}
}
}
}API 参考
此PubNub MCP服务器提供了一套全面的工具、资源和提示，以帮助您构建实时应用程序。以下是所有可用功能的完整参考：
工具
文档访问
get_sdk_documentation-获取特定编程语言和功能的PubNub Core SDK文档get_chat_sdk_documentation-获取特定编程语言和功能的PubNub Chat SDK文档how_to-获取特定用例和集成的PubNub概念指南write_pubnub_app-获取涵盖架构、安全、渠道建模和优化的PubNub最佳实践指南
应用程序和密钥集管理
manage_apps-使用以下操作管理PubNub应用程序：列出、创建和更新（需要API密钥验证）manage_keysets-使用以下操作管理PubNub密钥集：获取、列出、创建和更新（需要API密钥验证）get_usage_metrics-获取帐户、应用程序或密钥集的使用指标（需要API密钥身份验证）
实时通信
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资源（业务对象、查询、指标、决策、仪表板）
提示
医疗保健和HIPAA合规性
hipaa-chat-short-快速提示创建符合HIPAA标准的聊天应用程序hipaa-chat-long-使用Pub/Sub、Presence和App Context进行HIPAA兼容聊天的详细提示
照亮分析和自动化
illuminate-spam-detection-通过逐步升级的审核操作建立一个照亮垃圾邮件检测管道illuminate-reward-engagement-为现场活动和游戏建立Illuminate参与奖励渠道illuminate-use-case-指导任何Illuminate分析和自动化用例的设置illuminate-test-verify-端到端测试和验证现有的Illuminate配置
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-企业级多租户入职培训，具有数据隔离和错误处理功能
资源
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、团结、虚幻
支持的功能：频道创建、频道删除、频道详细信息、频道邀请、频道加入、频道离开、频道列表、频道成员资格、频道引用、频道键入指示器、频道更新、频道监视、连接管理、自定义事件、错误记录、消息删除、消息详细信息、消息草稿、消息文件、消息转发、消息历史记录、消息链接、消息审核、消息固定、消息引用、消息反应、消息读取收据、消息还原、消息发送接收、消息线程、未读消息、消息更新、审核、推送通知、用户创建、用户删除、用户详细信息、用户列表、用户提及、用户审核、用户审核用户、用户权限、用户存在、用户更新、实用方法