Show Or Create Document Markup Downloadable PDF

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

The description explains the async behavior (starts processing, returns download URL or async job handle) and parameter reuse from the viewing URL, adding value beyond annotations. No contradictions with annotations (readOnlyHint=false, destructiveHint=false).

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 well-structured and front-loaded with the main purpose. Each sentence adds useful information, though it could be slightly tighter (e.g., 'Required parameters' list repeats schema).

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?

The description covers purpose, behavior, parameter mapping, required fields, example, and API endpoint. It explains the return type (download URL or async job handle). Lacks guidance on polling for async jobs but is otherwise complete for an agent's decision-making.

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%, but the description adds meaning by listing required parameters, giving an example URL that shows how parameter values are used, and explaining that item_id, item_type, attachment_id match the viewing URL.

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 clearly states it finds or creates a downloadable PDF of document markup, with a specific verb and resource. The purpose is evident, though it does not explicitly distinguish from sibling tools like 'generates_pdf_document' or check status tools.

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 mentions 'Use this to perform the show or action on Document Markup records' and provides an example URL, giving context. However, it does not specify when not to use it or name alternative tools for related tasks.

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