upload_file

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

Annotations are neutral (non-read-only, non-destructive). Description adds return value info (blob ID and URL) but lacks details on side effects, storage limits, or auth requirements.

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 sentences, no fluff, purpose first, then usage options, then return info. Efficient and well-structured.

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?

Covers upload variants, return values, and references. Lacks error handling or size limits for filePath/fileUrl, but sufficient 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?

Schema covers all 5 parameters with descriptions. Description adds mutual exclusivity hint and size constraint for data, enhancing beyond 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?

Clearly states 'Upload a file to Huly storage', distinguishes between three methods (filePath, fileUrl, data), and differentiates from sibling tools like add_attachment which attach to entities.

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 explicit guidance on when to use each parameter (preferred filePath, remote fileUrl, fallback data for small files). Does not contrast with sibling tools like add_attachment but is adequate for parameter selection.

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