Skip to main content
Glama

Read a diagram

diagram_get
Read-onlyIdempotent

Reads a diagram. The default outline: a header (id, title, revision, time, hash), the brief, recent versions, one element per line nested by container, and edges as 'id: from -> to'. view 'dsp' returns the scene JSON, 'mermaid' Mermaid to edit and send back to diagram_edit. revision or asOf reads an earlier version; knownRevision, only what changed since; elements, only those elements and their neighbors. Another workspace's diagram answers NOT_FOUND.

Input Schema

NameRequiredDescriptionDefault
idYesDiagram id or key
asOfNo2026-06-30 (end of day, UTC) or ISO 8601 with an offset
viewNoDefault outline
cursorNoThe last page's nextCursor
elementsNo
revisionNoOmit for the latest
knownRevisionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • removedInput schema / properties / elements / description
      Removed value: -"Element ids to focus on"
    • removedInput schema / properties / knownRevision / description
      Removed value: -"A revision you already know"
  2. Changed2 schema fields changed
    • changedInput schema / properties / cursor / description
      Previous value: -"nextCursor from the previous page"New value: +"The last page's nextCursor"
    • changedInput schema / properties / id / description
      Previous value: -"The diagram's id or key"New value: +"Diagram id or key"
  3. First observed

TDQS

A4.5/5.0
Behavior4/5

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

The annotations already declare this as a safe, read-only, idempotent, closed-world operation. The description adds useful behavioral details beyond the annotations: the default outline shape, the scene JSON and Mermaid return forms, and the NOT_FOUND behavior for another workspace's diagram.

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 description is front-loaded with the core action and then packs the important view and revision semantics into a compact paragraph. It is dense and could be easier to scan as a list, but every sentence carries useful information and there is no filler.

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?

There is no output schema, but the description adequately describes the default return structure and the alternate view outputs. It also covers the key error case, though pagination via cursor is only described by the schema and not by the description.

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 71%, so the schema documents some parameters already. The description meaningfully supplements this by explaining the semantic difference between 'revision', 'asOf', 'knownRevision', and 'elements', though it does not explain 'cursor' pagination behavior beyond what the schema provides.

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?

The description opens with a specific verb+resource ('Reads a diagram') and then details what the default read returns, making the scope clear. It also distinguishes the mermaid view from diagram_edit by saying the Mermaid output is meant to be edited and sent back, so the agent can tell it apart from sibling mutation tools.

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 explicitly explains the view modes ('outline', 'dsp', 'mermaid') and when each is useful. It also names the revision-selection parameters and their distinct purposes: 'revision or asOf reads an earlier version', 'knownRevision' shows only changes since a revision, and 'elements' limits output to those elements and neighbors.

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.

Resources