View document

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

Disclosures match annotations (readOnlyHint). Adds behavioral details: auto-detection of entity_type, default link expiration, inline vs clickable rendering. No contradictions.

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?

Three sentences, each adding value. No redundant information. Front-loaded with purpose, then workflow, then behavior.

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 output schema present and high schema coverage, the description is complete. Covers purpose, usage, parameters, and rendering behavior. Well-differentiated from sibling tools.

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?

Schema coverage is 100%. Description adds significant context: how to obtain entity_id, auto-detection logic for entity_type, and default expiration value. Goes beyond schema definition.

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?

Clearly states verb ('generate'), resource ('read-only embedded view link'), and scope ('document or document group'). Differentiates from siblings by focusing on embedding and read-only access.

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?

Explicitly provides workflow: first call list_documents/list_templates to find entity by name, then pass entity_id. Explains rendering behavior in different clients. Does not explicitly say when not to use, but context is clear.

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