zdx_list_devices

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

Annotations already declare readOnlyHint=true, which the description reinforces. The description adds valuable behavioral context: it returns one row per device with specific fields, lists filter types (email, user ID, MAC/IP, location/department/geo), and clarifies that the 'since' parameter is in hours. It does not contradict 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?

The description is concise with three sentences, front-loading the main purpose and read-only nature. Every sentence adds value: purpose/output, filters/usage guidance. No wasted words.

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?

The description covers the main use cases: listing devices, filtering, and using IDs for further operations. It mentions the output fields and filter types. However, it omits mention of pagination via the 'offset' parameter, which is relevant given many optional filters. Overall, it is largely complete for a read-only list tool.

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?

With schema description coverage at only 10%, the description partially compensates by listing filter categories (email, user ID, MAC/IP, location/department/geo) and specifying the 'since' unit in hours. However, it does not explicitly map these to parameter names, leaving some parameters (offset, query) outside the description. The meaning added is moderate but not exhaustive.

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 verb 'list', the resource 'active ZDX devices', and specifies the output (one row per device with id, hostname, owning user). It also distinguishes from siblings by mentioning the use of returned device ids with other ZDX tools like zdx_get_device and deep-trace/probe tools.

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 explicitly advises using the returned device id with zdx_get_device or deep-trace/probe tools, providing clear context for when to use this tool. However, it does not explicitly state when not to use it or list exclusions.

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