zdx_list_locations

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

Describes the tool as 'Read-only,' consistent with annotations. Adds behavioral details: results are 'curated id/name rows' and 'since' parameter is in hours with a 2h default. No contradiction with annotations.

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?

Extremely concise: three sentences. First sentence gives purpose, second provides usage guidance and output utility, third explains a parameter. No redundancy or fluff.

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?

No output schema exists, and the description only says 'curated id/name rows,' which is vague about the actual return structure. Missing details on 'search' parameter behavior and potential pagination. Adequate for a simple list but not fully complete.

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 description coverage is 33% (only 'query' described). The description adds meaning for 'since' (units and default) but does not clarify 'search' or the 'query' parameter's usage beyond the schema. Compensates partially, not fully.

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?

Clearly states 'List ZDX locations as curated id/name rows,' providing a specific verb and resource. Distinguishes from sibling tools (e.g., zdx_list_devices) through the resource name and the 'curated' qualifier, which implies a filtered result set.

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 states that the tool is read-only and that returned 'id' values can be used as 'location_id' scope filters on other ZDX tools. Provides usage context but lacks explicit 'when not to use' or alternative tool references.

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