How do I install the Mermaid skill?

Run npx skillmds add majiayu000/mermaid-3 in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Mermaid safe to use?

This skill has not completed SkillMD's automated safety review yet. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Mermaid?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Mermaid free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Mermaid?

majiayu000 (@majiayu000) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Mermaid by majiayu000 — Agent Skill

Name: Mermaid
Rating: 4.2 (5 reviews)
Author: majiayu000

Mermaid

Generate Mermaid diagrams for chatbot flows that render in Markdown, including choosing diagram types, producing valid Mermaid code blocks, and validating or rendering diagrams locally via the bundled scripts. Use when a user asks for chatbot flowcharts/sequence/state diagrams, wants Mermaid syntax, or needs to verify/render Mermaid without a web service.

majiayu000 f81dd1f 2 files · 2.6 KB Updated Sep 9, 2026 567 repo stars

File contents

Mermaid Diagrams for Chatbots

Use this skill to create Mermaid diagrams that render well in Markdown chat interfaces, validate their syntax locally, and render images without calling a web service.

Workflow

Identify the diagram type (flowchart, sequenceDiagram, stateDiagram-v2) based on the request.
Draft Mermaid code in a fenced Markdown block using mermaid.
Follow formatting conventions in references/chatbot-mermaid-guidelines.md.
Validate the diagram using scripts/validate_mermaid.py.
If the user wants an image file, render with scripts/render_mermaid.py.

Scripts

scripts/validate_mermaid.py
- Validate Mermaid code by invoking the local Mermaid CLI (mmdc).
- Use when you need to check whether Mermaid parses without errors.
scripts/render_mermaid.py
- Render Mermaid to SVG/PNG/PDF using the local Mermaid CLI (mmdc).
- Prefer SVG for Markdown renderers when image embedding is required.

Notes

These scripts expect mmdc to be available on PATH (Mermaid CLI). If missing, instruct the user to install it locally; do not use the Mermaid web service.
Dependencies are managed via inline uv script metadata in each Python script. Use --install-chromium to bootstrap the Chromium binary via pyppeteer when needed.
Keep diagrams compact and readable in chat: avoid overly wide graphs, use short labels, and group related states.
If the user asks for raw Markdown, return only the fenced mermaid block unless they ask for extra explanation.

Frequently asked questions