list_devices

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

No annotations exist, so the description carries the full behavioral burden. 'List all' implies a non-mutating read, and the description helpfully discloses the returned fields (hostname, system-ip, device-type, status, site-id, version), but it says nothing about pagination, result limits, permissions, or whether the response is a flat array — real gaps for a zero-annotation tool.

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 tight sentences: purpose first, return contract second. No filler, no restated title, and the scope enumeration earns its place by telling the agent which device types appear.

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?

With one optional parameter, no output schema, and no annotations, the description covers purpose plus the return fields, which is most of what an agent needs. It falls short only on the optional model filter and on result-size/pagination behavior.

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 100% and the single optional 'model' filter is already documented with examples in the schema. The description mentions no filtering at all, so it adds nothing beyond the schema; baseline 3 applies.

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 gives a specific verb and resource ('List all devices in the SD-WAN fabric') and enumerates the device families covered (vEdges, vSmarts, vBonds, vManage), so an agent knows exactly what is returned. It does not differentiate itself from nearby siblings such as list_vedge_inventory, list_reachable_devices, or get_device_details, which keeps it below a 5.

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?

Usage is only implied: 'List all devices' suggests an inventory-listing tool, but there is no statement of when to prefer it over list_reachable_devices (reachability-focused) or get_device_details (single-device deep dive). No exclusions, prerequisites, or alternatives are named.

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