Agent skill

Mermaid

by WH-2099 in WH-2099/mermaid-skill

Generate Mermaid diagrams from user requirements. An agent skill from WH-2099/mermaid-skill.

MITAuto-check passedDevelopment

Install Mermaid

skills CLI
$ npx skills add WH-2099/mermaid-skill --skill mermaid -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install WH-2099/mermaid-skill mermaid --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/WH-2099/mermaid-skill.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/mermaid .claude/skills/mermaid && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
mermaid
GitHub stars
288
Used in
4 other repos
Token cost
~958 tokens
SKILL.md length
279 words
Files
39 (incl. references)
Skills in repo
1
Repo updated
First seen
Licence
MIT

At a glance

Generate Mermaid diagrams from user requirements. An agent skill from WH-2099/mermaid-skill.

  • Works in 4 steps: Understand Requirements: Analyze user… → Read Documentation: Read the… → Generate Code: Generate Mermaid code… → …
  • Tasks that involve Diagrams
  • SKILL.md covers Workflow, Diagram Type Reference, Configuration & Themes and Output Specification, plus 1 more section
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Mermaid is an agent skill from WH-2099/mermaid-skill. Generate Mermaid diagrams from user requirements. Supports flowcharts, sequence diagrams, class diagrams, ER diagrams, Gantt charts, and 18 more diagram types.

Its SKILL.md is about 960 tokens, which your agent loads only when the skill is triggered. The skill folder holds 39 other files, including reference files (for example `references/architecture.md`, `references/block.md` and `references/c4.md`).

It sits in Development, covering Diagrams. It works with Mermaid. The repository describes itself as: A Claude Code skill for generating Mermaid diagrams with all diagram types supported. The licence is MIT.

When your agent uses it

  • Tasks that involve Diagrams

Example prompts

  • “/mermaid”

Requirements

  • Pre-approved tools (allowed-tools): Read, Write, Edit

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. Understand Requirements: Analyze user description to determine the most suitable diagram type
  2. Read Documentation: Read the corresponding syntax reference for the diagram type
  3. Generate Code: Generate Mermaid code following the specification
  4. Apply Styling: Apply appropriate themes and style configurations

What it can do on your machine

Read from SKILL.md and the folder at commit 982d903. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Read
    • Write
    • Edit

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are mermaid).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Mermaid loads about 958 tokens when it runs, and up to ~139k if it reads all its reference files. Until then it costs about 42 tokens; SKILL.md has 279 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~42
When it runs · the whole SKILL.md, loaded when a task matches
~958
With references · SKILL.md plus every file in references/, read only if the agent opens them
~139k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from WH-2099/mermaid-skill at commit 982d903, republished under its MIT licence (© WH-2099). 279 words, ~958 tokens.

