upload_file

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

With no annotations provided, the description carries the full burden. It discloses the core behavior (upload and storage for later reference) but omits details like persistence duration, size limits, or whether re-uploading overwrites. It does not contradict itself but is minimal.

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, both purposeful. First states what it does and why; second clarifies the primary input choice. No wasted words, front-loaded with key 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?

The description covers the essential upload action and purpose but lacks detail on the return value (e.g., document ID for referencing) and does not mention optional parameters (metadata, preSignedUrlExpiresIn). Given the tool's simplicity and absence of output schema, it is adequate but not thorough.

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 covers all parameters with descriptions, but the description adds critical semantics: it clarifies that either filePath or url must be provided (mutual exclusivity) and that filePath refers to a local path. This goes beyond the schema, which lists them as separate optional properties.

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 specifies the action (upload a PDF), the target platform (PDFGate), and the purpose (to be referenced by other operations). It clearly distinguishes from sibling tools by focusing on the upload step, not PDF processing or retrieval.

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 provides clear context that this is a prerequisite for other operations ("so it can be referenced"), implying it should be used before consumption. It does not explicitly mention alternatives or when not to use it, but the purpose is unambiguous.

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