Skip to content
Back to search

uml-mcp

UML-MCP Server is a UML diagram generation tool based on MCP (Model Context Protocol), which can help users generate various types of UML diagrams through natural language description or directly writing PlantUML and Mermaid and Kroki https://uml-mcp.vercel.app/mcp

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/antoinebou12/uml-mcp with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/antoinebou12/uml-mcp'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/antoinebou12--uml-mcp/badge.svg)](/listings/antoinebou12--uml-mcp)

HTML

<a href="/listings/antoinebou12--uml-mcp"><img src="/api/listings/antoinebou12--uml-mcp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

**Remote (recommended)** — add to your MCP client:

"uml-mcp": {
  "transport": "http",
  "url": "https://uml-mcp.vercel.app/mcp"
}

Use **`/mcp`**, not the site root. Then ask: *“Draw a sequence diagram of a user logging in through an API gateway.”* or paste PlantUML / Mermaid / Kroki source.

Repo defaults: [`.cursor/mcp.json`](.cursor/mcp.json) · [`.vscode/mcp.json`](.vscode/mcp.json) · [`.codex/config.toml`](.codex/config.toml).

| Client | Config | Guide | | --- | --- | --- | | Cursor | [`.cursor/mcp.json`](.cursor/mcp.json) | [docs/integrations/cursor.md](docs/integrations/cursor.md) | | VS Code / Copilot | [`.vscode/mcp.json`](.vscode/mcp.json) | [docs/integrations/vscode_copilot.md](docs/integrations/vscode_copilot.md) | | OpenAI Codex | [`.codex/config.toml`](.codex/config.toml) | [docs/integrations/openai_codex.md](docs/integrations/openai_codex.md) | | Ollama / Open WebUI | [`config/openwebui_mcp.json`](config/openwebui_mcp.json) | [docs/integrations/ollama.md](docs/integrations/ollama.md) | | Claude Desktop | [`config/claude_desktop_*.json`](config/) | [docs/integrations/claude_desktop.md](docs/integrations/claude_desktop.md) |

All snippets: [`config/README.md`](config/README.md)

**Install locally (guided):**

| Path | Command | | --- | --- | | Installer (needs only Python + typer + tqdm) | `python scripts/install.py` | | Setup wizard | `uv tool install uml-mcp && uml-mcp setup` (profile, features, clients, health check) | | Web setup form | `uml-mcp setup --web` → setup page in the console | | Manual | `uml-mcp config init --profile local` · `uml-mcp client install --client vscode\|cursor\|claude-desktop\|claude-code` |

Guide: [docs/installation.md](docs/installation.md)

<p align="center"> </p>

<p align="center"><sub>Admin console (<code>uml-mcp admin</code>): overview · setup · settings · activity · logs · metrics · plugins, light and dark, desktop and mobile</sub></p>

<details> <summary><strong>Clone from origin (local stdio)</strong></summary>

git clone https://github.com/antoinebou12/uml-mcp.git
cd uml-mcp
uv sync
uv run python server.py

If you already have the repo and need to set origin:

git remote add origin https://github.com/antoinebou12/uml-mcp.git

Configs: [`config/README.md`](config/README.md) (Cursor, VS Code, Codex, Claude, Open WebUI, Continue)

</details>

<details> <summary><strong>Claude Code plugin</strong></summary>

/plugin marketplace add https://github.com/antoinebou12/uml-mcp
/plugin install uml-mcp@uml-mcp-plugins

[docs/integrations/claude_code.md](docs/integrations/claude_code.md) · Cursor skill: [`.skill/skills/uml-mcp-diagrams/SKILL.md`](.skill/skills/uml-mcp-diagrams/SKILL.md)

