getDevice

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

Discloses that the tool is deprecated and that it filters the site device list in-process rather than being a dedicated API endpoint. Without annotations, this provides useful behavioral context.

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 sentences pack deprecation warning, alternative, and purpose. The contradiction slightly harms clarity, but overall it is concise and front-loaded.

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?

Lacks output schema and does not explain what data is returned, error handling, or how the in-process filtering works. The deprecation and contradictory purpose leave gaps for an agent to determine correct usage.

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 covers 67% of parameters with descriptions; deviceId lacks description. The description adds context about siteId defaulting but does not explain deviceId or customHeaders beyond the schema.

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 the tool is deprecated and to use listDevices, but also claims to 'Fetch detailed information for a specific Omada device', which contradicts the earlier statement that no dedicated per-device endpoint exists. This muddles the purpose.

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 directs users to use listDevices instead, providing clear guidance on when not to use this tool. However, it does not clarify when one might still want to use getDevice despite deprecation.

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