list_addresses

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

Discloses the JA011 error for improper scoping, but with no annotations it omits other behavioral traits like read-only nature, pagination behavior, or auth requirements. The description is partially transparent.

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?

Two succinct sentences: one stating purpose, the other providing critical usage detail. No unnecessary words, front-loaded with core action.

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 6 parameters, sibling tools, and available output schema, the description covers the main usage scenario and a key error. Could mention pagination behavior but not essential due to schema.

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?

Although schema coverage is 100%, the description adds value by contextualizing customer_id and supplier_id scoping and the correct API route, going beyond mere schema descriptions.

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 lists addresses and emphasizes scoping by customer or supplier. This distinguishes it from address CRUD siblings like create_address and get_address.

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?

Explicitly advises to scope with customer_id or supplier_id and warns against the flat query that raises error JA011, providing clear when-to-use and 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.