SkillsAdd

forcedotcom/sf-skills

external-diagram-mermaid-generate

Salesforce architecture diagrams using Mermaid with ASCII fallback.

All-time #2722 Trending #6695 First seen Jun 26, 2026
8-week activity · all time api

Installation

$ npx skills add forcedotcom/sf-skills --skill external-diagram-mermaid-generate
View on skills.sh ↗ GitHub repository ↗

Summary

  • Salesforce architecture diagrams using Mermaid with ASCII fallback.
  • Use this skill when generating text-based diagrams for Salesforce architecture, OAuth flows, ERDs, integration sequences, or Agentforce structure.
  • TRIGGER when: user says \"diagram\", \"visualize\", \"ERD\", or asks for sequence diagrams, flowcharts, class diagrams, or architecture visualizations in Mermaid.
  • DO NOT TRIGGER when: user asks about non-Salesforce systems.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

find-skills Same topic
vercel-labs/skills

Helps users discover and install agent skills when they ask questions like "how do I do X", "fi…

3.3M installs
agent-browser Same topic
vercel-labs/agent-browser

Browser automation CLI for AI agents. Use when the user needs to interact with websites, includ…

810.4K installs
vercel-react-best-practices Same topic
vercel-labs/agent-skills 697.8K installs
web-design-guidelines Same topic
vercel-labs/agent-skills

Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "chec…

617.3K installs
microsoft-foundry Same topic
microsoft/azure-skills

Build, deploy, evaluate, optimize, fine-tune, and manage Microsoft Foundry agents, models, and …

576.5K installs
azure-prepare Same topic
microsoft/azure-skills

