mcpField
K
knock-setup

knock-setup

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

关于 knock-setup

knock-setup 是面向编码 Agent 的设置技能,可连接 Knock 工具、探索通知工作流并指导将其接入应用。它根据所用工具选择 MCP 或 Knock CLI 流程,且工作流创建需经确认。

主要功能

  1. 01按编码 Agent 工具选择设置流程
  2. 02通过 MCP 或 CLI 连接 Knock
  3. 03探索并确认工作流
  4. 04将确认的工作流创建为草稿
  5. 05指导在应用中实现集成

适用场景

  1. 01为编码项目设置 Knock
  2. 02规划并起草通知工作流
  3. 03为受支持的 Agent 连接 Knock 工具

MCP 相关

使用 MCP 的流程会连接 Knock MCP 服务 https://mcp.knock.app/mcp,并通过 MCP 工具探索和创建工作流。CLI 流程改用 Knock CLI 命令,不配置 MCP。

安装

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

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

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

包含的文件

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

rules/
build-workflows.md
connect-claude.md
connect-codex.md
connect-cursor.md
connect-grok-bot.md
connect-knock-cli.md
discover-workflows.md
implement-data-source.md
import-users.md
recommend-implementation.md
wrap-up.md

详细介绍

设置

为编码 Agent 完成端到端的 Knock 设置:连接工具、设计并构建通知工作流,然后将它们接入应用程序。请按顺序遵循以下规则。

工作期间,每条回复都保持为一行简短文字——不要总结,不要提供菜单,除非某个步骤失败,否则不要多问。仅以下情况例外:开场鼓励语和账号询问(步骤 1)、工作流方案、确认前的重述(最多 2–3 行)、实现确认询问、导入用户 ID 询问、收尾时的注册邮箱询问(仅当 whoami 没有邮箱时)、最终收尾输出、ChatGPT 和 Codex 应用内插件的介绍、Codex CLI /plugins 路径,以及 rules/connect-codex.md 中的新会话交接;还有 rules/connect-claude.md 中的 Claude 连接器说明(目录链接 + 已连接询问),这些情况有各自的格式。当你以确认问题结束时(账号、工作流、实现、导入用户 ID、收尾注册邮箱或收尾指南询问),该问题必须是消息的最后一行,单独成行并加粗。

如何使用此技能

Grok Bot: 如果这是 Grok Bot(桌面端/iOS 队友、Agent Computer 或 /workspace),请在此处停止,并改为遵循 rules/connect-grok-bot.md,不要执行以下步骤。

  1. 先表达鼓励,再确认 Knock 账号(必需的第一步操作——先做这一步,再做其他任何事)

    • ChatGPT 和 Codex(应用内或 Codex CLI): 跳过整个步骤。不要询问 Knock 账号。不要安装技能。转到步骤 2,并遵循 rules/connect-codex.md。插件登录涵盖注册。Codex IDE 扩展不受支持——该规则会终止流程。
    • 开场白(仅限第一条消息)。 询问账号之前,先说几句简短的鼓励话(约 2–3 句):他们将使用 Knock 节省大量构建通知的时间,做出了明智的选择,而我们会尽最大努力,帮助他们尽快完成设置。语气温暖朴实——不要推销功能,也不要列出后续步骤菜单。
    • 默认:始终询问。 第一条消息随后必须询问他们是否有 Knock 账号。在他们回答之前,不要添加 MCP、运行 OAuth、安装技能、发现工作流或调用 Knock 工具。
    • 仅在以下情况下跳过询问: 用户的消息明确说明他们从 Knock 控制面板开始(例如,粘贴了控制面板设置提示,或说“从 Knock 控制面板开始”)。MCP 已配置、之前聊过,或猜测他们可能有账号,都不算——仍须询问。第一条消息仍须包含开场鼓励。
    • 如果他们说没有:不要让他们单独前往控制面板注册。用一行告诉他们将在登录步骤中创建账号——注册、入门引导和返回此处都将在同一个浏览器流程中完成——然后继续连接 Knock 工具。
    • 将询问作为最后一行,并加粗,例如:你已经有 Knock 账号了吗?
  2. 连接当前工具的 Knock 工具链(硬性门槛——在 Knock MCP 工具调用成功,或在命令行路径上 knock whoami 成功之前,不得发现、提议或构建工作流)

    • 先按工具系列路由,再遵循对应规则顶部的界面检查(应用还是命令行)——不得仅根据此列表选择路径:
      • Cursor(编辑器或 Cursor CLI)→ rules/connect-cursor.md——编辑器使用 MCP;Cursor CLI 路由到 rules/connect-knock-cli.md
      • Claude(应用或 Claude Code)→ rules/connect-claude.md——应用需从连接器目录添加 Knock(向用户提供目录链接并等待);Claude Code 路由到 rules/connect-knock-cli.md
      • ChatGPT 或 Codex → rules/connect-codex.md——确定宿主界面(应用内、Codex CLI 或 IDE 扩展)。不得通过 shell 访问来判断。应用内和 Codex CLI 使用 Knock 插件;IDE 扩展则停止。不得单独安装技能。
      • 任何其他终端/CLI Agent → rules/connect-knock-cli.md——安装 Knock CLI,并使用 knock login 进行身份验证
    • 如果工具未知,询问用户使用的是哪种工具,然后遵循对应规则。
    • 在 Knock CLI 路径上,此技能的任何阶段都不得设置 MCP——不得使用 claude mcp add、codex mcp add,不得编辑 mcp.json,也不得请求添加连接器。后续步骤提到 Knock MCP 工具时,使用对应的 knock CLI 命令。
    • 身份验证证明:调用 list_environments 或 execute_mapi_read GET /v1/whoami(MCP),或运行 knock whoami(CLI),并等待成功。仅检查 MCP 或 CLI 是否已安装并不足够。
  3. 发现工作流(rules/discover-workflows.md)——仅在步骤 2 的身份验证得到证明后进行

    • 如果本次对话已通过 knock-lifecycle-opportunities 或 knock-product-messaging-strategy 获得经批准的构建清单,则跳过重新发现(参见该规则中的先前确认门槛)。
    • 否则,了解产品,提出高价值工作流,并确认要构建哪些工作流。
  4. 构建工作流(rules/build-workflows.md)

    • 通过 MCP 在账户的默认环境中将已确认的工作流创建为草稿。新账户的默认环境为生产环境;不要发布这些工作流。
  5. 推荐实现方案(rules/recommend-implementation.md)

    • 选择一条触发路径,请用户确认,然后在修改文件前创建分支 knock-implementation。
    • 对于 Knock Data Source(CDP 或自定义 HTTP),遵循 rules/implement-data-source.md。
  6. 收尾(rules/wrap-up.md)

    • 始终发送测试。遵循 rules/wrap-up.md 中的 MCP 路径或 Knock CLI 路径(不得混用)。收件人规则通用:使用 whoami 中的电子邮件地址和姓名;仅在缺少电子邮件地址时询问注册邮箱。然后提供后续步骤和控制面板链接,并以 Knock Agent 帮助信息收尾。
    • 始终提及通过 knock-in-app-ui 设置应用内通知。如果创建或提及了指南,请说明指南需要接入应用,然后在启动 knock-in-app-ui 前征求用户同意(用户同意前不得继续)。

