使用说明
PubNub照亮MCP
此存储库包含将Illuminate支持添加到 @pubnub/mcp npm包。
目录
illuminate_mcp_architecture_plan.md
添加的总体集成计划 manage_illuminate --一种新工具——投入生产 pubnub-mcp-server TypeScript包。涵盖了模块结构、工具架构、身份验证、决策创建流程、环境配置、Claude行为说明、测试方法、文档API工作以及完整的更改摘要。
请先阅读本文，了解正在构建的内容及其原因。
phases/
执行路线图分为三个独立的阶段计划。每个文件都是为未来的Claude编写的，以便他独立获取和实现。
| 文件 | 目标 | 取决于 |
|---|---|---|
phase-1-documentation-api.md |
在API文档中发布9个操作指南和阐明最佳实践部分；注册9蛞蝓 pubnub-mcp-server/src/lib/docs/schemas.ts |
没什么，先开始 |
phase-2-core-tool.md |
实施 manage_illuminate 工具 pubnub-mcp-server （4英尺模块， tools.ts 接线、环境配置、构建验证） |
第1阶段正在进行中 |
phase-3-prompts-and-tests.md |
将4个照亮提示合并到 src/prompts.ts，编写处理程序测试套件，最终构建检查 |
第2阶段合并 |
推荐订单： 立即启动第一阶段（它是独立的）。在第一阶段进行后开始第二阶段，以便在工具发货时提供文件。第三阶段紧随第二阶段。
how-tos/
每种Illuminate资源类型的分步指南。其中8个文件今天存在； how_to_automate_illuminate_with_scripts.md 仍然需要在第一阶段发货之前创建。
| 文件 | 主题 | 发布到文档API？ |
|---|---|---|
how_to_get_an_illuminate_api_key.md |
从PubNub门户生成服务集成API密钥 | 否-仅限本地引用 |
how_to_create_illuminate_business_objects.md |
创建、配置和激活业务对象 | 是-- how-to-create-illuminate-business-objects |
how_to_create_illuminate_metrics.md |
创建COUNT、SUM、AVG、MIN、MAX指标 | 是-- how-to-create-illuminate-metrics |
how_to_create_illuminate_queries.md |
创建并运行已保存的查询 | 是-- how-to-create-illuminate-queries |
how_to_create_illuminate_decisions.md |
使用4步工作流创建所有3种决策类型 | 是-- how-to-create-illuminate-decisions |
how_to_create_illuminate_dashboards.md |
使用图表和决策叠加创建仪表板 | 是-- how-to-create-illuminate-dashboards |
how_to_test_illuminate_with_fake_data.md |
发布虚假信息并验证决策-- how-to-test-illuminate-with-fake-data |
|
how_to_analyze_illuminate_data.md |
运行即席查询以检查实时业务对象数据 | 是-- how-to-analyze-illuminate-data |
how_to_automate_illuminate_with_scripts.md |
Illuminate的Python脚本自动化 （需要创建） | 是的-- how-to-automate-illuminate-with-scripts |
第十个指南(set-up-illuminate-gaming)还需要创建和发布涵盖现场活动和游戏用例的内容。看 phases/phase-1-documentation-api.md 用于完整的段塞映射。
每个现有文件都有YAML frontmatter(resource, triggers, requires, produces)以及a ## Using the manage_illuminate Tool 部分使用MCP工具调用JSON示例。
bestpractice.md
完整的PubNub最佳实践指南。第13-19节涵盖了照明，并将添加到 /best-practice 端点在 PubNubDevelopers/documentation-api，通过 write_pubnub_app 工具。全部 manage_illuminate 整个工具参考都是正确的。
prompts.ts
MCP提示定义与使用的格式相同 pubnub-mcp-server/src/prompts.ts。包含所有9个现有的PubNub提示以及4个新的特定于Illuminate的提示（共13个）。4个发光提示将合并到 src/prompts.ts 在 pubnub-mcp-server 作为第三阶段的一部分。
| 提示名称 | 标题 | 角色 |
|---|---|---|
illuminate-spam-detection |
设置照亮垃圾邮件检测 | 社区版主 |
illuminate-reward-engagement |
奖励参与直播活动 | 直播活动经理 |
illuminate-use-case |
设置照明用例 | 产品经理 |
illuminate-test-verify |
测试和验证照明设置 | 开发人员 |
所有4个提示都遵循预览优先的方法：用简单的英语描述自动化，显示条件→ 动作决策表，与用户确认，然后构建。
相关存储库
| 代表 | 角色 |
|---|---|
pubnub/pubnub-mcp-server |
生产TypeScript MCP服务器——其中 manage_illuminate 将实施 |
PubNubDevelopers/documentation-api |
主持由 how_to 和 write_pubnub_app 工具 |
