appliance_get

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

No annotations are provided, so the description bears full responsibility for behavioral disclosure. It indicates 'full details' suggesting a read operation and mentions 'versions, images required', but does not explicitly state it is read-only or describe any side effects, permissions, or response structure.

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 a single, front-loaded sentence with no redundant words. It conveys the core purpose efficiently, though it could be more informative without sacrificing conciseness.

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 tool has one parameter, an output schema exists, and sibling tools are abundant. The description is minimal but mentions 'versions, images required' which gives some context. However, it does not explain what 'full details' encompasses or how the output schema relates.

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 one parameter 'appliance_id' with no description (0% coverage). The tool description does not explain this parameter beyond its name, failing to add meaning or context such as expected format or source. A description should clarify what the ID represents.

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 'Get full details for an appliance', using a specific verb and resource. It distinguishes from sibling tools like appliance_install and appliances_list by specifying 'full details' including versions and images.

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 implies usage for retrieving detailed information about a specific appliance but provides no explicit guidance on when to use this tool versus alternatives like appliances_list or image_get. No when-not or exclusions are mentioned.

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