mcpField
M
mermaid-diagrams

mermaid-diagrams

github.com/ccheneyDocuments61467 installsUpdated 7w ago
Repository

About mermaid-diagrams

Mermaid Diagrams is a skill for turning supplied processes, code, schemas, or relationships into Mermaid diagrams. It helps people select a diagram type, preserve evidence without inventing missing facts, and produce syntax suited to the target renderer.

Key features

  1. 01Selects diagram types by purpose
  2. 02Creates flowcharts and sequence diagrams
  3. 03Models data, states, classes, and services
  4. 04Preserves supplied facts and marks assumptions
  5. 05Guidance for renderable Mermaid syntax

Use cases

  1. 01Map process steps and decision paths
  2. 02Show call order between participants
  3. 03Represent database tables and relationships
  4. 04Document states or service relationships

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/ccheney/robust-skills --skill mermaid-diagrams

After installing, type/mermaid-diagramsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
ADVANCED.md
ARCHITECTURE.md
CHEATSHEET.md
CLASS-ER.md
DATA-CHARTS.md
FLOWCHARTS.md
SEQUENCE.md
STATE-JOURNEY.md

Details

From the project README

Mermaid Diagrams

Turn the supplied process, code, schema, or relationships into the requested Mermaid diagram. The user's explicit instructions take precedence over this skill's guidelines, including their choice of output format.

Choose the representation

Establish the facts to show and the destination renderer. If the request leaves the format open and a text-based system/process diagram fits, Mermaid is a reasonable choice. Preserve an explicitly requested drawing tool or artifact format.

QuestionDiagram
What happens next or which path is taken?flowchart
Who calls whom, in what order?sequenceDiagram
What tables and cardinalities exist?erDiagram
What states and transitions exist?stateDiagram-v2
How are types or services related?classDiagram or flowchart with subgraphs
What is scheduled or measured?A matching planning/data type from the references

Use supplied evidence for nodes, edges, cardinalities, dates, and values. Mark conceptual assumptions; ask for missing facts that determine the diagram rather than inventing a system.

Produce a renderable result

  • Return a fenced mermaid block, or the requested .mmd/rendered artifact. Use one diagram declaration per block.
  • Prefer stable syntax supported by the destination. Examples were checked against Mermaid 11.16; a host can bundle an older version.
  • Give nodes stable IDs distinct from display labels and subgraph IDs. Quote labels with punctuation; avoid reserved end IDs and use %% comments on their own lines.
  • Keep ER attributes one per line and alias sequence participants whose names contain spaces.
  • Split diagrams when readability suffers, not at a fixed node count.

Validate nontrivial or repaired syntax with the project's renderer or an available Mermaid CLI. Inspect the rendered result when producing an artifact; if rendering is unavailable, state that limitation. A simple syntax answer does not require installing a new toolchain.

References

Load the diagram type or rendering topic required.

TaskReference
Flowcharts, subgraphs, shapes, edgesFLOWCHARTS.md
Calls, activation, loops, alternativesSEQUENCE.md
Classes, types, database relationshipsCLASS-ER.md
State machines and user journeysSTATE-JOURNEY.md
Gantt, timeline, pie, XY, sankey, mindmap, gitGraphDATA-CHARTS.md
C4, architecture, block, kanban, packet, requirementsARCHITECTURE.md
Configuration, styling, export, troubleshootingADVANCED.md
Compact syntax and platform lookupCHEATSHEET.md

Check Mermaid documentation and the destination's own support notes when a feature is version-sensitive.

Comments

Markdown supported