Download SKILL.mdSave it as .claude/skills/mermaid/SKILL.md (or your agent's skills folder). This skill also uses 38 other files; get the full folder from GitHub.
name
mermaid
description
Generate Mermaid diagrams from user requirements. Supports flowcharts, sequence diagrams, class diagrams, ER diagrams, Gantt charts, and 18 more diagram types.
allowed-tools
Read, Write, Edit
metadata.argument-hint
[diagram description or requirements]

Mermaid Diagram Generator

Generate high-quality Mermaid diagram code based on user requirements.

Workflow

  1. Understand Requirements: Analyze user description to determine the most suitable diagram type
  2. Read Documentation: Read the corresponding syntax reference for the diagram type
  3. Generate Code: Generate Mermaid code following the specification
  4. Apply Styling: Apply appropriate themes and style configurations

Diagram Type Reference

Select the appropriate diagram type and read the corresponding documentation:

TypeDocumentationUse Cases
Flowchartflowchart.mdProcesses, decisions, steps
Sequence DiagramsequenceDiagram.mdInteractions, messaging, API calls
Class DiagramclassDiagram.mdClass structure, inheritance, associations
State DiagramstateDiagram.mdState machines, state transitions
ER DiagramentityRelationshipDiagram.mdDatabase design, entity relationships
Gantt Chartgantt.mdProject planning, timelines
Pie Chartpie.mdProportions, distributions
Mindmapmindmap.mdHierarchical structures, knowledge graphs
Timelinetimeline.mdHistorical events, milestones
Git Graphgitgraph.mdBranches, merges, versions
Quadrant ChartquadrantChart.mdFour-quadrant analysis
Requirement DiagramrequirementDiagram.mdRequirements traceability
C4 Diagramc4.mdSystem architecture (C4 model)
Sankey Diagramsankey.mdFlow, conversions
XY ChartxyChart.mdLine charts, bar charts
Block Diagramblock.mdSystem components, modules
Packet Diagrampacket.mdNetwork protocols, data structures
Kanbankanban.mdTask management, workflows
Architecture Diagramarchitecture.mdSystem architecture
Radar Chartradar.mdMulti-dimensional comparison
Treemaptreemap.mdHierarchical data visualization
User JourneyuserJourney.mdUser experience flows
ZenUMLzenuml.mdSequence diagrams (code style)

Configuration & Themes

Output Specification

Generated Mermaid code should:

  1. Be wrapped in ```mermaid code blocks
  2. Have correct syntax that renders directly
  3. Have clear structure with proper line breaks and indentation
  4. Use semantic node naming
  5. Include styling when needed to improve visual appearance

Example Output

mermaid
flowchart TD
    A[Start] --> B{Condition}
    B -->|Yes| C[Execute]
    B -->|No| D[End]
    C --> D

User requirements: $ARGUMENTS

© WH-2099, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 38 other files (references) in .claude/skills/mermaid of WH-2099/mermaid-skill.

  • SKILL.md
  • references/architecture.md
  • references/block.md
  • references/c4.md
  • references/classDiagram.md
  • references/config-configuration.md
  • references/config-directives.md
  • references/config-layouts.md
  • references/config-math.md
  • references/config-theming.md
  • references/config-tidy-tree.md
  • references/cynefin.md
  • references/entityRelationshipDiagram.md
  • references/eventmodeling.md
  • references/examples.md
  • references/flowchart.md
  • references/gantt.md
  • references/gitgraph.md
  • references/ishikawa.md
  • references/kanban.md
  • … and 19 more

Open the folder on GitHubat commit 982d903

Used in 4 other repositories

We found 4 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 4 other GitHub owners. This page covers the copy in WH-2099/mermaid-skill, which our catalogue first saw on October 7, 2026.

Compare with similar skills

Mermaid next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Mermaid compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Mermaid this skillWH-2099/mermaid-skill2884 repos~958Automated safety check: PassMIT
Archify Diagramstt-a1i/archify82k—~2.9kAutomated safety check: PassMIT
Diagram Designcathrynlavery/diagram-design49k1 repos~7.6kAutomated safety check: PassMIT
Draw.io Diagram StudioAgents365-ai/drawio-skill10k—~2.4kAutomated safety check: NotesMIT
Pretty Mermaid Rendererimxv/Pretty-mermaid-skills1.5k—~2kAutomated safety check: PassMIT
Archify Diagram BuilderUnclecheng-li/AI_Animation1.5k2 repos~4.1kAutomated safety check: PassMIT

Similar skills

  • Archify Diagrams

    tt-a1i/archify

    Creates interactive architecture, workflow, sequence, data-flow and lifecycle diagrams as standalone HTML with inline SVG, themes and image or video export.

    82k GitHub stars~2.9k tokensUpdated today
    DevelopmentAuto-check passed
  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    49k GitHub starsUsed in 1 repo~7.6k tokens
    DevelopmentAuto-check passed
  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated today
    DevelopmentAuto-check: notes
  • Pretty Mermaid Renderer

    imxv/Pretty-mermaid-skills

    Writes and renders Mermaid diagrams as themed SVG, PNG or terminal ASCII and Unicode art with a bundled Node.js CLI that needs no browser.

    1.5k GitHub stars~2k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed
  • Archify Diagram Builder

    Unclecheng-li/AI_Animation

    Builds validated architecture, workflow, sequence, data-flow and lifecycle diagrams as standalone interactive HTML from a small JSON spec, with optional motion and image export.

    1.5k GitHub starsUsed in 2 repos~4.1k tokens
    DevelopmentAuto-check passed
  • Archify

    molvqingtai/WebChat

    Create professional architecture, workflow, sequence, data-flow, and lifecycle/state diagrams as standalone HTML files with SVG graphics, a built-in dark/light theme toggle, and one-click export to…

    2.6k GitHub stars~5.6k tokensUpdated 28 days ago
    DevelopmentAuto-check passed

Works with

Categories

Questions about Mermaid

What does Mermaid do?

Generate Mermaid diagrams from user requirements. An agent skill from WH-2099/mermaid-skill. Mermaid is an agent skill from WH-2099/mermaid-skill. Generate Mermaid diagrams from user requirements.

When should I use Mermaid?

Mermaid fits situations like: tasks that involve Diagrams.

How do I install Mermaid in Claude Code?

Run `npx skills add WH-2099/mermaid-skill --skill mermaid -a claude-code`. Or copy the skill folder (.claude/skills/mermaid in WH-2099/mermaid-skill) into .claude/skills/mermaid in your project. Claude Code loads it when a task matches its description.

How do I install Mermaid in Codex?

Run `npx skills add WH-2099/mermaid-skill --skill mermaid -a codex`. Or copy the skill folder (.claude/skills/mermaid in WH-2099/mermaid-skill) into .agents/skills/mermaid in your project. Codex loads it when a task matches its description.

Can I use Mermaid in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add WH-2099/mermaid-skill --skill mermaid -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/mermaid, .gemini/skills/mermaid, .github/skills/mermaid and .opencode/skills/mermaid in your project.

What does Mermaid need to run?

SKILL.md names no scripts, command-line tools or credentials: Mermaid is instructions for the agent only. Its frontmatter pre-approves these tools: Read, Write, Edit.

Does Mermaid access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Mermaid safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Mermaid use?

Mermaid is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Mermaid use?

About 958 tokens (SKILL.md is roughly 3.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 138k tokens, read only when the agent opens those files.

What are the alternatives to Mermaid?

Skills that share tags, products or a category with Mermaid: Archify Diagrams (tt-a1i/archify, 82k stars), Diagram Design (cathrynlavery/diagram-design, 49k stars), Draw.io Diagram Studio (Agents365-ai/drawio-skill, 10k stars) and Pretty Mermaid Renderer (imxv/Pretty-mermaid-skills, 1.5k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Mermaid?

WH-2099 (a GitHub user) maintains it in WH-2099/mermaid-skill, which has 288 GitHub stars. The repository was last updated on August 11, 2026.

Source: WH-2099/mermaid-skill on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.