Update Shared Step

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

Annotations already indicate destructiveHint=true and idempotentHint=true. The description adds beyond this by stating 'Changes propagate to ALL test cases using this shared step' and 'Only provided fields will be updated'. It does not cover authorization or rate limits, but adds significant behavioral context.

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 very concise with four meaningful sentences. It front-loads the purpose, then delivers warnings and behavioral notes. Every sentence is essential with no 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?

While the description covers propagation and idempotency, it fails to mention the required confirm parameter described in the schema ('Must be set to True to proceed with update'). It also does not describe what the API returns. Given these gaps and the tool's complexity, completeness 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?

Schema coverage is 100% with each parameter already described. The description adds the general rule 'Only provided fields will be updated. Omitted fields remain unchanged', which clarifies partial update behavior beyond the schema. Baseline is 3, and this extra value warrants a 4.

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 starts with 'Update an existing shared step', using a specific verb and resource. It clearly distinguishes this from sibling tools like create_shared_step, delete_shared_step, link_shared_step, and list_shared_steps.

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 implies usage when modifying an existing shared step but does not explicitly state when to use this tool versus alternatives (e.g., create, delete). It lacks guidance on context or exclusions, relying on the tool name for differentiation.

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