Upload File

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

The description discloses the tool's non-functionality, the technical reason (multipart/form-data not supported by a JSON-only client), and a workaround. This goes far beyond the readOnlyHint=false and openWorldHint=true annotations, preventing wasted calls and setting accurate expectations.

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 efficient sentences, front-loaded with the essential 'NOT FUNCTIONAL' warning, then providing reason and alternatives. No unnecessary words or redundancy.

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 the tool is non-functional, the description fully covers the limitation, cause, and alternative actions. No output schema or return values are needed because the tool cannot execute successfully.

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?

The schema already documents both parameters thoroughly (100% coverage). The description adds critical context by stating the tool cannot actually upload, making the parameters effectively inert, and clarifies that the real upload must happen externally via multipart/form-data.

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 identifies the intended operation (upload file via POST /api/upload) and immediately states it is NOT FUNCTIONAL, which is an explicit verb+resource+state. It distinguishes itself from sibling gorgias_download_file by focusing on upload and its critical limitation.

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 explicitly tells users not to use this tool and provides concrete alternatives: the Gorgias web interface or a multipart-capable HTTP client like curl with -F. This is unambiguous when-to-use/when-not-to-use guidance.

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