Get detailed device information

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is settled. The description adds only the scope of information retrieved; it says nothing about requiring an authenticated session (a sibling tool handles auth), what happens on an unreachable/unauthenticated device, or latency/timeout behavior.

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?

A single front-loaded sentence with no filler; each enumerated field is informative rather than redundant, and there is nothing to trim.

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?

A simple one-parameter read tool with full annotation coverage, a fully documented schema, and no output schema to explain, so the description needs little more. The one meaningful omission is the authentication precondition, which matters given the pi_device_authenticate sibling.

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 device_id property already documents the accepted forms (IP, hostname, MAC, device identifier). The description adds no additional meaning about identifier resolution or ambiguity handling, so the schema carries the load and the baseline of 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?

States a specific verb ('Get') and resource ('detailed ... information for a device') and enumerates the returned facets (hardware model, OS, storage, memory, uptime, ctrlPi), which clearly separates it from the sibling pi_devices_list that enumerates devices. It stops short of naming the alternative explicitly, so it is clear but not maximally differentiated.

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: the required device_id and the 'for a device' phrasing suggest calling this after picking a device from pi_devices_list. There is no explicit when-to-use/when-not, and no mention of the sibling pi_device_authenticate as a prerequisite or alternative when a device is not yet authenticated.

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