compare_batches

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

Annotations already declare readOnly and idempotent safety. The description adds valuable behavioral details: row alignment by ingredient/step name, explicit nulls for non-used items, and return of totals where meaningful. No contradiction with 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?

The description is compact and well-organized into purpose, args, and returns. The first sentence immediately states the function, and all information is directly useful with no padding.

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?

Given the simplicity of the tool (2 parameters, no nested objects) and the availability of an output schema, the description is complete. It explains the alignment behavior, parameter ranges, and return format sufficiently for an agent to invoke the tool correctly.

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 description adds essential constraints not present in the input schema: batch_ids must be between 2 and 5 values, and dimension provides an explicit enumeration (grain, hops, water, fermentation, measurements). This fully compensates for the 0% schema description coverage.

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 clearly states the tool's function with a specific verb ('Line up'), resource ('2-5 batches'), and scope ('on one dimension'). It is easily distinguished from sibling tools like get_batch (single batch) and list_batches (listing).

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?

Provides clear context for when to use the tool by describing the use case of comparing recipe versions and highlighting that 'absence is usually the thing you are looking for.' It does not explicitly name alternatives, but the purpose is unambiguous and the context signals suffice for correct selection.

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