livediagram

Read + visualise a document (deprecated)

read_diagram

Read-only

Deprecated: use read_document instead; this name is removed on 2027-04-30. It takes the same input as read_document.

Input Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Output Schema

TableJSON Schema

Name	Required	Description
`id`	Yes	The document id.
`tab`	Yes	The tab that was read.
`url`	Yes	Link that opens the document in the livediagram editor.
`name`	Yes	The document name.
`tabs`	Yes	Every tab of the document, in order: pass one as tabId to read it.

Schema Changelog

Changes observed during successful MCP inspections.

Changed15 schema fields changedOct 16, 2026

addedInput schema / additionalProperties
```
Added value: +{}
```

removedInput schema / properties / all

Removed value: -{
-  "description": "comments: include resolved threads.",
-  "type": "boolean"
-}

removedInput schema / properties / budget

Removed value: -{
-  "description": "Fit the view to about this many tokens (default 8000); the last line says what was left out and how to see it.",
-  "maximum": 1000000,
-  "minimum": 1,
-  "type": "integer"
-}

removedInput schema / properties / coarse

Removed value: -{
-  "description": "layout: rows per frame instead of coordinates.",
-  "type": "boolean"
-}

removedInput schema / properties / documentId

Removed value: -{
-  "description": "The document id (from find_documents).",
-  "type": "string"
-}

removedInput schema / properties / format

Removed value: -{
-  "description": "view (default) returns the text view; json returns the tab's elements as stored.",
-  "enum": [
-    "view",
-    "json"
-  ],
-  "type": "string"
-}

removedInput schema / properties / image

Removed value: -{
-  "description": "Also attach a PNG preview of the tab (costs about a thousand tokens). An Illustrate tab draws as its pages, each as it exports: its background, what reaches onto it, cut at its edges.",
-  "type": "boolean"
-}

removedInput schema / properties / only

Removed value: -{
-  "description": "outline, layout: one element (a ref from a view) and what nests under it.",
-  "maxLength": 256,
-  "minLength": 1,
-  "type": "string"
-}

removedInput schema / properties / page

Removed value: -{
-  "anyOf": [
-    {
-      "type": "string"
-    },
-    {
-      "maximum": 9007199254740991,
-      "minimum": 1,
-      "type": "integer"
-    }
-  ],
-  "description": "With image, on an Illustrate tab: draw only this page, at its own size (its id, its place 1 first, or its name). Without it every page is drawn, in rows."
-}

removedInput schema / properties / q

Removed value: -{
-  "description": "find: the text to look for, case-insensitive.",
-  "maxLength": 200,
-  "minLength": 1,
-  "type": "string"
-}

removedInput schema / properties / ref

Removed value: -{
-  "description": "show: the element, by the ref a view printed, any unique prefix, or its id.",
-  "maxLength": 256,
-  "minLength": 1,
-  "type": "string"
-}

removedInput schema / properties / style

Removed value: -{
-  "description": "outline: add the colours and line styles that differ from the defaults.",
-  "type": "boolean"
-}

removedInput schema / properties / tabId

Removed value: -{
-  "description": "Which tab to read; defaults to the first.",
-  "type": "string"
-}

removedInput schema / properties / view

Removed value: -{
-  "description": "How to read the tab. outline (default): one line per element with its ref, label and arrows, nested by frame. graph: what connects to what. layout: where things sit. comments: open threads in full. show: one element in full (needs ref). find: elements holding some text (needs q). pages: an Illustrate tab's pages with their rectangles, each article as Markdown, and the layouts on offer.",
-  "enum": [
-    "outline",
-    "graph",
-    "layout",
-    "comments",
-    "show",
-    "find",
-    "pages"
-  ],
-  "type": "string"
-}

removedInput schema / required
```
Removed value: -[
-  "documentId"
-]
```

Changed2 schema fields changedOct 14, 2026

changedInput schema / properties / image / description

