listDevices

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

With readOnlyHint=true and destructiveHint=false already covering the safety profile, the description still adds real value by scoping the result to adopted devices only and predicting the exact fields returned (MAC, model, firmware, IP, uptime, CPU/memory, status). It does not mention pagination or result-size behavior for large sites, which is the main remaining gap.

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?

Three sentences, front-loaded with the verb and scope, then the return payload, then the follow-up routing. Every sentence supplies information the agent needs and none repeats the schema or annotations.

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?

For a single-parameter, read-only listing tool with no output schema, the description supplies the scope, the shape of the response, and the natural next call. Nothing an agent needs in order to invoke it correctly is missing.

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 coverage is 100% and the siteId property already documents the default-site fallback and the listSites discovery path, so the description carries no additional parameter burden. Its phrase 'in a site' merely restates the parameter's role, so the baseline of 3 is appropriate.

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 states a specific verb and resource ('List all provisioned (adopted) network devices in a site') and enumerates the three device classes covered. The word 'provisioned (adopted)' distinguishes it from the sibling listPendingDevices, and the whole-site enumeration distinguishes it from per-device getters like getSwitchDetail.

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?

It gives clear downstream guidance: the MAC addresses returned should be fed into getGatewayDetail, getSwitchDetail, getApDetail or similar. It does not explicitly contrast with searchDevices or listDevicesStats, so the agent must infer when to prefer searching or stats over a full listing, but the intended workflow is unambiguous.

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