traverse_order_notes

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

With no annotations provided, the description carries the burden of behavioral disclosure. It explains the core behavior (pass pk, get linked objects) and mentions the one-to-many nature, but doesn't cover edge cases like empty results, error handling, or whether the operation is read-only. This is adequate but not rich.

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 two sentences, highly concise, and front-loaded with the link name and relationship. Every word contributes to understanding the tool's purpose and usage, with no filler or 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?

For a simple 2-parameter traversal with no output schema, the description covers the essential usage and behavior. It lacks explicit details about return format or error behavior, but 'get linked Note objects' reasonably implies the response. Overall, it's nearly complete for the tool's complexity.

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 significant meaning to both parameters: it clarifies that pk is the Order or Note primary key depending on direction, and explains the effect of choosing 'forward' vs 'reverse'. This goes well beyond the raw schema, which only provides a generic 'pk' and an enum.

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 traverses the Order→Note link 'orderNotes', a one-to-many relationship, and explains both directions. This distinguishes it from sibling traversal tools like traverse_customer_orders or traverse_order_products by naming the specific entities and link.

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 instructions for both directions: forward requires an Order pk, reverse requires a Note pk. This gives clear context on when to use each mode, though it doesn't explicitly mention alternatives or when not to use the tool.

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