Get Canvas Project

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint false, and the description is consistent with these. It adds useful context by clarifying the workspace-local scope and the optional hydration of image data. It does not describe auth or rate limits, but the safety profile is well covered by annotations.

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

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

The description is a single, front-loaded sentence that directly states the action and the object. It contains no filler or redundant information, earning its place with every word.

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

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

With only one optional parameter, an output schema present, and strong safety annotations, the description covers the core read behavior adequately. It identifies the main returned content categories and the optional image data. It could be slightly more complete by addressing alternative sibling tools, but it is largely sufficient.

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

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

The only parameter, hydrateFiles, has no description in the schema (0% coverage). The description's phrase 'optionally hydrated image data' hints at the parameter's role but does not explicitly state how hydrateFiles affects the response or what true/false values do. It provides some meaning but leaves room for inference.

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

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

The description opens with the specific verb 'Read' and identifies the exact resource: the 'workspace-local Canvas project.' It enumerates the contents (pages, Excalidraw elements, business metadata, optionally hydrated image data), making the tool's purpose very clear. It also distinguishes this tool from siblings like get_canvas_context by specifying it reads the whole project.

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

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

The description implies the tool is used for reading project data, but it does not explicitly state when to choose this tool over alternatives such as get_canvas_context or get_modellix_canvas_status. There are no exclusions or when-not-to-use scenarios, leaving usage guidance solely implied.

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