deals_list_products

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

No annotations exist, so the description carries full burden. It discloses caching behavior ('Cached for 5 minutes') and hints at output structure (pricing, quantity, totals with discounts). This adds valuable behavioral context beyond the schema.

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 well-structured with clear sections, front-loaded with purpose. It is informative but slightly verbose; however, every sentence earns its place by adding value.

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 list tool with no output schema, the description covers return details (products with pricing/quantity, product_attachment_id), caching, and parameter usage examples. It lacks error handling or rate limits, but is sufficient for common use cases.

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 100%, but the description adds extra meaning through workflow tips and examples, explaining the role of product_attachment_id, the effect of include_product_data, and default pagination values.

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 'List all products attached to a deal', specifying the verb (list), resource (products), and context (attached to a deal). This distinguishes it from sibling tools like deals_list or deals_list_activities.

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 'Workflow tips' and 'Common use cases' with example JSON calls, guiding when to use the tool and how to leverage parameters like include_product_data and pagination. It implicitly suggests using it before updates/removal via product_attachment_id, though lacks explicit when-not-to-use guidance.

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