mermaid-compat

A documentation rule for writing Mermaid diagrams that render reliably across different tools.

In plain words
What is it for?
Use it when adding Mermaid diagrams to project documentation viewed on GitHub, in editor previews, or on documentation sites.
Why use it?
It reduces parsing and display failures caused by special characters, complex labels, or unsupported Markdown formatting.

Cursor rule for Codex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/prisma/prisma-next/mermaid-compat
Clone the repo
git clone --depth 1 https://github.com/prisma/prisma-next

Made for: Codex.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 124 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 100% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00124
Opus 5 $0.00000 $0.00062
Sonnet 5 $0.00000 $0.00025
Haiku 4.5 $0.00000 $0.00012

Measured 3d ago against content hash 4acdf48553f8, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

mermaid-compat scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

This is a copy

100% identical to mermaid-compat — 0 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

.agents/rules/mermaid-compat.mdc · 16 lines

What it actually says

Mermaid compatibility (docs)

Different Mermaid renderers (GitHub, VS Code previews, docs sites) can be stricter than Mermaid itself. To avoid parse/render failures in project docs:

  • Prefer ASCII in node labels (avoid curly quotes, arrows like , ellipses like , and emoji prefixes).
  • Avoid Markdown formatting inside labels (especially backticks).
  • Prefer direction TB inside subgraph blocks.
  • Keep labels short; move detail to surrounding Markdown.
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 16 lines · 0 tokens per session scan A 4acdf48553f8

Subscribe to this mod's changes

mermaid-compat is a cursor rule published in the GitHub repository prisma/prisma-next (420 stars, last pushed 8d ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 124 tokens. A static security scan graded it A with 0 findings. It is 100% identical to mermaid-compat, differing in 0 lines, and is treated as a copy.