Skip to main content
Glama

read_scene

Read the current shared drawing to understand its elements. Get a concise one-line summary per element or full JSON, filter by ids or proximity, to quickly assess or update the canvas.

Instructions

Read the current drawing. 'summary' gives one line per element with position, size, text, and a sampled path for freehand strokes. 'json' returns the full Excalidraw element array as compact JSON. Filter to keep the response small: 'ids' returns just those elements (unknown ids are named back), and 'near' returns one element plus everything within a radius of it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
byNoReturn only elements written by these handles. "person" selects the elements nothing stamped, which is what a browser leaves, so by: ["person"] is what people in the room drew. Every summary line ends with "by <handle>" whether or not this is set.
idsNoReturn only the elements with these ids.
nearNoReturn the named element and everything within the radius of it.
formatNosummary
includeDeletedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.7.1
    • addedInput schema / properties / by
      Added value: +{
      +  "description": "Return only elements written by these handles. \"person\" selects the elements nothing stamped, which is what a browser leaves, so by: [\"person\"] is what people in the room drew. Every summary line ends with \"by <handle>\" whether or not this is set.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "minItems": 1,
      +  "type": "array"
      +}
    • changedInput schema / properties / near / properties / radius / description
      Previous value: -"How far beyond that element's bounding box to reach."New value: +"How far beyond that element's bounding box to reach. Defaults to the room's nearbyRadius."
    • addedInput schema / properties / near / properties / radius / minimum
      Added value: +0
    • changedInput schema / properties / near / required
      Previous value: -[
      -  "id",
      -  "radius"
      -]New value: +[
      +  "id"
      +]
  2. Changed2 schema fields changedv0.4.0
    • addedInput schema / properties / ids
      Added value: +{
      +  "description": "Return only the elements with these ids.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "minItems": 1,
      +  "type": "array"
      +}
    • addedInput schema / properties / near
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Return the named element and everything within the radius of it.",
      +  "properties": {
      +    "id": {
      +      "description": "Element the neighbourhood is centred on.",
      +      "type": "string"
      +    },
      +    "radius": {
      +      "description": "How far beyond that element's bounding box to reach.",
      +      "type": "number"
      +    }
      +  },
      +  "required": [
      +    "id",
      +    "radius"
      +  ],
      +  "type": "object"
      +}
  3. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations, the description carries the burden of behavioral disclosure. It explains the summary format (line per element with position, size, text, and sampled path), the json format, and how filters behave (ids returns named elements, unknown ids are named back; near returns one element plus neighbors). This goes beyond the schema, though it does not mention includeDeleted behavior.

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?

The description is three sentences, front-loaded with the core action, and each sentence adds value without redundancy. It efficiently covers the formats and filters.

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?

The description covers the main usage scenarios and return formats, but it omits the includeDeleted parameter entirely and does not explicitly state that no filters return all elements (though implied by 'filter to keep response small'). Given no output schema, it adequately explains the two output formats, so it is fairly complete.

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?

The description adds meaning for the format parameter (explaining summary vs json) and the filtering parameters (ids and near), which goes beyond the schema's minimal descriptions. However, it does not elaborate on the 'by' parameter or 'includeDeleted', and the schema covers 60% of parameters, so the description only partially compensates.

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 clearly states the tool reads the current drawing, specifies two output formats (summary and json) with details on what each contains, and describes filtering options. It distinguishes itself from sibling write tools by using 'read' as the verb, making its purpose unambiguous.

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

Usage Guidelines4/5

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

The description explains how to use the tool, including the format parameter and filtering by ids and near, with guidance to keep responses small. However, it does not explicitly compare to sibling tools or state when not to use it, so it lacks explicit exclusions or alternatives.

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