vtex_list_coupons

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

With no annotations provided, the description carries the full burden of behavioral disclosure. 'List all coupons' implies a read-only operation, but it doesn't specify if it's paginated, rate-limited, requires specific permissions, or what the output format is. This is inadequate for a tool with zero annotation coverage, as key behavioral traits are missing.

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 'List all coupons' is extremely concise—three words that directly convey the core action. It's front-loaded with no unnecessary elaboration, making it efficient and easy to parse for an AI agent.

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 complexity (a list operation with no parameters) and lack of annotations and output schema, the description is incomplete. It doesn't address behavioral aspects like pagination, sorting, or output format, which are crucial for proper tool invocation. This leaves significant gaps in understanding how the tool behaves.

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 input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description doesn't add parameter details, which is appropriate here. A baseline of 4 is applied since the schema fully covers the parameters (none), and the description doesn't need to compensate.

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 'List all coupons' clearly states the verb ('List') and resource ('coupons'), making the purpose understandable. However, it lacks specificity about scope or format, and doesn't differentiate from sibling tools like 'vtex_get_coupon' (singular) or 'vtex_archive_coupon', which is a gap in sibling differentiation.

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?

No guidance is provided on when to use this tool versus alternatives. For example, it doesn't specify if this should be used for bulk retrieval versus 'vtex_get_coupon' for single coupon details, or mention any prerequisites like authentication or context. This leaves the agent without usage direction.

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