zoho-crm について
Zoho CRM 向けのスキルで、適切な実装手段を選び、資料を参照してソリューションを作成・検証します。CRM API、サーバー側関数、UI カスタマイズ、クエリ、OAuth 接続に対応します。
主な機能
- 01CRM の実装手段をタスクに応じて選択
- 02DOU ノードとドキュメントを参照
- 03REST API と COQL のワークフローに対応
- 04Deluge 関数と UI カスタマイズを網羅
- 05作成したソリューションを検証
活用シーン
- 01API 経由で CRM レコードを読み書き
- 02サーバー側の Deluge 自動化を構築
- 03CRM ページや埋め込み UI をカスタマイズ
- 04CRM データのクエリや OAuth サービスへの接続
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ zoho/ crm-skills --skill zoho-crmインストール後、Claude Code で/zoho-crmを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
assets/.gitkeepassets/api/extract_schema.pyassets/clientscript/clientscript-best-practices.dou.mdclientscript-commands.dou.mdclientscript-creation.dou.mdclientscript-event-type-matrix.dou.mdclientscript-events.dou.mdclientscript-faqs.dou.mdclientscript-healthcare.dou.mdassets/clientscript/client-apis/blueprinttransition.dou.mdbutton.dou.mdclient-util.dou.mdclient.dou.mdcomponent.dou.mdcrm.dou.mdfield.dou.mdflyout.dou.mdform.dou.mdhttp.dou.mdlink.dou.mdlist.dou.mdpage-util.dou.mdpage.dou.mdresponse.dou.mdsubform.dou.mdsubformcell.dou.mdsubformfield.dou.mdsubformrow.dou.mdui.dou.mduielement.dou.md詳細
zoho-crm
目的
どのようなユースケースでも、このスキルは次の処理を行います。
- 適切なプリミティブを選択し、関連する DOU ノード/リファレンスドキュメントを読み込みます
- ソリューションを作成し(MCP ツールに接続されている場合はそれを使用し、そうでない場合は正確なペイロードを提示します)、出力を検証します
使用するタイミング
| ユースケース | サブスキル |
|---|---|
| HTTP 経由で CRM レコードを読み取り、作成、更新、削除する | API |
| サーバーサイドの自動化/カスタム関数を作成する | Functions / Deluge |
| レコードページ/リストビューに UI ロジックを追加する | ClientScript |
| 埋め込み UI コンポーネントを作成する | Widgets |
| Canvas ビュー、Kiosk、または Custom Related List に紐づく保存済みクエリを作成する(Workbench で UI から作成) | Queries |
| COQL(CRM Object Query Language)を使用して CRM データをクエリする | COQL |
| OAuth 経由で外部サービスに接続する | Connections |
ステップごとの推論フロー
ステップ 1 — 目標を把握する
| 項目 | 抽出する内容 | 例 |
|---|---|---|
| アクション | 何を実行するか? | 取得、作成、更新、トリガー、表示、クエリ |
| エンティティ | どの CRM モジュールまたはオブジェクトか? | Leads、Contacts、Deals、カスタムモジュール |
| コンテキスト | どこで実行するか? | サーバーサイド、UI ページ、スケジュール実行、イベントトリガー |
ゲート:上記の項目のいずれかを、妥当な単一の解釈から明確に判断できない場合は、ステップ 2 に進む前に停止して質問してください。必要なことだけを尋ね、明確なデフォルト値がある任意のパラメーターは省略してください。
ステップ 2 — 適切なプリミティブを選択する
以下の判断マトリクスを主な振り分け基準として使用します。ユースケースがどの行にも該当しない場合は、レイヤールールを適用します。サーバーサイド(ブラウザーへのアクセスが不要)→ Function / REST API / COQL / Queries、ブラウザーサイド → Widget / Client Script。
判断マトリクス — ニーズ → 使用するもの
サーバー側
| ニーズ | 使用するもの |
|---|---|
| CRM で Deluge バックエンドコードを実行する — レコードの処理、CRUD 操作の実行、Zoho CRM API の呼び出し、メール/SMS の送信、またはサーバー側のビジネスロジックの実行 | Function — Workflow Rule、Blueprint、Schedule、Button、Validation Rule、または Serverless Endpoint を介してトリガー |
| 外部(Zoho 以外)の API を呼び出し、その結果を CRM に書き込む | Workflow Rule または Button を介した Function(認証には名前付き Connection を使用) |
| カスタム Deluge ロジックを外部システム向けの REST API として公開する | Serverless Endpoint を介した Function |
| CRM 内で cron ジョブを実行する | Scheduled Function を介した Function |
| Custom Related List を Function に変換する | related_list.* カテゴリーの Function — レコード詳細ページにデータを直接表示する唯一のカテゴリーです。別のトリガータイプ(ボタン、ワークフロー、API エンドポイント)が明示されていない限り、確認を求めないでください |
| 外部システムまたはスクリプトから CRM レコードを読み取り/作成/更新/削除する、または CRM 固有の操作を実行する | REST API |
| Deluge、外部 API 呼び出し元、またはアドホックコードからプログラムで CRM データを取得する | COQL |
| Canvas、Kiosk、または Custom Related List にクエリ駆動型データを表示する | Queries(Workbench UI で作成 — Setup → Developer Hub → Queries) |
| Function または ClientScript から外部 OAuth サービスに認証する | Connections(Setup → Developer Hub → Connections で作成し、invokeurl または ZDK.Apps.CRM.Connection.invoke でリンク名を参照) |
ブラウザー側
| ニーズ | 使用するもの |
|---|---|
| CRM 内にカスタム HTML またはサードパーティ製 UI コンポーネントを表示または埋め込む | Widget |
| 別のフィールドの値に応じてフィールドを非表示にする、またはレコードページのその他の Web UI をカスタマイズする | Client Script |
| CRM の Web UI でレコードを保存する前にフィールド入力を検証する | Client Script(即時の UI フィードバック)または Validation Rule を介した Function(サーバー側での適用) — ユーザーがサーバー側での適用を明示的に要求しない限り、Client Script を優先します |
| Web UI でボタン操作の前に確認ダイアログを表示する | Client Script(ダイアログ)+ Function(バックエンド操作) |
判断に迷った場合:最初に記載された選択肢をデフォルトとし、ユーザーのコンテキストが2番目の選択肢を明示的に支持する場合にのみ変更します。
確認:選択したプリミティブが、ステップ1のアクション+エンティティ+コンテキストに一致することを確認します。一致しない場合は、マトリクスを再確認するか、確認の手順に戻ってください。
共通制約:すべてのモジュールとフィールドの参照には API 名を使用し、表示ラベルは使用しないでください。
信頼できる情報源の優先順位
構文、シグネチャ、制限が不明な場合は、優先度や記憶ではなく、次の順に情報源を参照してください。
- DOU Nodes(
assets/) — 現在のメソッドシグネチャ、パラメーター、戻り値の型、重大な失敗条件。コード生成では、まずこちらを使用してください。 - Zoho 公式公開ドキュメント(zoho.com/deluge/help/、zoho.com/crm/api/) — DOU ノードの情報が不完全または存在しない場合。
- リファレンスファイル+インライン例(api.md、functions.md など) — 厳選された概要です。DOU または公式ドキュメントより古い場合があります。
- 記憶している知識 — 信頼度は最低です。必ず DOU と照合してください。
重要なルール:リファレンスファイルは厳選された概要であり、信頼できる一次情報ではありません。DOU ノードとリファレンスファイルの例が食い違う場合は、DOU ノードを優先してください。
ステップ3 — 選択したプリミティブのリファレンスを読み込む
上記の「使用する場面」表で一致したプリミティブのリファレンスファイルを開き、その実行手順に従ってください。(特別なケース:プリミティブが COQL をソースタイプとする Queries の場合は、references/coql.md も開いてください。)
リファレンスファイルにアクセスできない場合は、ユーザーにその旨を伝え、不足しているファイルを示し、その内容に依存するコードを生成しないでください。
ステップ 4~5 — 実行と検証
ステップ 3 の参照ファイルにある実行手順に従います。解決策を提示した後、検証チェックリストを実行します。エラーがあれば平易な言葉で説明し、目標が部分的にしか達成されていない場合は、次の手順を提案します。
認証とスコープの参照
スコープは常に OAS 仕様ファイルから導出してください(api.md のステップ 6、操作レベルの security フィールド)。標準的なスコープはすべて OAS 仕様を使用してください。以下の表では、分かりにくいケースのみを取り上げています。
| スコープ | 注記 |
|---|---|
ZohoCRM.coql.READ と ZohoCRM.modules.{module}.READ | COQL クエリには別々のスコープが 2 つ必要です。coql.READ のみの場合は → OAUTH_SCOPE_MISMATCH |
ベース URL:https://www.zohoapis.com/crm/v8/