Skip to main content
Glama
TIP

🧩New! Render PlantUML diagrams directly inside GitHub with our official browser extension — No server. No tokens. No tracking. Zero permissions but clipboard.

Add to Chrome Add to Firefox

💬 Want native PlantUML support in GitHub? Upvote and join the discussion: Support for PlantUML diagrams

TIP

🤖New! Give your AI assistant the power to render and check PlantUML diagrams with @plantuml/mcp-js — a pure Node.js MCP server. No Java. No server. Just npx @plantuml/mcp-js.

npm version npm downloads MCP Toplist

🌱 PlantUML

Generate UML diagrams from textual descriptions.

Discord server GitHub Sponsors GitHub Org's stars GitHub watchers GitHub contributors GitHub forks GitHub all releases

Release (latest by date) Release Date GitHub commits since latest release (by date) javadoc

Pre-release (latest by date) Pre-release Date GitHub last commit CI snapshot javadoc snapshot jacoco SonarQube Cloud

Dev Project Pages index Ask DeepWiki

JavaScript Demo

ℹ️ About

PlantUML is a component that allows you to create various UML diagrams through simple textual descriptions. From sequence diagrams to deployment diagrams and beyond, PlantUML provides an easy way to create visual representations of complex systems.

🗃️ Supported Diagram Types

📣 Additional Features

📖 Learn More

For a more detailed overview, visit PlantUML Official Website.

Related MCP server: PlantUML MCP Server

🛡 Security

See Security Policy and Security overview.

🚀 Getting Started

Whether you're looking to use PlantUML as a standalone application or as a component in your own project, getting started is simple. Check out the official PlantUML setup guide for instructions on how to set up PlantUML on your system.

⚙️ Building from Source

To build PlantUML from source, you have two options:

  1. Using Gradle: ./gradlew jar

  2. Using Ant: ant

For prerequisites and detailed build instructions, see our BUILDING.md guide.

🌐 Building for the Browser (TeaVM)

PlantUML can be compiled to JavaScript with TeaVM to run entirely client-side in the browser, with no server required. To produce the JavaScript artifacts and use them in your own project:

git clone https://github.com/plantuml/plantuml.git
cd plantuml
chmod +x ./gradlew
./gradlew clean teavm -Pfast
cp ./build/generated/teavm/js/plantuml.js $YOUR_PROJECT/plantuml.js
cp ./build/generated/teavm/js/viz-global.js $YOUR_PROJECT/viz-global.js

The -Pfast flag skips the slow parts of a regular build (tests, Javadoc, JaCoCo) so you only get the TeaVM output. The viz-global.js file provides Viz.js (Graphviz) support for diagrams that rely on Dot layout.

The teavm task also copies the PlantUML stdlib bundles and a ready-to-use index.html demo into ./build/generated/teavm/js/.

For a live example of client-side rendering, see the JavaScript PlantUML Demo.

🧱 Contributing

PlantUML is an open-source project, and we welcome contributions of all kinds. Whether you're helping us fix bugs, improve the docs, or spread the word, we appreciate your support. See our contributing guide for more information on how to get started.

The language guide on plantuml.com is updated through alphadoc. Edit a page there (pick a language and wiki syntax), save, and maintainers publish it after review. Details are in CONTRIBUTING.md.

For comprehensive and detailed documentation on using PlantUML, refer to the official Javadoc, available here. Please note that this documentation is a work in progress and may not be complete.

🧑‍🤝‍🧑 Support and Community

📃 License

PlantUML is licensed under several licenses; you can choose the one that suits you best:

For more information, please refer to the PlantUML license FAQ to help determine which license is appropriate for your use case.

Available Tools

4 tools
check_syntaxA

Checks the syntax of a single PlantUML diagram without rendering it. Returns a JSON object containing: 'valid' (boolean), 'diagramType' (if valid), 'lineCount', 'warnings' (list of non-fatal warnings), and on failure 'errorLineNumber' (1-based line number), 'errorMessage', 'errorLine' (the offending source line, when available), and 'errorContext'.

Inputs: source (required).

explain_diagramA

Explains how a single PlantUML diagram is parsed, line by line. Returns a JSON array of objects, each containing: 'input' (the source line(s) that produced the explanation), 'explain' (a human-readable explanation), and 'line' (1-based line number, when available).

Inputs: source (required).

plantuml_versionA

Returns the version of the embedded PlantUML library (TeaVM JS build).

Inputs: no named parameters.

render_diagramA

Renders a single PlantUML diagram to a deterministic SVG. Returns a JSON object containing: 'valid' (boolean), and when valid 'diagramType', 'lineCount', 'warnings' (list of non-fatal warnings) and 'svg' (the rendered SVG as a string). On failure it has the same error shape as check_syntax: 'errorLineNumber' (1-based), 'errorMessage', 'errorLine' (the offending source line, when available) and 'errorContext'.

Inputs: source (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A4/5.0

    Scored across 4 tools

    Disambiguation5/5

    Each tool has a clearly distinct purpose: syntax validation, SVG rendering, parse explanation, and library version lookup. An agent can select among them without meaningful overlap, even though check_syntax and render_diagram share an error shape.

    Naming Consistency4/5

    All names use snake_case consistently. Three follow a verb_noun pattern (check_syntax, render_diagram, explain_diagram), while plantuml_version is a noun-only name, a minor deviation but still readable and predictable.

    Tool Count5/5

    Four tools is well-scoped for a focused PlantUML diagram utility server, and each one earns its place without redundancy. There is no sense of a thin or padded surface.

    Completeness4/5

    The surface covers the core lifecycle for a single diagram: validate, render, explain, and report the engine version. Minor gaps exist, such as batch/multi-diagram handling or output format options (e.g. PNG), but agents can work around these for the stated single-diagram purpose.

    Maintenance

    ActivityNo data
    ResponsivenessOutdated data

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      D
      maintenance
      An MCP server that validates Mermaid diagram syntax and identifies diagram types across all major formats. It provides detailed parse-error messages for invalid diagrams without requiring external rendering processes.
      9 npm
      3
      MIT
    • A
      license
      A
      quality
      B
      maintenance
      MCP server for rendering 35+ diagram types — sequence, flowchart, ER, C4, gantt, mindmap, infra, and more — to SVG/PNG with browser preview. Local rendering with palette/theme support and shareable diagrammo.app URLs.
      14
      454 npm
      3
      MIT