Skip to main content
Glama

Create a diagram

create_diagram

Creates a diagram in a workspace (requires editor access and at least the write permission there; permission is in list_workspaces). workspaceId may be left out when the connection can write to only one workspace. Optionally adds initial content in the same call, one of: ops (same rules as apply_ops; temporary "$" ids are returned in idMap), a Mermaid flowchart (same as compose_diagram: types / layout / direction; returns nodeIds, groupIds and edgeIds), or an infographic spec (same as compose_diagram infographic: returns posterId, nodeIds, blocks, quota and layout; the diagram font is set to the theme’s font). There is no dryRun: every call creates a diagram (compose_diagram dryRun with preview checks a drawing on an existing diagram without writing). The plan’s diagram limit applies (Free: 3 diagrams).

Input Schema

NameRequiredDescriptionDefault
opsNo
titleNo
typesNoMaps Mermaid node ids, subgraph ids, classes (":::name" / "class A name") or "@shape" (e.g. "@cylinder") to node types from search_node_types (e.g. {"db":"cloud.database","vpc":"network.vpc"}). A subgraph takes a container type (network.vpc, k8s.namespace, cloud.region, c4.system-boundary…). Unmapped nodes become core.box (non-rectangular Mermaid shapes become core.shape), unmapped subgraphs core.frame. Edges between mindmap.* or org.* nodes become mind-map branches / reporting lines.
layoutNoLayout engine (default layered).
mermaidNoMermaid source: a flowchart ("flowchart LR" / "graph TD", subgraphs included), or a pie, xychart, timeline, quadrantChart or venn-beta chart, which is drawn as one infographic block. Other Mermaid diagram kinds are not supported; the error names the Archboard node types to use instead.
directionNoFlow direction; overrides the Mermaid header. "auto" keeps the header direction unless the drawing gets much wider than tall (or taller than wide), then uses the other one; the result says which.
infographicNoInfographic spec: theme + blocks; the server measures and lays the blocks out on a 12-column poster. Read read_me topic "infographics".
workspaceIdNoWorkspace id from list_workspaces; optional when this connection can write to only one workspace.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations (readOnly=false, idempotent=false), the description discloses permission requirements, the absence of dryRun, the plan diagram limit (Free: 3), and per-mode return shapes (idMap, nodeIds/groupIds/edgeIds, posterId/blocks/quota/layout). That is substantial context the structured fields do not carry.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The single dense paragraph is front-loaded with the create action and permission gate, then enumerates the three content modes. It is long, but nearly every clause carries a distinct constraint or cross-reference, so little is wasted.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a no-required-param, nested-schema creation tool with no output schema, the description covers prerequisites, optionality, the three mutually exclusive content paths and their return payloads, error behavior for unsupported Mermaid, and quota limits. Nothing an agent needs to call it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 75%, and the description meaningfully extends it: ops follow apply_ops rules with temporary '$' ids surfaced in idMap, Mermaid input follows compose_diagram semantics, and the infographic font is forced to the theme's font. Minor parameters like title and mermaid syntax are left to the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb and resource ('Creates a diagram in a workspace') and immediately distinguishes itself from compose_diagram and apply_ops by explaining that initial content can be supplied inline. An agent can tell exactly what this tool produces versus its siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

States the access prerequisites (editor access plus write permission, discoverable via list_workspaces), explains when workspaceId can be omitted, and explicitly contrasts with compose_diagram's dryRun preview path. It also flags that every call is a real write, which is the key usage decision.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.