Upload a Test Manager Attachment

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

With no annotations, the description must disclose behavioral traits. It does so by stating 'performs a real upload', that the URL is time-limited, and that the file_key is the persistent identifier. However, it does not mention file size limits, allowed file types, or authentication requirements, leaving some gaps.

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 concise (three sentences) and front-loaded: it first states the action and return values, then gives usage guidelines, then a warning. Every sentence adds value without 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 simple tool (1 param, no output schema, no annotations), the description covers the tool's purpose, return values, behavior, and important usage notes (time-limited URL, file_key usage). It is sufficiently complete for an agent to use the tool correctly.

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 provides 0% coverage (no descriptions for parameters), so the description must compensate. It explains that file_path is a local file path on the machine, adding critical meaning beyond the schema's type 'string'. This fully clarifies the parameter's semantics.

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 uses a specific verb 'Uploads' and clearly defines the resource 'Test Manager attachment storage'. It distinguishes this tool from siblings by being the only upload tool, and it clarifies the return values and their usage (file_key vs URL).

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 states when to use the output (file_key with other tools like tm.update_testCaseInstanceStep) and warns against speculative calls. It provides clear context for using the returned values, which is essential for an upload tool.

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