ym_shipments

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

Annotations declare readOnlyHint=true, and the description uses 'List' which aligns with that. However, the description adds no further behavioral context such as rate limits, authentication needs, or what happens when called without parameters. It does not contradict annotations.

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, highly concise. The first sentence states the main purpose, the second provides usage guidance. Every sentence adds value without 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 an output schema exists (so return values need not be explained), the description leaves the campaign_id parameter unexplained and does not define 'first-mile shipments'. For a simple tool, basic completeness is lacking.

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 single parameter campaign_id has no description in the schema (0% coverage), and the tool description does not explain its purpose or how it affects results. The description must compensate for missing schema coverage but fails to do so.

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 states 'List first-mile shipments', clearly indicating the verb (list) and resource (shipments) with a specific scope (first-mile). It differentiates from sibling tools by noting that advanced filtering is available via ym_execute.

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 provides explicit guidance: use this tool for simple listing of first-mile shipments, and use ym_execute with action shipments_search for advanced filtering. This helps the agent choose the correct tool.

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