Previous value: -"Also attach a PNG preview of the tab (costs about a thousand tokens)."New value: +"Also attach a PNG preview of the tab (costs about a thousand tokens). An Illustrate tab draws as its pages, each as it exports: its background, what reaches onto it, cut at its edges."

addedInput schema / properties / page

Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "maximum": 9007199254740991,
+      "minimum": 1,
+      "type": "integer"
+    }
+  ],
+  "description": "With image, on an Illustrate tab: draw only this page, at its own size (its id, its place 1 first, or its name). Without it every page is drawn, in rows."
+}

Changed2 schema fields changedOct 10, 2026

changedInput schema / properties / view / description

Previous value: -"How to read the tab. outline (default): one line per element with its ref, label and arrows, nested by frame. graph: what connects to what. layout: where things sit. comments: open threads in full. show: one element in full (needs ref). find: elements holding some text (needs q)."New value: +"How to read the tab. outline (default): one line per element with its ref, label and arrows, nested by frame. graph: what connects to what. layout: where things sit. comments: open threads in full. show: one element in full (needs ref). find: elements holding some text (needs q). pages: an Illustrate tab's pages with their rectangles, each article as Markdown, and the layouts on offer."

changedInput schema / properties / view / enum

Previous value: -[
-  "outline",
-  "graph",
-  "layout",
-  "comments",
-  "show",
-  "find"
-]New value: +[
+  "outline",
+  "graph",
+  "layout",
+  "comments",
+  "show",
+  "find",
+  "pages"
+]

Changed2 schema fields changedOct 8, 2026

addedOutput schema / properties / tabs

