mermaid
Create or revise Mermaid diagrams that render inside Markdown, README files, GitHub, GitLab, wikis, and documentation sites. Use when the user explicitly requests Mermaid or needs a Markdown-native flowchart, sequence diagram, state diagram, class diagram, ER diagram, journey, Gantt chart, mind map, timeline, or lightweight architecture diagram. Prefer PlantUML for strict UML/C4 deliverables and ProcessOn only when editable hosted output is requested.
How do I install this agent skill?
npx skills add https://github.com/full-stack-skills/document-skills --skill mermaidIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill is a comprehensive utility for generating and revising various types of Mermaid diagrams. It provides extensive syntax examples and guidelines for flowcharts, sequence diagrams, architecture diagrams, and more. No malicious code, exfiltration patterns, or safety bypasses were detected. The skill recommends complementary tools from the same author, which is standard for this ecosystem.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
What does this agent skill do?
Mermaid Diagrams
Produce valid Mermaid source that communicates relationships more clearly than prose.
Routing
- Choose Mermaid by default for Markdown-native diagrams.
- Choose the
plantumlskill for strict UML notation, detailed C4, or.pumloutput. Install with:npx skills add full-stack-skills/document-skills --skill plantuml. - Choose the
processon-diagram-generatorskill when the user explicitly wants ProcessOn or hosted editable rendering. Install with:npx skills add full-stack-skills/document-skills --skill processon-diagram-generator. - Do not ask the user to choose a tool when the context already determines a safe default.
Workflow
- Extract entities, states, decisions, messages, or dependencies from the request and available source.
- Select the smallest suitable diagram type.
- Generate syntactically complete Mermaid source.
- Keep labels concise and quote labels containing punctuation, parentheses, or special characters.
- Validate the structure and, when a Mermaid renderer is available, render it before delivery.
- Save a file only when the user asks for a file or the diagram belongs in an existing document.
Diagram selection
| Need | Mermaid declaration |
|---|---|
| Process or decision | flowchart TD or flowchart LR |
| Calls over time | sequenceDiagram |
| State lifecycle | stateDiagram-v2 |
| Type relationships | classDiagram |
| Data entities | erDiagram |
| Schedule | gantt |
| User experience | journey |
| Hierarchy | mindmap |
| Chronology | timeline |
| Lightweight architecture | architecture-beta or a flowchart |
Load only the matching file under examples/ when syntax details are needed. Do not load all examples.
Authoring rules
- Give every node a stable, simple identifier.
- Quote human-readable labels when they contain punctuation.
- Use one direction consistently; avoid unnecessary crossings.
- Represent a decision with a diamond and label outgoing branches.
- Keep sequence participants and messages explicit.
- Avoid styling that depends on a single renderer unless the target platform is known.
- Split an unreadable diagram instead of shrinking labels or adding excessive subgraphs.
- Do not encode unsupported facts merely to make the diagram look complete.
Output
For inline delivery, return a fenced block:
```mermaid
flowchart LR
A["Input"] --> B{"Valid?"}
B -->|Yes| C["Process"]
B -->|No| D["Reject"]
```
For file delivery, prefer docs/diagrams/<descriptive-name>.md unless the repository already has a diagram convention. Preserve existing files and ask before overwriting.
Validation checklist
- Opening declaration matches the intended diagram type.
- Identifiers are valid and unique.
- Labels with punctuation are quoted.
- All branches, participants, and relationships are connected as intended.
- Fenced Markdown blocks are closed.
- The diagram renders on the user's target platform when that renderer is available.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/full-stack-skills/document-skills/mermaid">View mermaid on skillZs</a>