getDevice

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

No annotations provided, so description must fully disclose behavior. It says 'Filters the site device list in-process' implying a read operation but does not mention side effects, permissions, error handling, or limitations beyond deprecation. Incomplete for a tool that may be unreliable.

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 each serve a purpose: deprecation, reason, and function. However, the mixed messaging (deprecated yet functional) slightly reduces clarity. Still reasonably efficient.

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 does not fully guide the agent on how to use alternatives (e.g., listDevices combined with getApDetail/getGatewayDetail). It lacks explanation of when this tool might still be used or its limitations relative to siblings. No output schema mentioned.

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 covers 67% with descriptions for siteId and customHeaders, but deviceId (required) lacks description. The description does not add meaning for deviceId beyond being required, so it adds minimal value over 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 deprecation and suggests using listDevices, but also claims to 'Fetch detailed information for a specific Omada device,' creating confusion about its actual function. The purpose is somewhat clear as a deprecated tool but the active capability is vague.

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 tells the agent to use listDevices instead, and explains why (no dedicated endpoint). This provides clear when-not and alternative guidance.

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