mcpField
K
knock-setup

knock-setup

github.com/knocklabs開発182 回インストール2 日前に更新
リポジトリ

knock-setup について

knock-setupは、コーディングエージェント向けにKnockのツール接続、通知ワークフローの検討、アプリへの実装を案内するセットアップスキルです。利用するツールに応じてMCPまたはKnock CLIの手順を選び、ワークフロー作成前に確認を求めます。

主な機能

  1. 01コーディングエージェント別のセットアップ
  2. 02MCPまたはCLIでKnockに接続
  3. 03ワークフローの検討と確認
  4. 04承認済みワークフローを下書き作成
  5. 05アプリへの実装を案内

活用シーン

  1. 01コーディングプロジェクトでKnockを設定
  2. 02通知ワークフローの計画と下書き作成
  3. 03対応エージェントに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

詳細

セットアップ

コーディングエージェント向けのKnockのエンドツーエンドセットアップです。ツールを接続し、通知ワークフローを設計・構築してから、アプリケーションに組み込みます。以下のルールに順番どおり従ってください。

作業中は、すべての応答を短い1行にしてください。要約、メニュー、追加の質問は、手順に失敗した場合を除いて行わないでください。例外は、冒頭の励ましとアカウントの確認(ステップ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がすでに設定されていること、以前のチャット、またはアカウントを持っているだろうという推測は該当しません。引き続き質問してください。最初のメッセージには、冒頭の励ましの言葉も必ず含めてください。
    • アカウントを持っていないと答えた場合:別途サインアップするためにダッシュボードへ案内しないでください。サインインの手順でアカウントを作成でき、サインアップ、オンボーディング、このチャットへの復帰まで、すべて1回のブラウザーフローで完了することを1行で伝えてから、Knockツールの接続に進んでください。
    • 質問は最終行に単独で太字にして記載してください。例:すでにKnockアカウントをお持ちですか?
  2. 現在のツールでKnockのツールを接続する(必須条件 — KnockのMCPツール呼び出し、またはCLI経由でのknock whoamiが成功するまで、ワークフローの検出、提案、作成を行わないでください)

    • まずツールのファミリーを判別し、そのうえで該当ルールの最初に記載された接続方法の確認(アプリかCLIか)に従ってください。この一覧だけを見て接続方法を選ばないでください。
      • 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拡張機能)を特定します。判断にシェルアクセスを使わないでください。アプリ内とCodex CLIではKnockプラグインを使用します。IDE拡張機能では停止します。スキルを個別にインストールしないでください。
      • その他のターミナル/CLIエージェント → 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)

    • トリガー方法を1つ選んでユーザーに確認し、ファイルを変更する前にknock-implementationブランチを作成します。
    • Knockデータソース(CDPまたはカスタムHTTP)の場合は、rules/implement-data-source.mdに従ってください。
  6. 仕上げる(rules/wrap-up.md)

    • 必ずテストを送信します。rules/wrap-up.mdのMCP経由またはKnock CLI経由の手順に従ってください(両方を混在させないでください)。共通の宛先ルール:whoamiのメールアドレスと名前を使用します。不足している場合に限り、登録時のメールアドレスを尋ねます。その後、次の手順とダッシュボードのリンクを案内し、Knockエージェントによるサポートを案内して締めくくります。
    • アプリ内通知の設定には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 の手順:CLI ベースのツール向けにインストールし、knock login で認証します
  • 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 エージェントによるサポート
  • 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 コマンド)を優先して使います

コメント