platform-agentsetup-categories-fetch について
接続済み Salesforce 組織の Agentic Setup Categories Connect API からプロンプトカテゴリを取得するスキルです。必要に応じてカテゴリ内のプロンプトも取得して表示します。この API は読み取り専用です。
主な機能
- 01プロンプトカテゴリの取得
- 02必要に応じた入れ子のプロンプト取得
- 03カテゴリ名とラベルの表示
- 04API・認証エラーへの対応
活用シーン
- 01接続済み組織のプロンプトカテゴリ確認
- 02カテゴリ内のプロンプトの確認
- 03プロンプトのないカテゴリの特定
- 04機能設定やセッションエラーの調査
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ forcedotcom/ sf-skills --skill platform-agentsetup-categories-fetchインストール後、Claude Code で/platform-agentsetup-categories-fetchを入力して読み込まれたか確認します。
同梱ファイルreferences/api-response-schema.md
詳細
platform-agentsetup-categories-fetch
接続済みの Salesforce 組織から、Agentic Setup Categories Connect API を使ってプロンプトカテゴリを取得します。
範囲
対象範囲:
- SF CLI を使った
GET /services/data/{apiVersion}/agenticsetup/categoriesの呼び出し - ネストされたプロンプトを含めるための
fetchPromptsクエリパラメーターの指定 - JSON レスポンス(カテゴリ、ラベル、プロンプト)の解析と表示
- エラー(機能が無効な場合の 403、認証エラー)の処理
対象範囲外 — 別の手段を使用してください:
- プロンプトカテゴリの作成または変更 → この API ではサポートされていません(読み取り専用)
- 組織の認証設定 → 別途
sf org loginを使用してください - 権限セットの割り当て → assigning-permission-set
必須入力
エージェントには次が必要です:
- 接続済みの組織(
sf org loginで認証済み) - 省略可能:ネストされたプロンプトを含めるかどうか(
fetchPrompts=true) - 省略可能:対象 API バージョン(デフォルト:v67.0)。ユーザーがバージョンを指定した場合は、URL の
v67.0を指定されたバージョンに置き換えてください。
ワークフロー
1. 組織の接続を確認する
sf org display --json
組織が認証済みであることを確認し、インスタンス URL を取得します。デフォルトの組織が設定されていない場合は、--target-org で対象にする組織をユーザーに確認してください。
2. Categories API を呼び出す
基本の呼び出し(カテゴリのみ):
sf api request rest /services/data/v67.0/agenticsetup/categories --method GET
ネストされたプロンプトを含める場合:
sf api request rest "/services/data/v67.0/agenticsetup/categories?fetchPrompts=true" --method GET
3. レスポンスを解析して表示する
API は categories 配列を含む JSON オブジェクトを返します。各カテゴリには name、label、prompts フィールドがあります。完全なレスポンス構造と、fetchPrompts=true および fetchPrompts=false の両方の例については、references/api-response-schema.md を参照してください。
結果は分かりやすく表示してください:
- カテゴリの名前とラベルを一覧表示する
fetchPrompts=trueを使用した場合は、各カテゴリの下にネストされたプロンプトを表示するprompts配列が空のカテゴリがあれば、その旨を示す(そのカテゴリにプロンプトが存在しないことを意味します)
4. エラーを処理する
| エラー | 意味 | 対応 |
|---|---|---|
| 成功(終了コード 0) | 200 OK | 結果を解析して表示する |
FUNCTIONALITY_NOT_ENABLED | この組織またはユーザーで機能が有効になっていません | Agentic Setup Categories 機能を有効にする必要があることをユーザーに伝え、設定 > Einstein/Agentforce を確認するよう案内する |
INVALID_SESSION_ID | セッションの有効期限が切れています | sf org login で再認証する |
NOT_FOUND | エンドポイントが見つかりません | API バージョンが古すぎるか、この組織に機能がデプロイされていません |
ルール/制約
| ルール | 理由 |
|---|---|
必ず sf api request rest を使用し、curl や生の HTTP は使わない | curl は ~/.sfdx のセッショントークンを迂回し、Authorization ヘッダーを手動で指定する必要があるため、動作が不安定になります |
| SOQL クエリは絶対に使用しない | カテゴリは標準オブジェクトに含まれておらず、この Connect REST API からのみ取得できます |
| ファイル(LWC、Apex、XML)は絶対に生成しない | これはコード生成ではなく、データ取得のタスクです |
| ユーザーが指定しない限り v67.0 をデフォルトにする | このエンドポイントが導入された最小バージョンです |
| 指示がない限り fetchPrompts を指定しない | ペイロードサイズを抑えられます。プロンプトは大きくなる場合があります |
| カテゴリはラベル順に並んでいます | API はアルファベット順で返すため、並べ替えないでください |
| プロンプトはテキスト順に並んでいます | 各カテゴリ内では、プロンプトがアルファベット順に並びます |
出力の要件
完了時には次を提示してください:
- 返されたカテゴリ数
- カテゴリ一覧 — 各カテゴリの名前とラベル
- プロンプト(要求された場合)— 対応するカテゴリの下に表示
- 発生したエラーと推奨される修正方法
参考ファイル一覧
| ファイル | 参照するタイミング |
|---|---|
references/api-response-schema.md | 完全なレスポンス構造と各フィールドの説明を確認する必要がある場合 |
コメント
Markdown 対応