sf-metadata について
sf-metadata は、オブジェクト、項目、入力規則、レイアウト、権限セットなどの Salesforce メタデータ生成と組織メタデータ照会を支援するスキルです。スキーマ確認に加え、項目レベルセキュリティとデプロイ依存関係も計画します。
主な機能
- 01メタデータ XML の生成
- 02sf CLI による組織メタデータ照会
- 03スキーマと項目タイプの確認
- 04権限セットと項目レベルセキュリティの計画
- 05命名規則とデプロイ依存関係の確認
活用シーン
- 01要件に基づくオブジェクトや項目メタデータの作成
- 02コーディングや Flow 作成前のスキーマ確認
- 03入力規則、レイアウト、レコードタイプの生成
- 04カスタム項目向け権限セット設定の追加
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ jaganpro/ sf-skills --skill sf-metadataインストール後、Claude Code で/sf-metadataを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
CREDITS.mdREADME.mdassets/fields/checkbox-field.xmlcurrency-field.xmldate-field.xmlemail-field.xmlformula-field.xmllookup-field.xmlmaster-detail-field.xmlmulti-select-picklist.xmlnumber-field.xmlphone-field.xmlpicklist-field.xmlrollup-summary-field.xmltext-field.xmltextarea-field.xmlurl-field.xmlassets/layouts/page-layout.xmlassets/objects/custom-object.xmlassets/permission-sets/permission-set.xmlassets/profiles/profile.xmlassets/record-types/record-type.xmlassets/validation-rules/validation-rule.xmlhooks/scripts/generate_permission_set.pyrun_validation.shvalidate_metadata.pyreferences/best-practices-scoring.mdcustom-object-example.mdfield-and-cli-reference.mdfield-types-example.md詳細
sf-metadata:Salesforce メタデータの生成と組織のクエリ
ユーザーがメタデータの定義や組織のメタデータの確認を必要とする場合に、このスキルを使用します。対象には、カスタムオブジェクト、項目、入力規則、レコードタイプ、ページレイアウト、権限セット、または sf CLI を使ったスキーマの調査が含まれます。
このスキルが担当するタスク
次の作業には sf-metadata を使用します。
- オブジェクト、項目、入力規則、レコードタイプ、レイアウト、プロファイル、または権限セットのメタデータ
.object-meta.xml、.field-meta.xml、.profile-meta.xmlなどの関連メタデータファイル- コーディングや Flow の作業前のスキーマの確認
- 要件に基づくメタデータ XML の生成
次の場合は、別のスキルに委任します。
- メタデータを定義するのではなく、権限アクセスを分析する場合 → sf-permissions
- メタデータをデプロイする場合 → sf-deploy
- Flow XML を編集する場合 → sf-flow
最初に確認する必須コンテキスト
次の点を質問するか、推測します。
- ユーザーが生成とクエリのどちらを希望しているか
- 対象となるメタデータの種類
- 対象のオブジェクト、項目、またはパッケージディレクトリ
- クエリが必要な場合は対象組織のエイリアス
- 新しいカスタムオブジェクトや項目について、権限セット/FLS の生成も必要か
ユーザーが明示的に不要と指定しない限り、新しいカスタムオブジェクトや項目には権限セットの追加対応が必要だと想定します。
推奨ワークフロー
1. モードを選択する
| モード | 使用する状況 |
|---|---|
| 生成 | ユーザーが新規または更新されたメタデータ XML を必要としている |
| クエリ | ユーザーがオブジェクト、項目、またはメタデータの確認を必要としている |
2. テンプレートまたは CLI の describe データから始める
生成する場合は、次のアセットを使用します。
assets/objects/assets/fields/assets/permission-sets/assets/profiles/assets/record-types/assets/validation-rules/assets/layouts/
クエリする場合は、sf のメタデータコマンドおよび sobject describe コマンドを優先します。
古い例を読む際に知っておくとよい、最近の SDR/CLI のサポート状況:CnfgItemSourceDefinition、ExtlClntAppOauthSecuritySettings、UIBundle は、現在の名称でソースに対応するようになりました。references/metadata-types-reference.md を参照してください。
3. メタデータの品質を検証する
次の点を確認します。
- 命名規則
- 構造上の正しさ
- 項目タイプの適合性
- セキュリティ/FLS への影響
- 後続のデプロイにおける依存関係
4. 権限への影響を標準で計画する
新しいカスタム項目やオブジェクトを作成する場合:
- ユーザーが不要と指定しない限り、権限セットを生成または更新します
- 対象となるカスタム項目の
fieldPermissionsを含めます - Salesforce がシステム管理または常時使用可能として扱うために除外されるメタデータカテゴリがあれば記載します
- オブジェクトの CRUD 権限だけでは、カスタム項目が表示されないことに留意します
5. デプロイを引き継ぐ
ユーザーがメタデータのリリースを必要とする場合は、sf-deploy を使用します。
特に重要なルール
- デプロイ後に見つかる、見落とされがちな障害要因は項目レベルのセキュリティです
- オブジェクト権限 ≠ 項目権限
- プロファイル中心のアクセスパターンより、権限セットを優先します
- 新しいカスタムオブジェクトや項目には、標準で権限セットの追加対応を行います
- FLS を手作業の後回しにせず、対象となるカスタム項目の
fieldPermissionsを含めます - 数式やメタデータのロジックにハードコードされた ID を使用しないでください
- 運用上必要な場合、入力規則には意図的なバイパス方法を設けます
- Flow やデータのタスクが依存するメタデータは、先に作成します
出力形式
完了時には、次の順序で報告します。
- 作成またはクエリしたメタデータ
- 作成または更新したファイル
- 主なスキーマ/セキュリティ上の判断
- 権限/レイアウトに関する追加対応
- 次のデプロイ手順
推奨形式:
Metadata task: <generate / query>
Items: <objects, fields, rules, layouts, permsets>
Files: <paths>
Notes: <naming, field types, security, dependencies>
Next step: <deploy, assign permset, or verify in Setup>
スキル間の連携
| 必要な作業 | 委任先 | 理由 |
|---|---|---|
| メタデータのデプロイ | sf-deploy | ロールアウトと検証 |
| 新しいスキーマでの Flow の構築 | sf-flow | 宣言型の自動化 |
| 新しいスキーマでの Apex の構築 | sf-apex | メタデータに基づくコード |
| 作成後のアクセス権限の分析 | sf-permissions | アクセス権限の監査 |
| デプロイ後のデータ投入 | sf-data | テストデータの作成 |
リファレンスマップ
まずはこちら
- references/field-and-cli-reference.md
- references/metadata-types-reference.md
- references/naming-conventions.md
- references/orchestration.md
セキュリティ/スコアリング/例
- references/fls-best-practices.md
- references/permset-auto-generation.md
- references/best-practices-scoring.md
- references/field-types-guide.md
- references/field-types-example.md
- references/custom-object-example.md
- references/permission-set-example.md
- references/profile-permission-guide.md
- references/sf-cli-commands.md
- assets/
スコアガイド
| スコア | 意味 |
|---|---|
| 108+ | 本番環境に対応できる優れたメタデータ |
| 96–107 | 軽微な確認事項のある良好なメタデータ |
| 84–95 | 許容範囲ですが、慎重に検証してください |
| < 84 | 修正が完了するまでデプロイをブロックしてください |