getAllDeviceBySite

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

No annotations are provided, so the description carries the full burden. It discloses that it includes offline and disconnected devices, which is the key behavioral trait. However, it does not mention any other behaviors like pagination, rate limits, or whether the operation is read-only (implied but not explicit).

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 short sentences. It front-loads the core action ('Get all devices in a site') and immediately adds the key differentiator. Every sentence adds value without redundancy.

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 no output schema, the description reasonably sets expectations: it returns the full device inventory including offline/disconnected devices, useful for auditing. It does not explain return structure or potential delays, but for a simple list tool with optional parameters, it is sufficiently 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?

The input schema has 100% coverage with descriptions for both parameters. The tool description does not add additional meaning beyond what the schema already provides (e.g., siteId defaults to config, customHeaders rarely needed). 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 clearly states the tool gets all devices in a site, including offline and disconnected devices. It distinguishes itself from the sibling tool listDevices by specifying that listDevices may filter to active-only, making the purpose and differentiation explicit.

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 explains when to use this tool (for full inventory, auditing) and contrasts with listDevices (which may filter to active-only). It does not explicitly state when not to use it, but the comparison provides sufficient guidance for selection.

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