Prepare azd-based Azure projects for deployment: generates azure.yaml, infrastructure (Bicep/Te…

568.3K installs

Also in this package

Other skills from forcedotcom/sf-skills · top by installs.

npx skills add forcedotcom/sf-skills
platform-apex-generate 6.1K platform-apex-test-generate 6K platform-apex-logs-debug 6K platform-apex-test-run 5.9K platform-docs-get 5.9K platform-custom-field-generate 5.8K platform-metadata-deploy 5.8K platform-soql-query 5.8K platform-metadata-retrieve 5.7K automation-flow-generate 5.6K

Browse all from forcedotcom/sf-skills

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 972
License LICENSE.txt
Default branch main
Open issues 15
Status Active

Skill metadata

Parsed from SKILL.md frontmatter.

Version1.0
More metadata
cliTools
{"0":"tool: [\"curl\"]","semver":">=2.0.0","1":"tool: [\"jq\"]","2":"tool: [\"python\"]","3":"tool: [\"python3\"]","4":"tool: [\"sf\"]"}
relatedSkills
["agentforce-generate","automation-flow-generate","integration-connectivity-connected-app-configure","integration-connectivity-generate","platform-apex-generate","platform-custom-field-generate","platform-custom-object-generate","platform-data-manage","platform-metadata-deploy"]
version
1.0
domains
["External"]

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 10,940 B
  • docs README.md 4,237 B
  • docs SUMMARY.md 479 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 5,100 installs

SKILL.md

external-diagram-mermaid-generate: Salesforce Diagram Generation

Use this skill when the user needs text-based diagrams: Mermaid diagrams for architecture, OAuth, integration flows, ERDs, or Agentforce structure, plus ASCII fallback when plain-text compatibility matters.

Scope

In Scope

Use external-diagram-mermaid-generate when the user wants:

  • Mermaid output
  • ASCII fallback diagrams
  • architecture, sequence, flowchart, or ERD views in markdown-friendly form
  • diagrams that can live directly in docs, READMEs, or issues

Out of Scope — Delegate elsewhere when the user wants:

  • non-Salesforce systems only → use a more general diagramming skill
  • object discovery before an ERD → [platform-custom-object-generate](../platform-custom-object-generate/SKILL.md) or [platform-custom-field-generate](../platform-custom-field-generate/SKILL.md)

Supported Diagram Families

Type Preferred Mermaid form Typical use
OAuth / auth flows sequenceDiagram Authorization Code, JWT, PKCE, Device Flow
ERD / data model flowchart LR object relationships and sharing context
integration sequence sequenceDiagram request/response or event choreography
system landscape flowchart high-level architecture
role / access hierarchy flowchart users, profiles, permissions
Agentforce behavior map flowchart agent → topic → action relationships

Required Context to Gather First

Ask for or infer:

  • diagram type
  • scope and entities / systems involved
  • output preference: Mermaid only, ASCII only, or both
  • whether styling should be minimal, documentation-first, or presentation-friendly
  • for ERDs: whether org metadata is available for grounding

Recommended Workflow

1. Pick the right diagram structure

  • use sequenceDiagram for time-ordered interactions
  • use flowchart LR for ERDs and capability maps
  • keep a single primary story per diagram when possible

2. Gather data

For ERDs and grounded diagrams:

  • use [platform-custom-object-generate](../platform-custom-object-generate/SKILL.md) or [platform-custom-field-generate](../platform-custom-field-generate/SKILL.md) when real schema discovery is needed
  • optionally use the local metadata helper script for counts / relationship context when appropriate

3. Generate Mermaid first

Apply:

  • accurate labels
  • simple readable node text
  • consistent relationship notation
  • restrained styling that renders cleanly in markdown viewers

4. Add ASCII fallback when useful

Provide an ASCII version when the user wants terminal compatibility or plaintext documentation.

5. Explain the diagram briefly

Call out the key relationships, flow direction, and any assumptions.

High-Signal Rules

For sequence diagrams

  • use autonumber when step order matters
  • distinguish requests vs responses clearly
  • use notes sparingly for protocol detail

For ERDs

  • prefer flowchart LR
  • keep object cards simple
  • use clear relationship arrows
  • avoid field overload unless the user explicitly asks for field-level detail
  • color-code object types only when it improves readability

For ASCII output

  • keep width reasonable
  • align arrows and boxes consistently
  • optimize for readability over decoration

Output Format

````markdown

<Diagram Title>

Mermaid Diagram

<diagram>

ASCII Fallback

<ascii>

Notes

  • <key point>
  • <assumption or limitation>

````

Cross-Skill Integration

Need Delegate to Reason
real object / field definitions [platform-custom-object-generate](../platform-custom-object-generate/SKILL.md) / [platform-custom-field-generate](../platform-custom-field-generate/SKILL.md) grounded ERD generation
connected-app auth setup context [integration-connectivity-connected-app-configure](../integration-connectivity-connected-app-configure/SKILL.md) accurate OAuth flows
Agentforce logic visualization [agentforce-generate](../agentforce-generate/SKILL.md) source-of-truth behavior details
Flow behavior diagrams [automation-flow-generate](../automation-flow-generate/SKILL.md) actual Flow logic grounding

Gotchas

Issue Resolution
Mermaid renderer not available Provide ASCII fallback automatically; note that the Mermaid block still carries the diagram for copy-paste into a renderer
ERD becomes unreadable with too many objects Split into sub-diagrams by domain (Sales, Service, etc.) and link them in prose
Sequence diagram step order unclear Use autonumber directive to make step ordering explicit
OAuth flow actors differ by grant type Read the relevant asset template first before generating to avoid actor mismatch

Reference File Index

Conventions & rules — read before generating

  • [references/diagram-conventions.md](references/diagram-conventions.md) — consistency rules for all diagram types
  • [references/mermaid-reference.md](references/mermaid-reference.md) — Mermaid syntax quick reference
  • [references/usage-examples.md](references/usage-examples.md) — worked examples per diagram type

Styling

  • [references/mermaid-styling.md](references/mermaid-styling.md) — theming and annotation patterns
  • [references/color-palette.md](references/color-palette.md) — color-blind-friendly palette with hex values
  • [references/erd-conventions.md](references/erd-conventions.md) — ERD-specific layout and notation rules

Preview

  • [references/preview-guide.md](references/preview-guide.md) — how to render Mermaid locally
  • [scripts/README.md](scripts/README.md) — setup and usage instructions for all scripts in this skill
  • [scripts/mermaidpreview.py](scripts/mermaidpreview.py) — live-reload preview server; run to preview diagrams in browser
  • [scripts/query-org-metadata.py](scripts/query-org-metadata.py) — queries org schema to ground ERD generation

OAuth flow templates — load the matching template when generating OAuth diagrams

  • [assets/oauth/authorization-code.md](assets/oauth/authorization-code.md) — Authorization Code grant
  • [assets/oauth/authorization-code-pkce.md](assets/oauth/authorization-code-pkce.md) — PKCE variant for mobile/SPA
  • [assets/oauth/jwt-bearer.md](assets/oauth/jwt-bearer.md) — JWT Bearer server-to-server
  • [assets/oauth/client-credentials.md](assets/oauth/client-credentials.md) — Client Credentials service accounts
  • [assets/oauth/device-authorization.md](assets/oauth/device-authorization.md) — Device Flow for CLI/IoT
  • [assets/oauth/refresh-token.md](assets/oauth/refresh-token.md) — Refresh Token renewal flow
  • [assets/oauth/user-agent-social-sign-on.md](assets/oauth/user-agent-social-sign-on.md) — User-Agent / Social Sign-On

Data model ERD templates — load the matching template when generating ERDs

  • [assets/datamodel/salesforce-erd.md](assets/datamodel/salesforce-erd.md) — core Salesforce objects
  • [assets/datamodel/sales-cloud-erd.md](assets/datamodel/sales-cloud-erd.md) — Sales Cloud objects
  • [assets/datamodel/service-cloud-erd.md](assets/datamodel/service-cloud-erd.md) — Service Cloud objects
  • [assets/datamodel/b2b-commerce-erd.md](assets/datamodel/b2b-commerce-erd.md) — B2B Commerce objects
  • [assets/datamodel/campaigns-erd.md](assets/datamodel/campaigns-erd.md) — Campaigns and campaign member model
  • [assets/datamodel/consent-erd.md](assets/datamodel/consent-erd.md) — Consent and privacy objects
  • [assets/datamodel/files-erd.md](assets/datamodel/files-erd.md) — Files and ContentDocument model
  • [assets/datamodel/forecasting-erd.md](assets/datamodel/forecasting-erd.md) — Forecasting objects
  • [assets/datamodel/fsl-erd.md](assets/datamodel/fsl-erd.md) — Field Service Lightning objects
  • [assets/datamodel/party-model-erd.md](assets/datamodel/party-model-erd.md) — Party model objects
  • [assets/datamodel/quote-order-erd.md](assets/datamodel/quote-order-erd.md) — Quote and Order objects
  • [assets/datamodel/revenue-cloud-erd.md](assets/datamodel/revenue-cloud-erd.md) — Revenue Cloud objects
  • [assets/datamodel/scheduler-erd.md](assets/datamodel/scheduler-erd.md) — Scheduler objects
  • [assets/datamodel/territory-management-erd.md](assets/datamodel/territory-management-erd.md) — Territory Management objects

Other diagram templates

  • [assets/architecture/system-landscape.md](assets/architecture/system-landscape.md) — system landscape overview template
  • [assets/integration/api-sequence.md](assets/integration/api-sequence.md) — API callout sequence template
  • [assets/agentforce/agent-flow.md](assets/agentforce/agent-flow.md) — Agentforce agent → topic → action flow
  • [assets/role-hierarchy/user-hierarchy.md](assets/role-hierarchy/user-hierarchy.md) — role and permission hierarchy template

Output Expectations

Deliverables produced by this skill for each request:

  • Mermaid code block — fenced `mermaid block ready to paste into GitHub, Confluence, or any Mermaid-capable renderer
  • ASCII fallback (when requested or when Mermaid renderer is unavailable) — text-only diagram using box/arrow characters
  • Brief explanation — 2-5 bullet points calling out key relationships, flow direction, and any assumptions or limitations in the diagram
  • For ERDs: object cards with field labels and relationship type annotations
  • For sequence diagrams: numbered steps (autonumber) with clear actor labels

Score Guide

Score Meaning
72–80 production-ready diagram
60–71 clear and useful with minor polish left
48–59 functional but could be clearer
35–47 needs structural improvement
< 35 inaccurate or incomplete