Skip to content

Tutorials

Pick a starting point. Each tutorial is self-contained and assumes you have a working UML-MCP server (hosted, local, or Docker). If you don't, start with Getting started.

  • Getting started

    Connect a client, generate your first diagram, save vs URL, validate, batch, and use themes/scale. The end-to-end path from zero to a rendered PNG.

    Start the tutorial

  • Diagram Assistant

    Mermaid sequence/Gantt, BPMN process modeling, and converting class diagrams into Mermaid using named prompts and uml:// resources.

    Read the guide

  • Mermaid live examples

    Live gallery (flowchart, sequence, class, state, Gantt, ER) plus a section on prompts, optional Sequential Thinking MCP, and server SVG via generate_uml.

    Browse Mermaid

  • PlantUML prompts and SVG

    Copy-paste prose prompts, example Sequential Thinking steps, named MCP prompts (class_diagram, sequence_diagram, …), and a committed SVG sample.

    Open PlantUML tutorial

  • D2 prompts and SVG

    Service-style sketches, planning with Sequential Thinking, uml_diagram_with_thinking, and a D2 SVG example.

    Open D2 tutorial

  • TikZ prompts and SVG

    Precision figures with TikZ, optional Sequential Thinking, and a minimal circle SVG from Kroki.

    Open TikZ tutorial

  • BPMN guide

    A short, structured BPMN 2.0.2 reference: events, tasks, gateways, sequence flow, lanes and pools.

    Read the BPMN guide

  • BPMN prompts and SVG

    Copy-paste prose prompts, named MCP prompts (bpmn_process_guide, bpmn_executable_process), a full tools/call JSON example with BPMN-DI XML, and a committed Kroki SVG sample.

    Open BPMN prompts tutorial

Prerequisites

  • An MCP-compatible client (Cursor, Claude Desktop, an HTTP client, or curl).
  • A running UML-MCP server. Use the public endpoint at https://uml-mcp.vercel.app/mcp, install via Smithery, or run locally; see Deploy.

Plan before you generate

The default prompts (uml_diagram, uml_diagram_with_thinking) ask the model to plan (type, elements, relationships) before calling generate_uml. The uml://workflow resource summarises the same flow.