mcpField
E
external-diagram-mermaid-generate

external-diagram-mermaid-generate

github.com/forcedotcom開発1.1k5.5k 回インストール1 日前に更新
リポジトリ

external-diagram-mermaid-generate について

Markdown に使える Mermaid 図を生成する Salesforce ユーザー向けのスキルです。必要に応じて ASCII 版も作成し、アーキテクチャ、OAuth、連携フロー、ERD、Agentforce の図をテンプレートと規約に沿って扱います。

主な機能

  1. 01複数種類の Mermaid 図を生成
  2. 02必要に応じた ASCII 版の作成
  3. 03Salesforce オブジェクトやフローのテンプレート利用
  4. 04図の種類に応じた構成とラベル付け
  5. 05関係、方向、前提の説明

活用シーン

  1. 01OAuth 認可シーケンスの図示
  2. 02システム構成と連携フローの表示
  3. 03Salesforce データモデルの ERD 作成
  4. 04Agentforce の動作と関係の整理

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/forcedotcom/sf-skills --skill external-diagram-mermaid-generate

インストール後、Claude Code で/external-diagram-mermaid-generateを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

README.md
assets/agentforce/
agent-flow.md
assets/architecture/
system-landscape.md
assets/datamodel/
b2b-commerce-erd.md
campaigns-erd.md
consent-erd.md
files-erd.md
forecasting-erd.md
fsl-erd.md
party-model-erd.md
quote-order-erd.md
revenue-cloud-erd.md
sales-cloud-erd.md
salesforce-erd.md
scheduler-erd.md
service-cloud-erd.md
territory-management-erd.md
assets/integration/
api-sequence.md
assets/oauth/
authorization-code-pkce.md
authorization-code.md
client-credentials.md
device-authorization.md
jwt-bearer.md
refresh-token.md
user-agent-social-sign-on.md
assets/role-hierarchy/
user-hierarchy.md
references/
color-palette.md
diagram-conventions.md
erd-conventions.md
mermaid-reference.md

詳細

external-diagram-mermaid-generate:Salesforce 図の生成

ユーザーがテキストベースの図を必要としている場合に、このスキルを使用します。アーキテクチャ、OAuth、統合フロー、ERD、Agentforce の構造を示す Mermaid 図に加え、プレーンテキストとの互換性が重要な場合は ASCII の代替図も提供します。

対象範囲

対象

ユーザーが以下を求めている場合は、external-diagram-mermaid-generate を使用します。

  • Mermaid の出力
  • ASCII の代替図
  • Markdown で扱いやすい形式のアーキテクチャ、シーケンス図、フローチャート、ERD
  • ドキュメント、README、課題にそのまま掲載できる図
対象外 — 次のような要望は別のスキルに委ねます。

対応する図の種類

種類Mermaid の推奨形式典型的な用途
OAuth/認証フローsequenceDiagramAuthorization Code、JWT、PKCE、Device Flow
ERD/データモデルflowchart LRオブジェクトの関係と共有コンテキスト
統合シーケンスsequenceDiagramリクエスト/レスポンスまたはイベントの連携
システム全体像flowchart高レベルのアーキテクチャ
ロール/アクセス階層flowchartユーザー、プロファイル、権限
Agentforce の動作マップflowchartエージェント → トピック → アクションの関係

事前に確認する必須コンテキスト

次の情報を尋ねるか、推測します。

  • 図の種類
  • 対象範囲と関係するエンティティ/システム
  • 出力形式の希望:Mermaid のみ、ASCII のみ、または両方
  • スタイルの希望:最小限、ドキュメント重視、またはプレゼンテーション向け
  • ERD の場合:根拠として使用できる組織のメタデータがあるか

推奨ワークフロー

1. 適切な図の構成を選ぶ
  • 時系列のやり取りには sequenceDiagram を使用します
  • ERD や機能マップには flowchart LR を使用します
  • 可能であれば、図ごとに主要なストーリーを1つに絞ります