</details>

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 23 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. {
  2. "name": "uml-mcp-plugins",
  3. "metadata": {
  4. "description": "Official Claude Code plugins for the UML-MCP diagram MCP server (PlantUML, Mermaid, D2, Kroki).",
  5. "version": "1.4.0"
  6. },
  7. "owner": {
  8. "name": "Antoine Boucher",
  9. "url": "https://github.com/antoinebou12"
  10. },
  11. "plugins": [
  12. {
  13. "name": "uml-mcp",
  14. "source": "./plugins/uml-mcp",
  15. "description": "Hosted HTTP MCP at uml-mcp.vercel.app plus /uml-mcp:uml-diagrams skill for URL-first diagram workflows.",
  16. "version": "1.4.0",
  17. "homepage": "https://github.com/antoinebou12/uml-mcp",
  18. "repository": "https://github.com/antoinebou12/uml-mcp",
  19. "license": "MIT",
  20. "keywords": ["mcp", "diagrams", "uml", "mermaid", "plantuml", "kroki", "d2"]
  21. }
  22. ]
  23. }
README.md · README · 210 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <div align="center">
  2. <img src="docs/assets/favicon.svg" width="84" alt="UML-MCP logo" />
  3. # UML-MCP
  4. **Diagrams for AI assistants.** A [Model Context Protocol](https://modelcontextprotocol.io/) server
  5. that turns a description or diagram source into a rendered diagram, inside the chat.
  6. [![Run Tests](https://github.com/antoinebou12/uml-mcp/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/antoinebou12/uml-mcp/actions/workflows/test.yml)
  7. [![Deploy docs](https://github.com/antoinebou12/uml-mcp/actions/workflows/docs.yml/badge.svg?branch=main)](https://antoinebou12.github.io/uml-mcp/)
  8. [![GitHub release](https://img.shields.io/github/v/release/antoinebou12/uml-mcp?include_prereleases)](https://github.com/antoinebou12/uml-mcp/releases)
  9. [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
  10. [![Python >=3.12,<3.16](https://img.shields.io/badge/python-3.12%E2%80%933.15-blue.svg)](https://www.python.org/downloads/)
  11. [![GitHub stars](https://img.shields.io/github/stars/antoinebou12/uml-mcp?style=flat)](https://github.com/antoinebou12/uml-mcp/stargazers)
  12. [![Contributors](https://img.shields.io/github/contributors/antoinebou12/uml-mcp)](https://github.com/antoinebou12/uml-mcp/graphs/contributors)
  13. [![Last commit](https://img.shields.io/github/last-commit/antoinebou12/uml-mcp)](https://github.com/antoinebou12/uml-mcp/commits/main)
  14. [**Docs**](https://antoinebou12.github.io/uml-mcp/) ·
  15. [**Quick start**](#quick-start) ·
  16. [**Kroki diagrams**](#kroki-diagrams) ·
  17. [**Interactive diagrams**](#interactive-diagrams) ·
  18. [**Changelog**](CHANGELOG.md) ·
  19. [**Contributing**](CONTRIBUTING.md)
  20. </div>
  21. ## It works as an MCP App
  22. In clients that support MCP Apps, diagrams open in a viewer inside the chat
  23. (`ui://uml-mcp/diagram-viewer`): zoom, edit the source, switch theme and format, re-render, step
  24. through a batch, and export SVG, PNG, HTML or PDF. Clients without MCP Apps get the same diagram
  25. as an inline PNG and SVG.
  26. <p align="center">
  27. <a href="docs/assets/mcp-app-demo.mp4"><img src="docs/assets/mcp-app-demo.gif" width="420" alt="Recording of the UML-MCP viewer inside a chat: four diagram tabs from one batch call, switching tabs, then re-rendering with another format." /></a>
  28. </p>
  29. <p align="center"><sub>One <code>generate_uml_batch</code> call returns four diagrams as tabs, then one is re-rendered in another format. <a href="docs/assets/mcp-app-demo.mp4">Full-quality video</a> · <a href="docs/integrations/mcp-app.md">more about the viewer</a>.</sub></p>
  30. <p align="center">
  31. <img src="docs/assets/diagrams/client-server-chat.png" width="680" alt="UML-MCP in chat: a Client/Server Mermaid sequence diagram with URL and Playground links" />
  32. </p>
  33. <p align="center"><sub>In any other chat client: the inline image with links to the rendered file and an editable playground.</sub></p>
  34. ## Why UML-MCP
  35. - **52 diagram types.** 37 through [Kroki](https://kroki.io/) (UML, Mermaid, D2, Graphviz, C4, BPMN,
  36. ERD, TikZ...) and 15 interactive ones, including cloud and stack diagrams with real logos,
  37. architecture, workflow and sequence diagrams, 2D/3D LLM visualisations, database schemas,
  38. dependency graphs, statecharts, agent traces, C4 models and timelines.
  39. - **Shows up in the chat.** Every client gets an inline image plus links to the rendered file and
  40. an editable playground. Clients with [MCP Apps](https://modelcontextprotocol.io/) also get an
  41. interactive viewer.
  42. - **Ready to run.** Hosted endpoints, or local with Docker or Helm; optional Entra ID / OAuth 2.1
  43. SSO, audit logs and metrics. It scores 95/100 on the Manufact publishing checklist.
  44. ## Quick start
  45. Add the hosted server to your MCP client:
  46. ```json
  47. "uml-mcp": {
  48. "transport": "http",
  49. "url": "https://uml-mcp.vercel.app/mcp"
  50. }
  51. ```
  52. Then ask, for example, *"Draw a sequence diagram of a user logging in through an API gateway."*
  53. | Endpoint | URL |
  54. | --- | --- |
  55. | Primary (Vercel) | `https://uml-mcp.vercel.app/mcp` |
  56. | Mirror (Manufact) | `https://uml-mcp.antoineboucher.info/mcp` |
  57. Ready-made configs: [Cursor](.cursor/mcp.json) · [VS Code / Copilot](.vscode/mcp.json) ·
  58. [Codex](.codex/config.toml) · [Claude Desktop](config/) · [Open WebUI](config/openwebui_mcp.json) ·
  59. [all clients](config/README.md). To run it yourself:
  60. ```bash
  61. uv tool install uml-mcp && uml-mcp setup
  62. ```
  63. The [installation guide](docs/installation.md) covers Docker, Helm and running from source.
  64. To explore all 15 interactive types from a checkout, use the
  65. [local viewer preview](docs/integrations/mcp-app.md#local-viewer-preview). Its compact
  66. example picker changes diagrams automatically and keeps export controls in the viewer.
  67. ## Kroki diagrams
  68. 37 types through [Kroki](https://kroki.io/): UML (PlantUML), Mermaid, D2, Graphviz, C4, BPMN,
  69. ERD, TikZ and more. Call `generate_uml` / `generate_uml_image` with the `diagram_type` under
  70. each thumbnail. Source examples live in [`examples/`](examples/) and at `uml://examples`;
  71. notation guides are in [Diagram types](docs/diagrams/index.md). Regenerate this gallery with
  72. `uv run python scripts/build_kroki_gallery.py`.
  73. | | | |
  74. | --- | --- | --- |
  75. | [![class](docs/assets/kroki/class.png)](docs/diagrams/uml.md)<br>`class` | [![sequence](docs/assets/kroki/sequence.png)](docs/diagrams/uml.md)<br>`sequence` | [![activity](docs/assets/kroki/activity.png)](docs/diagrams/uml.md)<br>`activity` |
  76. | [![usecase](docs/assets/kroki/usecase.png)](docs/diagrams/uml.md)<br>`usecase` | [![state](docs/assets/kroki/state.png)](docs/diagrams/uml.md)<br>`state` | [![component](docs/assets/kroki/component.png)](docs/diagrams/uml.md)<br>`component` |
  77. | [![deployment](docs/assets/kroki/deployment.png)](docs/diagrams/uml.md)<br>`deployment` | [![object](docs/assets/kroki/object.png)](docs/diagrams/uml.md)<br>`object` | [![plantuml](docs/assets/kroki/plantuml.png)](docs/diagrams/uml.md)<br>`plantuml` |
  78. | [![mermaid](docs/assets/kroki/mermaid.png)](docs/diagrams/mermaid.md)<br>`mermaid` | [![d2](docs/assets/kroki/d2.png)](docs/diagrams/d2.md)<br>`d2` | [![graphviz](docs/assets/kroki/graphviz.png)](docs/diagrams/graphviz.md)<br>`graphviz` |
  79. | [![erd](docs/assets/kroki/erd.png)](docs/diagrams/erd.md)<br>`erd` | [![c4plantuml](docs/assets/kroki/c4plantuml.png)](docs/diagrams/c4plantuml.md)<br>`c4plantuml` | [![bpmn](docs/assets/kroki/bpmn.png)](docs/diagrams/bpmn.md)<br>`bpmn` |
  80. | [![blockdiag](docs/assets/kroki/blockdiag.png)](docs/diagrams/blockdiag.md)<br>`blockdiag` | [![seqdiag](docs/assets/kroki/seqdiag.png)](docs/diagrams/blockdiag.md)<br>`seqdiag` | [![actdiag](docs/assets/kroki/actdiag.png)](docs/diagrams/blockdiag.md)<br>`actdiag` |
  81. | [![nwdiag](docs/assets/kroki/nwdiag.png)](docs/diagrams/blockdiag.md)<br>`nwdiag` | [![packetdiag](docs/assets/kroki/packetdiag.png)](docs/diagrams/blockdiag.md)<br>`packetdiag` | [![rackdiag](docs/assets/kroki/rackdiag.png)](docs/diagrams/blockdiag.md)<br>`rackdiag` |
  82. | [![dbml](docs/assets/kroki/dbml.png)](docs/diagrams/dbml.md)<br>`dbml` | [![structurizr](docs/assets/kroki/structurizr.png)](docs/diagrams/structurizr.md)<br>`structurizr` | [![tikz](docs/assets/kroki/tikz.png)](docs/diagrams/tikz.md)<br>`tikz` |
  83. | [![ditaa](docs/assets/kroki/ditaa.png)](docs/diagrams/specialty.md)<br>`ditaa` | [![nomnoml](docs/assets/kroki/nomnoml.png)](docs/diagrams/specialty.md)<br>`nomnoml` | [![svgbob](docs/assets/kroki/svgbob.png)](docs/diagrams/specialty.md)<br>`svgbob` |
  84. | [![goat](docs/assets/kroki/goat.png)](docs/diagrams/specialty.md)<br>`goat` | [![pikchr](docs/assets/kroki/pikchr.png)](docs/diagrams/specialty.md)<br>`pikchr` | [![excalidraw](docs/assets/kroki/excalidraw.png)](docs/diagrams/specialty.md)<br>`excalidraw` |
  85. | [![bytefield](docs/assets/kroki/bytefield.png)](docs/diagrams/specialty.md)<br>`bytefield` | [![wavedrom](docs/assets/kroki/wavedrom.png)](docs/diagrams/specialty.md)<br>`wavedrom` | [![wireviz](docs/assets/kroki/wireviz.png)](docs/diagrams/specialty.md)<br>`wireviz` |
  86. | [![symbolator](docs/assets/kroki/symbolator.png)](docs/diagrams/specialty.md)<br>`symbolator` | [![umlet](docs/assets/kroki/umlet.png)](docs/diagrams/specialty.md)<br>`umlet` | [![vega](docs/assets/kroki/vega.png)](docs/diagrams/specialty.md)<br>`vega` |
  87. | [![vegalite](docs/assets/kroki/vegalite.png)](docs/diagrams/specialty.md)<br>`vegalite` | [![wireviz](docs/assets/kroki/wireviz.png)](docs/diagrams/specialty.md)<br>`wireviz` | |
  88. ## Interactive diagrams
  89. The plugins below ship with UML-MCP and are on by default. Each type renders to an interactive HTML
  90. page in the viewer and to a static SVG and PNG everywhere else.
  91. | Plugin | Types | What you get |
  92. | --- | --- | --- |
  93. | [D3](docs/plugins/d3.md) | `d3_force` · `d3_architecture` · `d3_topology` | Force graphs and cloud diagrams with real provider and brand logos, routed with A\* |
  94. | [Stack diagram](docs/plugins/stack-diagram.md) | `stack_diagram` | Icon tiles, nested vendor and region groups, numbered request steps |
  95. | [Archify](docs/plugins/archify.md) | `archify_architecture` · `archify_workflow` · `archify_sequence` | Colour-coded groups, legend, three presets, click to focus and trace the shortest path |
  96. | [LLM visualizer](docs/plugins/llm-visualizer.md) | `llm_2d` · `llm_3d` | Layer maps, autoencoder and GAN shapes, `N×` blocks and a rotatable 3D scene |
  97. | [Database schema](docs/plugins/schema.md) | `db_schema` | ER diagrams from SQL DDL or JSON: column cards, crow's-foot keys at the column rows, search |
  98. | [Dependency graphs](docs/plugins/deps.md) | `dependency_graph` | A project's dependency tree from `package.json`, `pyproject.toml`, `requirements.txt` or a lock file |
  99. | [Statechart](docs/plugins/statechart.md) | `state_machine` | XState-like machines as statecharts, and a simulator that fires events, with a step log and Undo |
  100. | [Agent traces](docs/plugins/trace.md) | `agent_trace` | An agent run as a waterfall and a flow: LLM, tool and retrieval steps with tokens, cost, retries and the critical path |
  101. | [C4 model](docs/plugins/c4.md) | `c4_model` | One model, three C4 levels: click a system to open its containers, a container for its components |
  102. | [Timeline](docs/plugins/timeline.md) | `timeline` | Roadmaps with swimlanes, phases, milestones, releases and dependency arrows; zoom from quarters to days |
  103. Each image links to the plugin guide. The [complete smoke-test prompt](tests/prompts/all_interactive_plugins_smoke_test.md)
  104. covers every type, both themes, browser interactions and file exports.
  105. | | | |
  106. | --- | --- | --- |
  107. | [![D3 force graph](docs/assets/interactive/d3_force.png)](docs/plugins/d3.md)<br>`d3_force` | [![D3 cloud architecture](docs/assets/interactive/d3_architecture.png)](docs/plugins/d3.md)<br>`d3_architecture` | [![D3 network topology](docs/assets/interactive/d3_topology.png)](docs/plugins/d3.md)<br>`d3_topology` |
  108. | [![Stack diagram](docs/assets/interactive/stack_diagram.png)](docs/plugins/stack-diagram.md)<br>`stack_diagram` | [![Archify architecture](docs/assets/interactive/archify_architecture.png)](docs/plugins/archify.md)<br>`archify_architecture` | [![Archify workflow](docs/assets/interactive/archify_workflow.png)](docs/plugins/archify.md)<br>`archify_workflow` |
  109. | [![Archify sequence](docs/assets/interactive/archify_sequence.png)](docs/plugins/archify.md)<br>`archify_sequence` | [![LLM layer map in 2D](docs/assets/interactive/llm_2d.png)](docs/plugins/llm-visualizer.md)<br>`llm_2d` | [![LLM layers in 3D](docs/assets/interactive/llm_3d.png)](docs/plugins/llm-visualizer.md)<br>`llm_3d` |
  110. | [![Database schema](docs/assets/interactive/db_schema.png)](docs/plugins/schema.md)<br>`db_schema` | [![Project dependency graph](docs/assets/interactive/dependency_graph.png)](docs/plugins/deps.md)<br>`dependency_graph` | [![Statechart](docs/assets/interactive/state_machine.png)](docs/plugins/statechart.md)<br>`state_machine` |
  111. | [![Agent trace waterfall](docs/assets/interactive/agent_trace.png)](docs/plugins/trace.md)<br>`agent_trace` | [![C4 system context](docs/assets/interactive/c4_model.png)](docs/plugins/c4.md)<br>`c4_model` | [![Project timeline](docs/assets/interactive/timeline.png)](docs/plugins/timeline.md)<br>`timeline` |
  112. ```json
  113. {
  114. "title": "SaaS stack",
  115. "groups": [{"id": "vercel", "name": "Vercel", "icon": "vercel"}],
  116. "nodes": [
  117. {"id": "user", "name": "User", "icon": "user"},
  118. {"id": "web", "name": "Next.js", "icon": "browser", "group": "vercel"},
  119. {"id": "db", "name": "Neon", "icon": "database"},
  120. {"id": "ci", "name": "GitHub Actions"}
  121. ],
  122. "edges": [
  123. {"from": "user", "to": "web", "label": "HTTPS", "step": 1},
  124. {"from": "web", "to": "db", "label": "SQL", "step": 2},
  125. {"from": "ci", "to": "web", "label": "deploy", "style": "dashed"}
  126. ]
  127. }
  128. ```
  129. Send that as `stack_diagram` and you get the GitHub and Vercel logos, two numbered steps and a
  130. dashed deploy edge. The [plugins guide](docs/plugins/index.md) has example prompts for every type
  131. and shows how to [write your own](docs/plugins/authoring.md).
  132. ## Tools
  133. | Tool | Purpose |
  134. | --- | --- |
  135. | `generate_uml` | Render one diagram: image, URL and playground link |
  136. | `generate_uml_image` | The same as an inline chat image (PNG by default) |
  137. | `validate_uml` | Check source before rendering; errors say how to fix it |
  138. | `list_diagram_types` | The live catalog, including plugin types |
  139. | `generate_uml_batch` | Many diagrams in one call |
  140. Resources (`uml://types`, `uml://examples`, `uml://templates`...), prompts and skills
  141. (`skill://uml-mcp-diagrams/SKILL.md` plus focused guides) are listed in the
  142. [reference](docs/reference/index.md).
  143. ## Documentation
  144. | Topic | Where |
  145. | --- | --- |
  146. | Getting started and tutorials | [Tutorials](docs/tutorials/index.md) |
  147. | Diagram types and notation | [Diagram types](docs/diagrams/index.md) |
  148. | Clients, Docker, Helm, Vercel | [Deploy](docs/deploy/index.md) |
  149. | MCP App viewer and publishing | [MCP App](docs/integrations/mcp-app.md) |
  150. | Configuration (`uml-mcp.yaml`) | [Configuration](docs/configuration/uml-mcp-yaml.md) |
  151. | Enterprise SSO, audit, metrics | [Enterprise](docs/enterprise/README.md) |
  152. | Plugins | [Plugins](docs/plugins/index.md) |
  153. | Admin console | [Admin](docs/admin/index.md) |
  154. ## Development
  155. ```bash
  156. uv sync --all-groups
  157. uv run pytest
  158. uv run ruff check . && uv run ty check
  159. uv run uml-mcp lint --strict --min-grade A
  160. ```
  161. About 1,800 tests, including browser tests of every interactive page inside the MCP App viewer.
  162. See [Testing](docs/testing.md) and [CONTRIBUTING.md](CONTRIBUTING.md).
  163. ## License
  164. [MIT](LICENSE). Maintained by [Antoine Boucher](https://github.com/antoinebou12). Built on
  165. [PlantUML](https://plantuml.com/), [Kroki](https://kroki.io/), [Mermaid](https://mermaid.js.org/),
  166. [D2](https://d2lang.com/) and [D3](https://d3js.org/). Brand logos come from
  167. [LobeHub Icons](https://github.com/lobehub/lobe-icons) (MIT) and remain trademarks of their owners.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.