@drawio/mcp 1.2.0 → 1.2.2

package/README.md

@@ -59,6 +59,25 @@ Add to your Claude Desktop configuration file:
 }
 ```
 
+### Claude Code
+
+```bash
+claude mcp add drawio -- npx -y @drawio/mcp
+```
+
+Or manually in `.claude/settings.json`:
+
+```json
+{
+  "mcpServers": {
+    "drawio": {
+      "command": "npx",
+      "args": ["-y", "@drawio/mcp"]
+    }
+  }
+}
+```
+
 ### Other MCP Clients
 
 Configure your MCP client to run the server via stdio:
@@ -116,6 +135,8 @@ Opens the draw.io editor with a Mermaid.js diagram.
 4. The URL is returned to the LLM, which can present it to the user
 5. Opening the URL loads draw.io with the diagram ready to view/edit
 
+The `open_drawio_xml` tool description includes the full XML generation reference (edge routing, containers, layers, tags, metadata, dark mode, etc.) loaded from [`shared/xml-reference.md`](../shared/xml-reference.md) — the single source of truth for all draw.io MCP prompts. A `prepack` script bundles this file into the npm package so it works after `npm install`.
+
 ## Related Resources
 
 - [draw.io](https://www.draw.io) - Free online diagram editor

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drawio/mcp",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Official draw.io MCP server for LLMs - Open diagrams in draw.io editor",
   "type": "module",
   "main": "src/index.js",
@@ -8,7 +8,8 @@
     "drawio-mcp": "./src/index.js"
   },
   "scripts": {
-    "start": "node src/index.js"
+    "start": "node src/index.js",
+    "prepack": "cp ../shared/xml-reference.md src/xml-reference.md"
   },
   "keywords": [
     "mcp",

package/src/index.js

@@ -5,12 +5,24 @@ import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"
 import { ListToolsRequestSchema, CallToolRequestSchema } from "@modelcontextprotocol/sdk/types.js";
 import pako from "pako";
 import { spawn } from "child_process";
-import { writeFileSync, unlinkSync } from "fs";
-import { join } from "path";
+import { existsSync, readFileSync, writeFileSync, unlinkSync } from "fs";
+import { join, dirname } from "path";
+import { fileURLToPath } from "url";
 import { tmpdir } from "os";
 
+const __dirname = dirname(fileURLToPath(import.meta.url));
 const DRAWIO_BASE_URL = "https://app.diagrams.net/";
 
+// Read the shared XML reference once at startup (single source of truth).
+// In the repo: read from shared/. When installed via npm: read from the
+// local copy created by the prepack script.
+const sharedPath = join(__dirname, "..", "..", "shared", "xml-reference.md");
+const localPath = join(__dirname, "xml-reference.md");
+const xmlReference = readFileSync(
+  existsSync(sharedPath) ? sharedPath : localPath,
+  "utf-8"
+);
+
 /**
  * Opens a URL in the default browser (cross-platform)
  */
@@ -121,26 +133,8 @@ const tools =
     description:
       "Opens the draw.io editor with a diagram from XML content. " +
       "Use this to view, edit, or create diagrams in draw.io format. " +
-      "The XML should be valid draw.io/mxGraph XML format. " +
-      "IMPORTANT: Do NOT include ANY XML comments (<!-- -->) in the output — they are strictly forbidden. " +
-      "EDGE GEOMETRY: Every edge mxCell MUST contain a <mxGeometry relative=\"1\" as=\"geometry\" /> child element, even when there are no waypoints. Self-closing edge cells (<mxCell ... edge=\"1\" ... />) are invalid and will not render correctly. " +
-      "EDGE ROUTING: Use edgeStyle=orthogonalEdgeStyle for right-angle connectors. " +
-      "Space nodes at least 60px apart to avoid overlapping edges. " +
-      "Use exitX/exitY/entryX/entryY (0-1) to control which side of a node an edge connects to, spreading connections across different sides. " +
-      "Add explicit waypoints via <Array as=\"points\"><mxPoint x=\"...\" y=\"...\"/></Array> inside mxGeometry when edges would overlap. " +
-      "ARROWHEAD CLEARANCE: The final straight segment of an edge (between the last bend and the target, or source and first bend) must be long enough to fit the arrowhead (default size 6, configurable via startSize/endSize). If too short, the arrowhead overlaps the bend. Ensure at least 20px of straight segment. The orthogonal auto-router can place bends too close to shapes when nodes are nearly aligned - fix by increasing spacing or adding explicit waypoints. " +
-      "CONTAINERS: For architecture diagrams and any diagram with nested elements, use proper parent-child containment (set parent=\"containerId\" on children, use relative coordinates). " +
-      "Container types: (1) group style (style=\"group;\") for invisible containers with no connections - includes pointerEvents=0 so child connections are not captured by the container; " +
-      "(2) swimlane style (style=\"swimlane;startSize=30;\") for labeled containers with a title bar - use when the container needs visual borders/headers or when the container itself has connections; " +
-      "(3) any shape can be a container by adding container=1 to its style, but also add pointerEvents=0 unless the container itself needs to be connectable. " +
-      "Always use pointerEvents=0 on container styles that should not capture connections being rewired between children. " +
-      "EDGE LABELS: Do NOT wrap edge labels in HTML markup to reduce font size. The default font size for edge labels is already 11px (vs 12px for vertices), so they are already smaller. Just set the value attribute directly. " +
-      "LAYOUT: Align nodes to a grid (multiples of 10). Use consistent spacing (e.g., 200px horizontal, 120px vertical between nodes). " +
-      "DARK MODE COLORS: To enable dark mode color adaptation, the mxGraphModel element must include adaptiveColors=\"auto\". " +
-      "strokeColor, fillColor, and fontColor default to 'default', which renders as black in light theme and white in dark theme. " +
-      "Explicit colors (e.g. fillColor=#DAE8FC) specify the light-mode color; the dark-mode color is computed automatically by inverting RGB values and rotating the hue 180 degrees. " +
-      "To specify both colors explicitly, use light-dark(lightColor,darkColor) in the style string, e.g. fontColor=light-dark(#7EA6E0,#FF0000). " +
-      "See https://www.drawio.com/doc/faq/drawio-style-reference.html for the complete style reference.",
+      "The XML should be valid draw.io/mxGraph XML format.\n\n" +
+      xmlReference,
     inputSchema:
     {
       type: "object",
@@ -283,6 +277,25 @@ server.setRequestHandler(CallToolRequestSchema, async (request) =>
       };
     }
 
+    if (typeof inputContent !== "string")
+    {
+      const actualType = typeof inputContent;
+      const preview = JSON.stringify(inputContent).substring(0, 200);
+
+      return {
+        content:
+        [
+          {
+            type: "text",
+            text: `Error: content parameter must be a string, but received ${actualType}: ${preview}\n\n` +
+              "Common mistake: passing a JSON object or nested structure instead of a plain string. " +
+              "Make sure the diagram content (XML, CSV, or Mermaid) is passed directly as a string value.",
+          },
+        ],
+        isError: true,
+      };
+    }
+
     content = inputContent;
 
     switch (name)

package/src/xml-reference.md

@@ -0,0 +1,253 @@
+# draw.io XML Reference
+
+Detailed reference for styles, edge routing, containers, layers, tags, metadata, and dark mode. Consult this when generating draw.io XML diagrams.
+
+## General principles
+
+- **Use proper draw.io shapes and connectors** — choose the semantically correct shape for each element (e.g., `shape=cylinder3` for databases and tanks, `rhombus` for decisions, `shape=mxgraph.pid2valves.*` for valves in P&IDs). draw.io has extensive shape libraries; prefer domain-appropriate shapes over generic rectangles.
+- **Decide whether to search for shapes** — before generating a diagram, decide if it needs domain-specific shapes from draw.io's extended libraries. **Skip `search_shapes`** for standard diagram types that use basic geometric shapes: flowcharts, UML (class, sequence, state, activity), ERD, org charts, mind maps, Venn diagrams, timelines, wireframes, and any diagram using only rectangles, diamonds, circles, cylinders, and arrows. Also skip if the user explicitly asks to use basic/simple shapes or says not to search. **Use `search_shapes`** when the diagram requires industry-specific or branded icons: cloud architecture (AWS, Azure, GCP), network topology (Cisco, rack equipment), P&ID (valves, instruments, vessels), electrical/circuit diagrams, Kubernetes, BPMN with specific task types, or any domain where the user expects realistic/standardized symbols rather than labeled boxes.
+- **Match the language of labels to the user's language** — if the user writes in German, French, Japanese, etc., all diagram labels, titles, and annotations should be in that same language.
+
+## Common styles
+
+**Rounded rectangle:**
+```xml
+<mxCell id="2" value="Label" style="rounded=1;whiteSpace=wrap;" vertex="1" parent="1">
+  <mxGeometry x="100" y="100" width="120" height="60" as="geometry"/>
+</mxCell>
+```
+
+**Diamond (decision):**
+```xml
+<mxCell id="3" value="Condition?" style="rhombus;whiteSpace=wrap;" vertex="1" parent="1">
+  <mxGeometry x="100" y="200" width="120" height="80" as="geometry"/>
+</mxCell>
+```
+
+**Arrow (edge):**
+```xml
+<mxCell id="4" value="" style="edgeStyle=orthogonalEdgeStyle;" edge="1" source="2" target="3" parent="1">
+  <mxGeometry relative="1" as="geometry"/>
+</mxCell>
+```
+
+**Labeled arrow:**
+```xml
+<mxCell id="5" value="Yes" style="edgeStyle=orthogonalEdgeStyle;" edge="1" source="3" target="6" parent="1">
+  <mxGeometry relative="1" as="geometry"/>
+</mxCell>
+```
+
+## Style properties
+
+| Property | Values | Use for |
+|----------|--------|---------|
+| `rounded=1` | 0 or 1 | Rounded corners |
+| `whiteSpace=wrap` | wrap | Text wrapping |
+| `fillColor=#dae8fc` | Hex color | Background color |
+| `strokeColor=#6c8ebf` | Hex color | Border color |
+| `fontColor=#333333` | Hex color | Text color |
+| `shape=cylinder3` | shape name | Database cylinders |
+| `shape=mxgraph.flowchart.document` | shape name | Document shapes |
+| `ellipse` | style keyword | Circles/ovals |
+| `rhombus` | style keyword | Diamonds |
+| `edgeStyle=orthogonalEdgeStyle` | style keyword | Right-angle connectors |
+| `edgeStyle=elbowEdgeStyle` | style keyword | Elbow connectors |
+| `dashed=1` | 0 or 1 | Dashed lines |
+| `swimlane` | style keyword | Swimlane containers |
+| `group` | style keyword | Invisible container (pointerEvents=0) |
+| `container=1` | 0 or 1 | Enable container behavior on any shape |
+| `pointerEvents=0` | 0 or 1 | Prevent container from capturing child connections |
+
+## Edge routing
+
+**CRITICAL: Every edge `mxCell` must contain a `<mxGeometry relative="1" as="geometry" />` child element**, even when there are no waypoints. Self-closing edge cells (e.g. `<mxCell ... edge="1" ... />`) are invalid and will not render correctly. Always use the expanded form:
+```xml
+<mxCell id="e1" edge="1" parent="1" source="a" target="b" style="...">
+  <mxGeometry relative="1" as="geometry" />
+</mxCell>
+```
+
+draw.io does **not** have built-in collision detection for edges. Plan layout and routing carefully:
+
+- Use `edgeStyle=orthogonalEdgeStyle` for right-angle connectors (most common)
+- **Space nodes generously** — at least 60px apart, prefer 200px horizontal / 120px vertical gaps
+- Use `exitX`/`exitY` and `entryX`/`entryY` (values 0-1) to control which side of a node an edge connects to. Spread connections across different sides to prevent overlap
+- **Leave room for arrowheads**: The final straight segment of an edge (between the last bend and the target shape, or between the source shape and the first bend) must be long enough to fit the arrowhead. The default arrow size is 6px (configurable via `startSize`/`endSize` styles). If the final segment is too short, the arrowhead overlaps the bend and looks broken. Ensure at least 20px of straight segment before the target and after the source when placing waypoints or positioning nodes
+- When using `orthogonalEdgeStyle`, the auto-router places bends automatically — if source and target are close together or nearly aligned on one axis, the router may place a bend very close to a shape, leaving no room for the arrow. Fix this by either increasing node spacing or adding explicit waypoints that keep the final segment long enough
+- Add explicit **waypoints** when edges would overlap:
+  ```xml
+  <mxCell id="e1" style="edgeStyle=orthogonalEdgeStyle;" edge="1" parent="1" source="a" target="b">
+    <mxGeometry relative="1" as="geometry">
+      <Array as="points">
+        <mxPoint x="300" y="150"/>
+        <mxPoint x="300" y="250"/>
+      </Array>
+    </mxGeometry>
+  </mxCell>
+  ```
+- Use `rounded=1` on edges for cleaner bends
+- Use `jettySize=auto` for better port spacing on orthogonal edges
+- Align all nodes to a grid (multiples of 10)
+- **Edge labels**: Do NOT wrap edge labels in HTML markup to reduce font size. The default font size for edge labels is already 11px (vs 12px for vertices), so they are already smaller. Just set the `value` attribute directly.
+
+## Containers and groups
+
+For architecture diagrams or any diagram with nested elements, use draw.io's proper parent-child containment — do **not** just place shapes on top of larger shapes.
+
+### How containment works
+
+Set `parent="containerId"` on child cells. Children use **relative coordinates** within the container.
+
+### Container types
+
+| Type | Style | When to use |
+|------|-------|-------------|
+| **Group** (invisible) | `group;` | No visual border needed, container has no connections. Includes `pointerEvents=0` so child connections are not captured |
+| **Swimlane** (titled) | `swimlane;startSize=30;` | Container needs a visible title bar/header, or the container itself has connections |
+| **Custom container** | Add `container=1;pointerEvents=0;` to any shape style | Any shape acting as a container without its own connections |
+
+### Key rules
+
+- **Always add `pointerEvents=0;`** to container styles that should not capture connections being rewired between children
+- Only omit `pointerEvents=0` when the container itself needs to be connectable — in that case, use `swimlane` style which handles this correctly (the client area is transparent for mouse events while the header remains connectable)
+- Children must set `parent="containerId"` and use coordinates **relative to the container**
+
+### Example: Architecture container with swimlane
+
+```xml
+<mxCell id="svc1" value="User Service" style="swimlane;startSize=30;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
+  <mxGeometry x="100" y="100" width="300" height="200" as="geometry"/>
+</mxCell>
+<mxCell id="api1" value="REST API" style="rounded=1;whiteSpace=wrap;" vertex="1" parent="svc1">
+  <mxGeometry x="20" y="40" width="120" height="60" as="geometry"/>
+</mxCell>
+<mxCell id="db1" value="Database" style="shape=cylinder3;whiteSpace=wrap;" vertex="1" parent="svc1">
+  <mxGeometry x="160" y="40" width="120" height="60" as="geometry"/>
+</mxCell>
+```
+
+### Example: Invisible group container
+
+```xml
+<mxCell id="grp1" value="" style="group;" vertex="1" parent="1">
+  <mxGeometry x="100" y="100" width="300" height="200" as="geometry"/>
+</mxCell>
+<mxCell id="c1" value="Component A" style="rounded=1;whiteSpace=wrap;" vertex="1" parent="grp1">
+  <mxGeometry x="10" y="10" width="120" height="60" as="geometry"/>
+</mxCell>
+```
+
+## Layers
+
+Layers control visibility and z-order. Every cell belongs to exactly one layer. Use layers to manage diagram complexity — viewers can toggle layer visibility to show or hide groups of elements (e.g., "Physical Infrastructure" vs "Logical Network" vs "Security Zones").
+
+Cell `id="0"` is the root and cell `id="1"` is the default layer — both always exist. Additional layers are `mxCell` elements with `parent="0"`:
+
+```xml
+<mxGraphModel>
+  <root>
+    <mxCell id="0"/>
+    <mxCell id="1" parent="0"/>
+    <mxCell id="2" value="Annotations" parent="0"/>
+    <mxCell id="10" value="Server" style="rounded=1;" vertex="1" parent="1">
+      <mxGeometry x="100" y="100" width="120" height="60" as="geometry"/>
+    </mxCell>
+    <mxCell id="20" value="Note: deprecated" style="text;" vertex="1" parent="2">
+      <mxGeometry x="100" y="170" width="120" height="30" as="geometry"/>
+    </mxCell>
+  </root>
+</mxGraphModel>
+```
+
+- A layer is an `mxCell` with `parent="0"` and no `vertex` or `edge` attribute
+- Assign shapes to a layer by setting `parent` to the layer's id
+- Later layers render on top of earlier layers (higher z-order)
+- Add `visible="0"` as an attribute on the layer cell to hide it by default
+- Use layers when the diagram has distinct conceptual groupings that viewers may want to toggle independently
+
+## Tags
+
+Tags are visual filters that let viewers show or hide elements by category. Unlike layers, a single element can have multiple tags, making tags ideal for cross-cutting concerns (e.g., tagging shapes as "critical", "v2", or "backend").
+
+Tags require wrapping `mxCell` in an `<object>` element. Tags are assigned via the `tags` attribute as a space-separated string:
+
+```xml
+<mxGraphModel>
+  <root>
+    <mxCell id="0"/>
+    <mxCell id="1" parent="0"/>
+    <object id="2" label="Auth Service" tags="critical v2">
+      <mxCell style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+        <mxGeometry x="100" y="100" width="120" height="60" as="geometry"/>
+      </mxCell>
+    </object>
+    <object id="3" label="Legacy API" tags="critical deprecated">
+      <mxCell style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+        <mxGeometry x="300" y="100" width="120" height="60" as="geometry"/>
+      </mxCell>
+    </object>
+  </root>
+</mxGraphModel>
+```
+
+- Tags require the `<object>` wrapper — a plain `mxCell` cannot have tags
+- The `label` attribute on `<object>` replaces `value` on `mxCell`
+- Tags are space-separated in the `tags` attribute
+- Viewers filter the diagram by selecting tags in the draw.io UI (Edit > Tags)
+- Tags do not affect z-order or structural grouping — they are purely a visibility filter
+
+## Metadata and placeholders
+
+Metadata stores custom key-value properties on shapes as additional attributes on the `<object>` wrapper element. Combined with placeholders, metadata values can be displayed in labels — useful for data-driven diagrams showing status, owner, IP addresses, or versions on each shape.
+
+Set `placeholders="1"` on the `<object>` to enable `%propertyName%` substitution in the `label`:
+
+```xml
+<mxGraphModel>
+  <root>
+    <mxCell id="0"/>
+    <mxCell id="1" parent="0"/>
+    <object id="2" label="&lt;b&gt;%component%&lt;/b&gt;&lt;br&gt;Owner: %owner%&lt;br&gt;Status: %status%"
+            placeholders="1" component="Auth Service" owner="Team Backend" status="Active">
+      <mxCell style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+        <mxGeometry x="100" y="100" width="160" height="80" as="geometry"/>
+      </mxCell>
+    </object>
+  </root>
+</mxGraphModel>
+```
+
+- Custom properties are plain XML attributes on `<object>` (e.g., `component="Auth Service"`)
+- Set `placeholders="1"` to enable `%key%` substitution in the label and tooltip
+- The label must use `html=1` style when using HTML formatting with placeholders
+- Placeholders resolve by walking up the containment hierarchy: shape attributes first, then parent container, then layer, then root — first match wins
+- Predefined placeholders work without custom properties: `%id%`, `%width%`, `%height%`, `%date%`, `%time%`, `%timestamp%`, `%page%`, `%pagenumber%`, `%pagecount%`, `%filename%`
+- Use `%%` for a literal percent sign in labels
+- Tags, metadata, and placeholders can all be combined on the same `<object>` element
+- Use metadata when shapes represent data records (servers, services, components) and you want to attach structured information beyond the visible label
+
+## Dark mode colors
+
+draw.io supports automatic dark mode rendering. How colors behave depends on the property:
+
+- **`strokeColor`, `fillColor`, `fontColor`** default to `"default"`, which renders as black in light theme and white in dark theme. When no explicit color is set, colors adapt automatically.
+- **Explicit colors** (e.g. `fillColor=#DAE8FC`) specify the light-mode color. The dark-mode color is computed automatically by inverting the RGB values (blending toward the inverse at 93%) and rotating the hue by 180° (via `mxUtils.getInverseColor`).
+- **`light-dark()` function** — To specify both colors explicitly, use `light-dark(lightColor,darkColor)` in the style string, e.g. `fontColor=light-dark(#7EA6E0,#FF0000)`. The first argument is used in light mode, the second in dark mode.
+
+To enable dark mode color adaptation, the `mxGraphModel` element must include `adaptiveColors="auto"`.
+
+When generating diagrams, you generally do not need to specify dark-mode colors — the automatic inversion handles most cases. Use `light-dark()` only when the automatic inverse color is unsatisfactory.
+
+## Style reference
+
+Complete style reference (all shape types, style properties, color palettes, HTML labels, and more): https://github.com/jgraph/drawio-mcp/blob/main/shared/drawio-style-reference.md
+
+XML Schema (XSD): https://github.com/jgraph/drawio-mcp/blob/main/shared/mxfile.xsd
+
+## CRITICAL: XML well-formedness
+
+When generating draw.io XML, the output **must** be well-formed XML:
+- **NEVER include ANY XML comments (`<!-- -->`) in the output.** XML comments are strictly forbidden — they waste tokens, can cause parse errors, and serve no purpose in diagram XML.
+- Escape special characters in attribute values: `&amp;`, `&lt;`, `&gt;`, `&quot;`
+- Always use unique `id` values for each `mxCell`