Integrations
Provides formatted SDK documentation for PubNub's JavaScript SDK, allowing developers to access reference materials for methods like subscribe() and publish() from within Cursor IDE.
Supports PubNub functionality through Node.js, allowing users to publish messages to channels, subscribe to channels, fetch message history, and retrieve presence information.
Offers access to PubNub's Python SDK documentation, enabling users to fetch docs for methods like publish() directly through Cursor IDE.
用于 Cursor IDE 的 PubNub 模型上下文协议 (MCP) 服务器
此存储库提供了一个基于 CLI 的模型上下文协议 (MCP) 服务器,该服务器将 PubNub SDK 文档和 PubNub 函数资源公开给 LLM 驱动的工具。将此服务器添加到 Cursor IDE 后,您可以:
- 获取格式化的 PubNub JavaScript、Python 和 Java SDK 文档。
- 从静态 Markdown 文件访问 PubNub Functions 文档。
示例提示
- “向
my_channel
频道发布一条消息,内容为Hello, PubNub!
。” - “向我展示
subscribe()
的 PubNub JavaScript SDK 文档。” - “列出所有可用的 PubNub 函数。”
- “获取
publish()
方法的 Python SDK 文档。” - “获取
test
频道的消息历史记录。” - “
test
频道和default
频道组的存在信息(占用率和 UUID)。”
这需要 Node.js (>= 18) 和 npm ( https://nodejs.org/ ) npx
将自动获取并运行最新的 MCP 服务器。
先决条件
- Node.js(>= 18)和 npm
- 带有 MCP 支持的 Cursor IDE
- (可选)用于现场示例的 PubNub 帐户和 API 密钥
安装
在本地运行 PubNub MCP 服务器或通过 npx 将其添加到 Cursor IDE 的首选方法:
配置
光标必须处于代理模式才能使用 MCP 服务器。
Cursor IDE 通过 JSON 配置文件发现 MCP 服务器。您可以全局或按项目配置 PubNub MCP 服务器。
全局配置
编辑或创建~/.cursor/mcp.json
:
项目配置
在您的项目目录中,创建.cursor/mcp.json
:
command
指定启动 MCP 服务器的可执行文件。args
指定传递给命令的参数。env
为服务器进程设置环境变量。
在 Cursor IDE 中使用
- 重新启动 Cursor IDE 或打开一个新会话。
- 打开 MCP 设置窗格并验证pubnub服务器是否列在可用工具和资源下。
- 在聊天中,调用可用资源:
pubnub://docs/javascript
— 获取 PubNub JavaScript SDK 文档pubnub://docs/python
— 获取 PubNub Python SDK 文档pubnub://docs/java
— 获取 PubNub Java SDK 文档pubnub://functions
— 列出 PubNub 函数(来自resources/pubnub_functions.md
静态内容)
- 在出现提示时批准资源执行,或在受信任资源的设置中启用自动运行。
克劳德·科德
输出将是:
示例提示
使用以下命令删除 MCP 服务器:
使用 Claude Desktop
- 在工具部分中,添加一个名为pubnub的新工具。
- 将命令设置为
npx
,将参数设置为["-y", "@pubnub/mcp"]
。 - 为您的 PubNub 密钥添加环境变量:
PUBNUB_SUBSCRIBE_KEY
PUBNUB_PUBLISH_KEY
- 保存配置。
Claude Desktop 可能使用了旧版本的 Node.js。您可能需要将命令设置为 Node.js 安装的完整路径。
MCP 服务器位于index.js
文件中:
执照
本项目遵循 MIT 许可证。详情请参阅LICENSE文件。
故障排除
- 必须处于代理模式才能使用 MCP 服务器。
- 验证 Node.js 和 npm 安装。
- 确保
server.js
具有执行权限。 - 检查
command
、args
和env
设置是否正确。 - 查看 Cursor IDE 日志以查找 MCP 启动错误。
直接 JSON-RPC 命令行用法
您可以使用 JSON-RPC v2.0 直接通过 STDIN/STDOUT 调用 MCP 服务器。请确保您的 PubNub 密钥已在环境中设置,例如:
服务器运行后(或使用一次性调用),通过将 JSON 管道传输到node index.js
来发送请求。示例:
快速 JSON-RPC 示例
以下是使用 STDIN/STDOUT 获取 PubNub SDK 文档并发布消息的简化 JSON-RPC v2.0 命令行示例。
1)获取 PubNub JavaScript SDK 文档
2)向 PubNub 频道发布消息
执照
麻省理工学院
You must be authenticated.
Tools
基于 CLI 的模型上下文协议服务器,将 PubNub SDK 文档和函数资源公开给 Cursor IDE 等 LLM 驱动的工具,使用户能够获取文档并通过自然语言提示与 PubNub 频道进行交互。
Related MCP Servers
- AsecurityAlicenseAqualityA template for creating and connecting custom tools to Cursor IDE using Model Context Protocol with support for cheerful server responses.Last updated -41PythonMIT License
- -securityFlicense-qualityA simple Model Context Protocol server that enables searching and retrieving relevant documentation snippets from Langchain, Llama Index, and OpenAI official documentation.Last updated -Python
- -securityFlicense-qualityA customized MCP server that enables integration between LLM applications and documentation sources, providing AI-assisted access to LangGraph and Model Context Protocol documentation.Last updated -Python
- AsecurityAlicenseAqualityA Model Context Protocol server that loads multiple OpenAPI specifications and exposes them to LLM-powered IDE integrations, enabling AI to understand and work with your APIs directly in development tools like Cursor.Last updated -72927TypeScriptMIT License