get_product_list

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

With no annotations, the description carries full burden and delivers extensively: it explains the brand filter's 10,000-item scan limit, the scan_incomplete flag, the exact Shopline APIs used, backend matching behavior with no truncation, and return structure flags. This goes far beyond what the schema provides.

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?

Well-structured with clear sections, front-loaded with the main purpose, and every paragraph delivers essential caveats or behavioral details. The length is justified because of the non-obvious brand limitation and return flags; no filler content.

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?

Despite having no output schema or annotations, the description fully explains return structure, the meaning of truncated and scan_incomplete, API selection logic, and parameter behavior. It is comprehensive enough for an agent to invoke the tool correctly in most scenarios.

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 already describes all 7 parameters (100% coverage), giving a baseline of 3. The description adds extra meaning by explaining the brand scan limit in depth, clarifying that max_results has no 500 cap, and describing how the backend handles each filter, which elevates it above baseline.

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 it searches/lists products with specific attributes (SKU variants, price, brand, stock, image URL). It distinguishes itself from sibling read tools like get_product_by_sku and get_product_variants by being the general search/list entry point.

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 usage context, including when to narrow using category_id or keyword when brand scan is incomplete, and notes that other filters are backend-handled. It does not explicitly name alternative tools, but the guidance on when to use and when not to trust results is strong.

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