Group and Perform Consolidation

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

Annotations already declare the write profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=true), so the description should add what the annotations cannot: whether the grouping and consolidation are atomic, what happens if consolidation fails after grouping, and what state the consignments end up in. None of that is disclosed. The 'single operation' phrasing gestures at atomicity but never confirms it, which is a notable gap for a mutation that alters multiple consignments.

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 short elements, front-loaded with the action, followed by the argument note; there is no filler. The parenthetical '(combines grouping + performing)' is slightly redundant with the verb 'groups and consolidates' but does double as the only sibling differentiation.

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?

An output schema exists so return values needn't be explained, but the tool is a multi-entity mutation taking an untyped options blob and the description says nothing about failure/rollback behavior, prerequisite state of the consignments, or how it differs in outcome from the two-step siblings. That is insufficient for the complexity of the 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?

The schema is a free-form object of additionalProperties, and the description adds value by naming likely option keys (companyId, carrierId, grouping rules). However the trailing 'etc.' leaves the option surface open-ended, giving no guidance on required versus optional keys or the shape of the grouping rules.

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 gives a specific verb+resource pair ('groups and consolidates consignments') and clarifies the scope with 'in a single operation (combines grouping + performing)', which implicitly maps to the siblings machship_group_consignments_for_consolidation and machship_perform_consolidation. It never names those siblings directly, so an agent must infer the relationship rather than being told it.

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?

'Combines grouping + performing' hints at when this composite call is preferable to the two-step pair, but the description never states a use case, a precondition, or an exclusion. There is no explicit guidance such as 'use this instead of calling group then perform separately' or 'use the separate tools when you need to inspect groups before performing'.

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