Skip to main content
Glama

Read a canvas

read_canvas
Read-only

Read a canvas in full, with its goal, version and recent edits. Always read before you edit.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "slug": "<slug>"
    },
    "name": "read_canvas"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds that the result includes goal, version and recent edits, which is genuinely useful return-shape context since there is no output schema. It does not address whether 'in full' means unbounded size, truncation, or whether stale/missing canvases error.

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?

Two short sentences, front-loaded with the read semantics and ending with the imperative workflow rule. No filler or redundancy.

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 single-parameter read with no output schema, the description covers purpose, returned fields, and the sequencing rule. The only meaningful gap is the unexplained required 'slug' argument, which is the one thing an agent must supply.

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

Parameters2/5

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

There is one required parameter, 'slug', with zero schema description coverage, and the description never explains what a slug is, how to obtain one (presumably from list_canvases), or its format. With low coverage the description should compensate, and it does not.

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?

States a specific verb and resource ('Read a canvas') and enumerates what the read surfaces: goal, version and recent edits. That distinguishes it from write siblings like create_canvas/edit_canvas, but it never differentiates from list_canvases, which an agent could easily confuse it with.

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?

'Always read before you edit' gives a concrete, actionable workflow rule that ties this tool to the edit sibling. It stops short of naming edit_canvas explicitly or describing when a list-style read (list_canvases) would be preferable.

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