markdy-syntax

A set of rules for writing valid MarkdyScript, the text format used for animated architecture diagrams.

In plain words
What is it for?
Use it when creating or editing .markdy or .mdy files, especially when diagrams contain groups, animated flows, and narrative steps.
Why use it?
It prevents common formatting mistakes, broken layouts, missing nodes, and confusing return flows in diagram files.

Cursor rule

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/hoangyell/markdy-com/markdy-syntax
Clone the repo
git clone --depth 1 https://github.com/HoangYell/markdy-com
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 396 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found 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.00396
Opus 5 $0.00000 $0.00198
Sonnet 5 $0.00000 $0.00079
Haiku 4.5 $0.00000 $0.00040

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

Security

Grade A, and why

markdy-syntax 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 2d 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.

rules/markdy-syntax.mdc · 33 lines

What it actually says

MarkdyScript Architecture Syntax Rules

When writing or editing Markdy (.markdy or .mdy) files:

  1. Strict 4-Section Flow:

    • Section 1: scene and layout directives (layout LR, theme=midnight).
    • Section 2: Semantic node declarations (service OrderSvc "Order Service").
    • Section 3: group definitions (group backend "Backend Tier": ServiceA ServiceB).
    • Section 4: beat narrative blocks (beat name "Title":).
  2. Always Quote Multi-Word Labels:

    • Correct: service api "Payment API Gateway"
    • Incorrect: service api Payment API Gateway
  3. Always End Beats and Groups with Colons:

    • beat checkout "Step 1":
    • group vpc "Private VPC":
  4. Never Use Forward -> for Return Responses:

    • Always use <- for responses (e.g. Client <- Gateway "200 OK"). Using -> creates graph ranking cycles and breaks the visual DAG layout.
  5. Always Place Animated Flows & Cues Inside Beats:

    • Flows (->, <-, ~>) and cues (show, glow, frame, pulse) must be indented inside a beat block.
  6. Self-Healing MCP Tool:

    • When generating or fixing diagrams, use @markdy/mcp-server tools (diagnose_markdy_syntax, fix_markdy_code) to verify syntax before presenting.
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. 2d ago First seen · 33 lines · 0 tokens per session scan A e6cc9077c313

Subscribe to this mod's changes

markdy-syntax is a cursor rule published in the GitHub repository HoangYell/markdy-com (87 stars, last pushed 2d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 396 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.