扩展规则(不适用于首次流程)

在准备上线或用户提出要求时使用这些规则——在主要流程结束后,它们为可选项:

  • 导入用户(rules/import-users.md)——选择稳定的 Knock 用户 ID,研究用户的存储方式,设置 KNOCK_API_KEY,并编写先执行试运行的批量识别脚本。除非用户明确要求,否则不要针对生产环境运行。

规则文件参考

  • rules/connect-cursor.md — Cursor:先检查界面支持情况,再安装编辑器 MCP 和技能(Cursor CLI 转到 connect-knock-cli.md)
  • rules/connect-claude.md — Claude:先检查界面支持情况,再使用应用目录连接器(Claude Code 转到 connect-knock-cli.md)
  • rules/connect-codex.md — ChatGPT 和 Codex:先检查宿主界面支持情况,再使用应用内插件或 Codex CLI /plugins
  • rules/connect-grok-bot.md — Grok Bot 备用方案:介绍、连接 MCP,然后转到相应路径
  • rules/connect-knock-cli.md — 通用 Knock CLI 路径:安装并使用 knock login 为基于 CLI 的工具进行身份验证
  • rules/discover-workflows.md — 产品探索和工作流方案
  • rules/build-workflows.md — 使用 Knock MCP 构建已确认的工作流
  • rules/recommend-implementation.md — 选择触发路径,确认后分支,然后实施
  • rules/implement-data-source.md — 配置数据源:识别用户、设置映射、使用 MCP 提示词并测试
  • rules/wrap-up.md — 测试发送(区分 MCP 和 Knock CLI 路径)及后续步骤、控制面板链接和 Knock Agent 帮助
  • rules/import-users.md — 扩展:批量识别用户,为正式环境做好准备

快速参考

  • MCP 服务 URL:https://mcp.knock.app/mcp
  • ChatGPT / Codex 插件:https://chatgpt.com/plugins/plugin_asdk_app_6a8dddd50424819196928510eff4c70f
  • Knock CLI:使用 npm install -g @knocklabs/cli 安装,使用 knock login 进行身份验证(文档)
  • 安装开源技能:npx skills add knocklabs/skills
  • 工具连接后,创建工作流、步骤和模板时,优先使用 Knock MCP 工具(CLI 路径则使用 Knock CLI 命令)

评论

支持 Markdown