Update a Qmetry test step

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

The description only says 'Update', implying mutation, but lacks details on whether the operation is destructive, if it replaces or modifies existing steps, or any required permissions. No annotations are available to supplement.

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 a single sentence and concise, but it is overly brief, omitting important details about the operation. It does not waste words but could be more informative.

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's complexity with 3 required parameters and a nested steps array, the description is insufficient. It does not explain the steps array structure, how it interacts with existing steps, or what the id field references. No output schema is provided.

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 description adds no insight beyond the input schema. The schema descriptions for testData and expectedResult are swapped, causing confusion. With 67% coverage, the description fails to clarify the parameters' meanings.

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 the verb 'Update' and the resource 'Qmetry test step', specifying it's for a given test case. This distinguishes it from create and delete tools, but it doesn't elaborate on which fields can be updated.

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?

No guidance is provided on when to use this tool versus alternatives like create-qmetry-test-step or delete-qmetry-test-step. No prerequisites or context for usage are mentioned.

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