Added value: +{
+  "description": "Every tab of the document, in order: pass one as tabId to read it.",
+  "items": {
+    "additionalProperties": false,
+    "properties": {
+      "id": {
+        "description": "The tab id.",
+        "type": "string"
+      },
+      "name": {
+        "description": "The tab name.",
+        "type": "string"
+      }
+    },
+    "required": [
+      "id",
+      "name"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}

changedOutput schema / required

Previous value: -[
-  "id",
-  "name",
-  "tab",
-  "url"
-]New value: +[
+  "id",
+  "name",
+  "tab",
+  "tabs",
+  "url"
+]

Changed14 schema fields changedOct 4, 2026

addedInput schema / properties / all

Added value: +{
+  "description": "comments: include resolved threads.",
+  "type": "boolean"
+}

addedInput schema / properties / budget

Added value: +{
+  "description": "Fit the view to about this many tokens (default 8000); the last line says what was left out and how to see it.",
+  "maximum": 1000000,
+  "minimum": 1,
+  "type": "integer"
+}

addedInput schema / properties / coarse

Added value: +{
+  "description": "layout: rows per frame instead of coordinates.",
+  "type": "boolean"
+}

addedInput schema / properties / format

Added value: +{
+  "description": "view (default) returns the text view; json returns the tab's elements as stored.",
+  "enum": [
+    "view",
+    "json"
+  ],
+  "type": "string"
+}

addedInput schema / properties / image

Added value: +{
+  "description": "Also attach a PNG preview of the tab (costs about a thousand tokens).",
+  "type": "boolean"
+}

addedInput schema / properties / only

Added value: +{
+  "description": "outline, layout: one element (a ref from a view) and what nests under it.",
+  "maxLength": 256,
+  "minLength": 1,
+  "type": "string"
+}

addedInput schema / properties / q

Added value: +{
+  "description": "find: the text to look for, case-insensitive.",
+  "maxLength": 200,
+  "minLength": 1,
+  "type": "string"
+}

addedInput schema / properties / ref

Added value: +{
+  "description": "show: the element, by the ref a view printed, any unique prefix, or its id.",
+  "maxLength": 256,
+  "minLength": 1,
+  "type": "string"
+}

addedInput schema / properties / style

Added value: +{
+  "description": "outline: add the colours and line styles that differ from the defaults.",
+  "type": "boolean"
+}

addedInput schema / properties / view

Added value: +{
+  "description": "How to read the tab. outline (default): one line per element with its ref, label and arrows, nested by frame. graph: what connects to what. layout: where things sit. comments: open threads in full. show: one element in full (needs ref). find: elements holding some text (needs q).",
+  "enum": [
+    "outline",
+    "graph",
+    "layout",
+    "comments",
+    "show",
+    "find"
+  ],
+  "type": "string"
+}

changedOutput schema / properties / tab / properties / elements / description

Previous value: -"The tab elements, in the format of the livediagram://schema/elements resource."New value: +"The tab elements (format \"json\"), in the format of the livediagram://schema/elements resource."

addedOutput schema / properties / tab / properties / text

Added value: +{
+  "description": "The view text (format \"view\").",
+  "type": "string"
+}

addedOutput schema / properties / tab / properties / view

Added value: +{
+  "description": "The view read (format \"view\").",
+  "type": "string"
+}

changedOutput schema / properties / tab / required

Previous value: -[
-  "id",
-  "name",
-  "rev",
-  "elements"
-]New value: +[
+  "id",
+  "name",
+  "rev"
+]

Changed2 schema fields changedOct 4, 2026

addedOutput schema / properties / tab / properties / rev

Added value: +{
+  "description": "The tab revision: pass it as rev to update_document.",
+  "type": "number"
+}

changedOutput schema / properties / tab / required

Previous value: -[
-  "id",
-  "name",
-  "elements"
-]New value: +[
+  "id",
+  "name",
+  "rev",
+  "elements"
+]

Changed6 schema fields changedSep 29, 2026

removedInput schema / properties / diagramId

Removed value: -{
-  "description": "The diagram id (from find_diagrams).",
-  "type": "string"
-}

addedInput schema / properties / documentId

Added value: +{
+  "description": "The document id (from find_documents).",
+  "type": "string"
+}

changedInput schema / required

Previous value: -[
-  "diagramId"
-]New value: +[
+  "documentId"
+]

changedOutput schema / properties / id / description

Previous value: -"The diagram id."New value: +"The document id."

changedOutput schema / properties / name / description

Previous value: -"The diagram name."New value: +"The document name."

changedOutput schema / properties / url / description

Previous value: -"Link that opens the diagram in the livediagram editor."New value: +"Link that opens the document in the livediagram editor."

First observedSep 29, 2026

TDQS

A4.1/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds genuine lifecycle context (deprecation and removal date) and notes input parity with read_document, but says nothing about output, permissions, or rate limits. With annotations carrying the safety burden, a 3 is appropriate.

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

Conciseness5/5

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

One sentence, front-loaded with 'Deprecated', followed by the replacement and the deadline. No filler; every clause carries actionable information.

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

Completeness4/5

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

For a deprecated alias, the description covers what an agent needs: the replacement tool, the deadline, and input equivalence. An output schema exists, so return values need not be described. The only gap is that it never states the underlying operation, relying on the sibling name to convey it.

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?

There are zero parameters, so the baseline is 4. The empty schema with additionalProperties allowed would leave an agent unsure what to pass, but the description closes that gap by stating it 'takes the same input as read_document,' which is meaningful guidance beyond the structured fields.

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

Purpose4/5

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

The description never states the tool's function directly; it identifies itself only as a deprecated alias whose replacement is read_document and whose input matches that tool. Combined with the name and title ('Read + visualise a document'), an agent can infer the purpose, but the description itself leans on the sibling to explain what it does rather than describing the read/visualise operation.

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?

It gives an explicit directive ('use read_document instead'), names the alternative, and supplies a hard removal date (2027-04-30) so an agent knows both when not to use it and how long it remains callable. This is exactly the when/when-not/alternative guidance the dimension asks for.

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

All livediagram tools Inspect

Try in Browser

Shareable, User-Owned Context BackendPeople, applications, and agents read, write, and coordinate together in one context lake. Reach it over MCP, a CLI, a Python SDK, or REST.fulcradynamics.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?