appliance_install

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

No annotations are provided, so the description must disclose potential side effects. It only says 'install' without indicating whether it is destructive, requires a running project, or has permission dependencies. The impact on system state is not explained.

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 sentence with 12 words, which is concise. However, it could be more informative while remaining succinct.

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?

Despite having an output schema, the description does not explain what the tool returns or any side effects. It lacks context about the installation process, prerequisites, or how it relates to other tools, making it insufficient for an AI agent to invoke correctly.

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 coverage is 0%, meaning the description does not explain any parameters. The description hints at version but gives no details about the appliance_id or version format. The meaning of 'appliance as a template' is also unclear in relation to parameters.

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 'Install an appliance as a template (optionally a specific version).' It identifies the verb 'install' and resource 'appliance as a template', but is ambiguous whether it installs an appliance that becomes a template or installs from a template. It does not distinguish from sibling tools like template_create or node_create_from_template.

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?

No guidance is provided on when to use this tool versus alternatives (e.g., image_install, template_create). There is no indication of prerequisites or contexts where this tool is appropriate or inappropriate.

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