Skip to main content
Glama

AgentPlaybooks

Read canvas document

read_canvas
Read-onlyIdempotent

Read a canvas document.

Input Schema

NameRequiredDescriptionDefault
slugYesDocument slug
run_idYesWorkflow run UUID
section_idNoOptional: read only this section
playbook_idYesUUID or GUID of the target playbook

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.3/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered structurally. The description adds nothing beyond that — no note on what is returned, whether missing documents error out, or how the playbook/run/slug hierarchy resolves. With annotations carrying the burden, this still leaves the description thin.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The single sentence is efficient and front-loaded, but it is under-specified rather than genuinely concise — there is simply very little content to waste.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

This is a read tool with three required hierarchical identifiers and no output schema, so the description should clarify what the document content looks like and how sections are selected. It covers none of that, leaving the agent to guess the return shape and the purpose of section_id.

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 all four parameters (slug, run_id, playbook_id, section_id) are documented in the schema itself. The description adds no extra meaning, which is acceptable given the high coverage baseline of 3.

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?

"Read a canvas document" restates the tool name and title without adding a specific verb+scope combination. It does not distinguish the tool from siblings like list_canvas, write_canvas, or get_playbook, so an agent gets no signal about what makes this a read of a single canvas versus a listing.

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

Usage Guidelines2/5

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

There is no guidance on when to use this tool versus list_canvas or write_canvas, and no mention of prerequisites such as needing an existing run_id or slug. The agent must infer usage entirely from the name.

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