2. データを収集する

ERD および根拠に基づく図の場合:

3. まず Mermaid を生成する

次の点に留意します。

  • 正確なラベル
  • シンプルで読みやすいノードテキスト
  • 一貫した関係の表記
  • Markdown ビューアーで問題なく描画される、控えめなスタイル
4. 必要に応じて ASCII の代替図を追加する

ユーザーがターミナルとの互換性やプレーンテキストのドキュメントを求めている場合は、ASCII 版も提供します。

5. 図を簡潔に説明する

主要な関係、フローの方向、前提条件を説明します。


重要なルール

シーケンス図の場合
  • 手順の順序が重要な場合は autonumber を使用します
  • リクエストとレスポンスを明確に区別します
  • プロトコルの詳細を示す注記は必要最小限にします
ERD の場合
  • flowchart LR を優先します
  • オブジェクトカードはシンプルに保ちます
  • 関係を明確な矢印で示します
  • ユーザーがフィールド単位の詳細を明示的に求めていない限り、フィールドを詰め込みすぎないようにします
  • 読みやすさが向上する場合に限り、オブジェクトの種類ごとに色分けします
ASCII 出力の場合
  • 横幅を適切に保ちます
  • 矢印とボックスの位置を一貫して揃えます
  • 装飾よりも読みやすさを優先します

出力形式

## <Diagram Title>

### Mermaid Diagram
```mermaid
<diagram>
```

### ASCII Fallback
```text
<ascii>
```

### Notes
- <key point>
- <assumption or limitation>

スキル間の連携

必要なもの委任先理由
実際のオブジェクト/項目の定義platform-custom-object-generate / platform-custom-field-generate根拠に基づいた ERD の生成
接続アプリの認証設定に関するコンテキストintegration-connectivity-connected-app-configure正確な OAuth フロー
Agentforce のロジックの可視化agentforce-generate信頼できる情報源に基づく動作の詳細
Flow の動作図automation-flow-generate実際の Flow ロジックに基づく

注意点

問題解決策
Mermaid レンダラーが利用できないASCII の代替図を自動的に提供します。Mermaid ブロックには、レンダラーにコピーして貼り付けられる図が含まれていることも伝えてください
オブジェクトが多すぎて ERD が読みづらくなるドメイン(Sales、Service など)ごとにサブ図に分割し、本文中でリンクします
シーケンス図のステップ順が不明確autonumber ディレクティブを使って、ステップの順序を明示します
OAuth フローのアクターがグラントタイプによって異なるアクターの不一致を避けるため、生成前に該当するアセットテンプレートを確認します

参照ファイル一覧

規約とルール — 生成前に確認
スタイル
プレビュー
OAuth フローテンプレート — OAuth 図の生成時に該当するテンプレートを読み込みます
データモデル ERD テンプレート — ERD の生成時に該当するテンプレートを読み込んでください
その他の図のテンプレート

出力要件

このスキルで各リクエストに対して作成する成果物:

  • Mermaid コードブロック — GitHub、Confluence、または Mermaid 対応のレンダラーにそのまま貼り付けられるフェンス付きの ```mermaid ブロック
  • ASCII 形式の代替図(リクエストされた場合、または Mermaid レンダラーが利用できない場合)— ボックスや矢印の文字を使ったテキストのみの図
  • 簡潔な説明 — 図の主要な関係、フローの方向、前提条件や制限事項を示す箇条書き 2~5 項目
  • ERD の場合:フィールドラベルと関係タイプの注釈を含むオブジェクトカード
  • シーケンス図の場合:明確なアクターラベルと番号付きステップ(autonumber)

評価ガイド

スコア意味
72–80本番環境で使用できる図
60–71明確で有用だが、多少の調整が必要
48–59機能するが、さらに分かりやすくできる
35–47構造の改善が必要
< 35不正確または不完全

コメント