Getting started

Start with Mermaid source, not a screenshot. Render it locally, then give an agent the prompt from the homepage when you want an edit.

Install Agentic Mermaid.

The npm package is not yet published; install from source.

git clone https://github.com/adewale/beautiful-mermaid && cd beautiful-mermaid && bun install && bun run build

Create a diagram.

cat > diagram.mmd <<'MMD'
flowchart LR
  Idea[Idea] --> Draft[Draft]
  Draft --> Review{Review}
  Review -->|ok| Ship[Ship]
MMD

Verify, then render.

bun run bin/am.ts verify diagram.mmd --json
bun run bin/am.ts render diagram.mmd --format svg --output diagram.svg
bun run bin/am.ts render diagram.mmd --format unicode

Ask an agent for the smallest edit.
Paste your task and source into the homepage agent prompt, and require the agent to return Updated Mermaid, Verification, and Trace.
Get the agent prompt on the homepage
Optional: wire local MCP.
Self-hosting over stdio is the default path. The website is documentation plus a browser-local editor; it is not a render API and it does not run hosted Code Mode.
MCP config
```
{
  "mcpServers": {
    "agentic-mermaid": {
      "command": "bun",
      "args": ["run", "bin/agentic-mermaid-mcp.ts"]
    }
  }
}
```
Run from the cloned repo root, or replace bin/agentic-mermaid-mcp.ts with an absolute path.
```
bun run bin/agentic-mermaid-mcp.ts
```
Use stdio MCP from the cloned repo. The hosted Workers site intentionally does not enable Code Mode or a render API.

Docs index