mcpField
K
knock-migrate-to-knock

knock-migrate-to-knock

github.com/knocklabs开发168 次安装3 天前更新
代码仓库

关于 knock-migrate-to-knock

此技能扫描代码库中的消息服务商、SDK、模板和发送调用，映射到 Knock 概念，并生成分阶段迁移计划。它侧重发现与建议，计划写入仓库根目录的 `knock-plan.md`，不会擅自修改 Knock 资源。

主要功能

  1. 01盘点现有消息技术栈
  2. 02映射消息概念到 Knock
  3. 03制定分阶段迁移计划
  4. 04将计划写入 `knock-plan.md`
  5. 05避免未经许可写入 Knock 资源

适用场景

  1. 01评估从 Braze 或 Courier 迁移
  2. 02梳理邮件、推送等消息发送方式
  3. 03规划应用触发切换与旧发送下线

MCP 相关

该技能要求在未获明确授权前，不通过 MCP 或 CLI 创建、更新、推送、提交或删除 Knock 资源。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/knocklabs/skills --skill knock-migrate-to-knock

安装后在 Claude Code 中输入/knock-migrate-to-knock确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

rules/
inventory-existing-messaging.md
map-concepts-to-knock.md
migration-plan.md

详细介绍

迁移到 Knock 的技能

发现此代码库中的当前消息传递技术栈，将其映射到 Knock 概念，并制定有序的迁移计划。这是一项发现与建议技能。

严格限制

除非用户在审阅计划后明确提出要求，否则不得通过 MCP 或 CLI 创建、更新、推送、提交或删除 Knock 资源（工作流、指南、用户、租户、偏好设置、局部模板、布局）。不得运行生产环境导入。仅输出计划、清单，以及可选的本地应用代码建议。

输出约定（严格）

将清单和迁移计划写入仓库根目录下的 knock-plan.md（knock-product-messaging-strategy 和 knock-lifecycle-opportunities 共用的计划文件；创建或更新此文件，不要另建计划）。聊天内容保持简短——仅提供状态和确认。

不要在聊天中粘贴清单表格或完整的分阶段计划。

允许的聊天内容：

  1. 一行简短状态（路径 + 计数，例如检测到的平台和发现的消息类型数量）
  2. 可选的一行阻碍说明
  3. 以加粗确认问题作为最后一行

示例：

已写入 knock-plan.md：检测到 Courier + SendGrid，盘点了 14 种消息类型，拟定了 8 阶段计划。

接下来要详细规划哪个迁移阶段？

参考文档（在输出中添加链接）

建议必须始终以 Knock 文档为依据。优先使用以下文档：

情况文档
Braze → Knockhttps://docs.knock.app/tutorials/migrate-from-braze
Courier → Knockhttps://docs.knock.app/tutorials/migrate-from-courier
通过 MCP 迁移电子邮件模板（仅当用户要求执行时）https://docs.knock.app/tutorials/migrate-email-with-mcp-server
工作流https://docs.knock.app/concepts/workflows
渠道https://docs.knock.app/concepts/channels
用户https://docs.knock.app/concepts/users
偏好设置https://docs.knock.app/preferences/overview
租户 / 多租户https://docs.knock.app/multi-tenancy/overview
订阅https://docs.knock.app/concepts/subscriptions
翻译https://docs.knock.app/template-editor/translations
触发工作流https://docs.knock.app/send-notifications/triggering-workflows
来源（CDP）https://docs.knock.app/integrations/sources/overview

概述

  1. 盘点当前技术栈（rules/inventory-existing-messaging.md）
  2. 将概念映射到 Knock（rules/map-concepts-to-knock.md）
  3. 制定分阶段迁移计划（rules/migration-plan.md）

如何使用此技能

  1. 在仓库中搜索服务提供商、SDK、模板和发送调用位置（参见盘点规则）——将发现记录在 knock-plan.md 中，而不是聊天里。
  2. 确定源平台：Braze、Courier、Customer.io、Iterable、Novu、直接使用 ESP（SendGrid/Postmark/Resend/SES）、Slack 机器人、自定义队列等。
  3. 如果是 Braze 或 Courier，请打开对应的迁移教程；否则使用 rules/map-concepts-to-knock.md 中的通用映射表。
  4. 将分阶段迁移计划（阶段、风险、Knock 概念链接）写入 knock-plan.md。在聊天中询问接下来要规划或执行哪个阶段——除非用户提出要求，否则不要执行 Knock 写入操作。

规则文件参考

  • rules/inventory-existing-messaging.md — 在代码库中查找的内容
  • rules/map-concepts-to-knock.md — 平台概念 → Knock
  • rules/migration-plan.md — 分阶段计划的输出格式

快速参考

建议的资源迁移顺序（参见 Knock 的 Braze / Courier 教程）：

  1. 渠道 / 提供商连接
  2. 工作流和模板（逻辑 + 内容）
  3. 翻译
  4. 租户（以及多租户场景下的品牌上下文）
  5. 用户 / 识别
  6. 订阅（列表 → 对象订阅）
  7. 偏好设置（用户创建后；将主题/分组映射到工作流类别）
  8. 切换应用代码中的触发器
  9. 停用旧的发送流程

评论

支持 Markdown