upload_document

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

Description discloses extraction behavior and the option to supply data later via set_document_extracted_data, but lacks details on success output, error handling, or permissions. No annotations provided to supplement.

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?

Two concise sentences that front-load the core purpose then provide optional parameter guidance. No redundant information.

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?

For a 3-param tool with an output schema not shown, the description covers key behaviors. Lacks prerequisites like login/project selection but is adequate for typical use.

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?

With 0% schema coverage, description explains the purpose of file_path (implied), folder_id (recommended for extraction), and do_not_extract (when to set). Adds meaningful context beyond the bare schema.

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?

Description clearly states the tool uploads a record (MTR, NDE report, etc.) to the current project, distinguishing it from sibling tools like upload_drawing which target specific file types.

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?

Provides clear guidance on using folder_id for proper extraction schema and when to set do_not_extract=True. Does not explicitly contrast with siblings but context is implied.

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