Skip to main content
Glama

get_diagram

Fetch one diagram by ID to get its title, description, Mermaid source, workspace URL, and any public share link before editing.

Instructions

Fetch one diagram by id. Returns its title, description (the agent's brief), mermaid source code, and its URL in the app — which only members of this Space can open. If the diagram already has a public link, that link is reported separately on a Share (public, read-only): line; a public link is minted by a person, from the diagram's Share button. Read the description before editing — it tells you what the diagram is for and when to update it.

Input Schema

NameRequiredDescriptionDefault
idYesDiagram UUID
spaceNoWhich workspace to act in: its id, its slug, or its exact name (case-insensitive). Omit to use this token's default workspace. Call list_spaces to see what this token can reach. A name that matches more than one workspace is refused — pass the id or slug instead.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.0.7
    • addedInput schema / properties / space
      Added value: +{
      +  "description": "Which workspace to act in: its id, its slug, or its exact name (case-insensitive). Omit to use this token's default workspace. Call list_spaces to see what this token can reach. A name that matches more than one workspace is refused — pass the id or slug instead.",
      +  "type": "string"
      +}
  2. First observedv0.0.3

TDQS

A4/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and provides substantial behavioral context: it describes the returned fields, notes that the app URL is restricted to Space members, explains the public link and how it is minted, and advises reading the description before editing. It does not cover error cases or required permissions for the call itself, but it is otherwise rich.

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 return values, and every sentence contributes useful information. It is slightly longer than strictly necessary due to the public-link detail and editing advice, but there is no redundant or wasted language.

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 simple retrieval tool with no output schema, the description compensates by detailing exactly what is returned, including the public link format, and adds a workflow hint about reading the description before editing. It is complete enough for an agent to call the tool correctly and understand the output.

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

Parameters3/5

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

Schema description coverage is 100%, so the input schema already fully documents both parameters (id and space). The description adds no additional syntax, format, or constraint details beyond what the schema provides, making the baseline score of 3 appropriate.

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 states a specific verb ('Fetch') and resource ('one diagram by id'), and it lists the exact return fields (title, description, mermaid source, URL), clearly distinguishing it from list-oriented siblings like list_diagrams or analyze_diagram.

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

Usage Guidelines3/5

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

The description implies usage by saying 'Read the description before editing — it tells you what the diagram is for and when to update it,' which suggests this tool is for retrieving a diagram prior to an update. However, it does not explicitly state when to use this tool versus alternatives like get_version or analyze_diagram, nor does it provide exclusion criteria.

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