upload_folder

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

The description discloses key behavioral details beyond annotations: it compresses the folder into upload.tar.gz, skips hidden files, and defaults storage_folder to the local folder name. Annotations already indicate a write (readOnlyHint=false) and non-destructive (destructiveHint=false), so the description adds context about the exact operation and return value.

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 three sentences with no fluff. The main action is front-loaded, and essential details (hidden files skipped, return value) are included concisely. Every sentence adds value.

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 is complete for this tool. It explains the input, the process, the default behavior, and the return value (which is important since there is no output schema). It also ties the return value to launch_simulation, giving the agent full context for the next step.

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 description coverage, the description fully compensates by explaining folder as the local case folder to compress and storage_folder as the target cloud storage folder with a default. It gives meaning to both parameters, which the bare schema does not.

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 states a specific action (compress and upload) on a specific resource (local case folder) to a specific destination (cloudHPC storage). It distinguishes itself from siblings like get_upload_link and download_results by explaining the upload process and its role in preparing for launch_simulation.

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 implies usage as a preparatory step for launch_simulation by stating it returns the storage folder to use in that tool. It provides clear context but does not explicitly mention alternatives or when not to use it. Still, it is enough for an agent to understand when to invoke it.

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