update_suite

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

Discloses that only provided fields are updated (partial update behavior). Provides an example. However, without annotations, it does not mention any side effects, permissions, or error handling. Still, the key behavioral trait is covered.

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?

Three concise sentences plus an example. No wasted words. Important information is front-loaded.

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 input well but omits return value and error behavior. With no output schema and no annotations, the description could be more complete by stating what is returned (e.g., the updated suite object). Adequate but not outstanding.

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 coverage is 100%, so baseline is 3. The description adds the partial update concept and the move_suite distinction but does not significantly enhance parameter understanding beyond the schema's descriptions.

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 states it updates an existing test suite, with the specific verb 'update' and resource 'test suite'. It distinguishes from siblings like move_suite by explicitly directing the user to a different tool for moving suites.

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 this tool: to update a suite, and when not to: to move a suite, directing to move_suite. Lists required and optional parameters, including the note about project_id being optional if TC_DEFAULT_PROJECT is set.

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