update_test_case_step

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

No annotations provided. Description implies mutation (PUT) and requires stepId from a search/list tool, indicating a prerequisite. Does not disclose any destructive effects beyond editing, which is acceptable for a mutation tool.

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, no redundancy. Front-loads the primary action and then provides critical usage details. Efficient and easy to parse.

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 essential aspects: where to get stepId, what parameters are optional/required, and the useLatestVersion flag. Lacks return value details, but output schema is absent, and the tool is a simple update operation.

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?

Adds meaningful context beyond schema: explains stepId origin, documents the 'at least one' constraint for stepDetails/expectedResult/testData, and clarifies useLatestVersion behavior. Schema coverage is 63%, but description compensates well.

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?

Clearly states 'Edit an existing test step', specifies HTTP method (PUT) and endpoint pattern. Distinguishes from sibling tool 'add_test_case_steps' (add vs update).

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 source for stepId ('from get_test_case_steps') and gives guidance on required fields ('Provide at least one of stepDetails, expectedResult, testData'). Could mention when to use this versus other update tools like 'update_test_case_description'.

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