foundry_get_canvas_documents

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

Annotations already declare readOnlyHint=true, and the description adds only 'from a scene' as a scope constraint. It does not disclose whether sceneId is optional, what happens if omitted, return format, or pagination behavior. This is minimal behavioral context beyond the annotation.

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, concise sentence with no filler. It is front-loaded and every word contributes to the core purpose, making it appropriately sized for a simple retrieval tool.

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?

Despite having 5 parameters and no output schema, the description is too sparse. It does not explain what canvas embedded documents are, how sceneId is resolved, or how documentType filters results. Given the many sibling tools, the description lacks operational context necessary for correct selection and invocation.

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 schema covers 60% of parameters (userId, clientId, documentType), but sceneId and documentId are undocumented. The description merely hints at 'a scene' without explaining parameter usage or filtering semantics, failing to compensate for the undocumented parameters.

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 'Get canvas embedded documents from a scene' clearly states the specific action (get) and resource (canvas embedded documents), with a scope ('from a scene'). It distinguishes this tool from sibling tools like foundry_create_canvas_documents and foundry_delete_canvas_document by focusing on retrieval.

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 provides no guidance on when to use this tool versus alternatives (e.g., get_entity, create_canvas_documents) or how to specify a scene. There are no exclusions, prerequisites, or mentions of related tools, leaving the agent to infer usage from the name.

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