clm_shipment_command_create_shipment_comment

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

The description adds one behavioral fact beyond annotations: the comment is attributed to the current user. However, it does not disclose whether identifiers are validated, whether duplicate comments are possible, or any authentication/authorization requirements. destructiveHint=false only indicates the operation is not destructive.

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?

Single sentence, front-loaded with verb and object, and no filler. It earns its place by adding attribution information beyond the tool name.

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?

For a simple create-comment command with an output schema, the description covers the core operation and attribution. But it omits the logical relationship between ShipmentId and ItemId and gives no behavioral expectations beyond creation, leaving some ambiguity for the agent.

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 description coverage is 0%, so the description must compensate for undocumented parameters, but it only generically names 'comment' and 'shipment'. ItemId remains entirely unexplained, and the description does not clarify which of ShipmentId or ItemId is logically required or how Comment should be formatted.

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?

States a specific action ('Adds a new comment') on a clear resource ('a shipment') and adds the useful attribution detail ('to the current user'). This distinguishes it from sibling comment tools like update_shipment_comment, delete_shipment_comment, and get_shipment_comments.

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 the create scenario by using 'new comment', but it does not explicitly state when to prefer this over update_shipment_comment or delete_shipment_comment, nor mention prerequisites. Usage context is inferable but not explicitly guided.

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