clm_shipment_command_update_shipment_comment

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

The annotations already indicate the operation is idempotent and non-destructive. The description adds limited context by clarifying that only the text is updated, not the comment as a whole, but it does not explain behavior when the comment does not exist or whether a null Comment clears the text.

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?

A single, front-loaded sentence with no filler. Every word contributes to stating what the tool does.

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?

With 0% schema description coverage, the description must compensate by explaining how to provide the comment identifier and new text. It does not do so, nor does it cover usage guidance. The output schema and annotations help, but the description alone leaves an agent guessing about required inputs and failure behavior.

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 no descriptions for ItemId or Comment, so the description's mention of 'text' and 'existing shipment comment' adds some meaning. However, it does not explicitly map these concepts to the parameters or clarify which identifier is needed to locate the comment.

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 ('Updates') and a precise resource ('the text of an existing shipment comment'). It clearly distinguishes this tool from the sibling create and delete comment tools by specifying 'existing' and 'text.'

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 about when to use this tool versus creating a new comment or deleting a comment. The word 'existing' implies it is not for creation, but no alternatives or exclusions are stated.

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