traverse_order_products

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

With no annotations provided, the description carries the full burden but covers only the core traversal behavior. It explains how the direction parameter changes the result but does not mention return format, error handling, or whether it is read-only.

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 compact sentences, front-loading the purpose and then providing direction-specific details. Every sentence adds clear value with no 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?

Given the tool's low complexity (2 params, no output schema), the description adequately covers the main use cases and expected result types. It omits edge cases like missing records or response structure but remains sufficient for a straightforward traversal tool.

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 coverage is 0%, so the description must compensate. It effectively explains the meaning of direction (forward/reverse) and the role of pk dependent on direction, which goes well beyond the raw schema. It could add detail on pk format but is substantially helpful.

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 → Product many-to-many link 'orderProducts', with direction-specific behavior. This specific resource and action distinguish it from sibling traversal tools like traverse_customer_orders and traverse_order_notes.

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 explains both forward and reverse usage with concrete examples (pass Order pk or Product pk). It provides clear context for when to use each direction, though it does not explicitly contrast with alternative traversal tools.

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