pivot_order_notes

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

With no annotations provided, the description must carry the full behavioral disclosure burden. It does mention that duplicate target identities are removed and that direction is conditionally required, which are useful. However, it omits other behaviors such as whether the operation is read-only, what happens if direction is missing when required, or the nature of the returned data. The description adds some transparency but is not comprehensive.

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 concise, consisting of two sentences that front-load the core action and a key constraint. There is no fluff or redundant information, and the structure is easy to scan. It is appropriately sized for the tool's simplicity, though it could afford more detail without becoming verbose.

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 there is no output schema, no annotations, and low schema coverage, the description is thin for the task. It does not explain the return format, any limitations on input size, or error conditions. For a pivot operation that follows links between Orders and Notes, an agent might need more context on how results are presented or how direction affects traversal. The description is minimal and likely insufficient for an agent to confidently 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?

Schema description coverage is 0%, so the description must compensate by explaining the parameters. It explains that source can be of type Order or Note and that direction is required for same-type sources, but it does not elaborate on the 'pks' structure or the exact meaning of 'forward' and 'reverse'. The description adds minimal value beyond the schema, leaving the pks array semantics to the agent's inference.

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 action ('Follow orderNotes') and the resource (orderNotes from a set of Order or Note). It identifies the input types and the need for direction in same-type cases, giving a specific sense of the tool's function. However, it does not explicitly differentiate from the sibling 'traverse_order_notes' or other pivot tools, so it's not a perfect 5.

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 gives one usage constraint ('Direction is required when both ends have the same type') but does not explain when to choose this tool over alternatives like traverse_order_notes or other pivot functions. There is no mention of use cases, exclusions, or comparative guidance, leaving the agent to infer when to invoke this tool.

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