Skip to main content
Glama

Read the Markdown body of a canvas together with its ETag. Use this immediately before rewriting a canvas so the update can be guarded against concurrent edits. Returns the stored body as Markdown plus a strong `etag` (also in the `ETag` header) derived from that body. Pass the `etag` unchanged as `If-Match` on v1UpdateCanvasContent; the same body always yields the same ETag. A 502 means a backend dependency was unavailable — retry later. Viewers can read; only editors can replace.

getCanvasContent
Read-onlyIdempotent

Read the Markdown body of a canvas together with its ETag. Use this immediately before rewriting a canvas so the update can be guarded against concurrent edits.

Returns the stored body as Markdown plus a strong etag (also in the ETag header) derived from that body. Pass the etag unchanged as If-Match on v1UpdateCanvasContent; the same body always yields the same ETag. A 502 means a backend dependency was unavailable — retry later. Viewers can read; only editors can replace.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesCanvas ID

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoUnique identifier of the canvas
etagNoStrong ETag of the body. Echo it in If-Match on PUT /content; also sent as the ETag response header.
contentNoCanvas body as Markdown

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedOutput schema / properties / content / description
      Previous value: -"Live canvas body rendered as Markdown"New value: +"Canvas body as Markdown"
    • changedOutput schema / properties / etag / description
      Previous value: -"Strong ETag of the live body. Echo it in If-Match on PUT /content; also sent as the ETag response header."New value: +"Strong ETag of the body. Echo it in If-Match on PUT /content; also sent as the ETag response header."
  2. Added

TDQS

A4/5.0
Behavior5/5

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

Annotations already establish readOnly/idempotent/no-destruction, and the description still adds substantial behavior beyond them: the ETag is a strong validator derived from the body, identical bodies yield identical ETags, a 502 signals an unavailable backend dependency to retry, and the read-vs-replace permission split is documented.

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 core purpose is front-loaded and every sentence carries operational payload (ETag round-trip, error semantics, permissions) with no filler. Slight restatement between title and description is the only redundancy.

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 single-parameter read tool with an output schema and full annotation coverage, nothing needed for correct invocation is missing — the description even supplies the cross-call ETag contract and failure handling that the schema and annotations cannot express.

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% with a single documented `id` parameter, so the schema carries the burden and a baseline of 3 applies. The description explains how the returned etag feeds back into a later call but adds nothing about the `id` parameter itself.

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

Purpose2/5

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

Tautological: description restates name/title.

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 when-to-use rule ('Use this immediately before rewriting a canvas so the update can be guarded against concurrent edits') and routes to the consuming tool by name (v1UpdateCanvasContent). Access conditions are also spelled out — viewers can read, only editors can replace.

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