Request File Upload

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

Annotations indicate non-readonly and non-destructive. Description adds context: returns upload_url, document_id, expires_at, and instructs to poll talonic_get_document until status 'completed'. Discloses expiration and required follow-up actions. No contradiction with 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?

Very concise: three short paragraphs. Uses headers (USE WHEN, NOT FOR, ARGS, RETURNS) for structure. No wasted words.

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?

Given one parameter and presence of output schema (implied by return fields), description is complete. It explains the full workflow: requesting upload, user action, polling, and subsequent extraction call.

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 covers filename with description. Description adds example and notes extension importance, but this is marginal. Baseline 3 for high schema coverage.

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 the tool gets a browser upload link and returns a pre-allocated document_id. It uses specific verbs ('Get a browser upload link') and resources ('add a file to their workspace'), distinguishing it from siblings like talonic_extract and talonic_get_document.

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 states when to use (hosted/sandboxed clients or large files) and when not to (document already in workspace, public URL). Provides alternatives: 'use its document_id' or 'use file_url on talonic_extract'. Clear guidance.

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