restart_vm

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

No annotations are provided, so the description carries full burden. It only states 'restart' without disclosing behavioral traits like downtime, potential data loss, or the need for the VM to be in a running state. This lacks sufficient transparency for an agent.

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 short and to the point, with a structured args list. It avoids unnecessary prose and is front-loaded. However, it could be slightly improved by integrating the parameter explanations naturally.

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?

Given the tool's simplicity (2 params, output schema exists), the description covers the basic purpose and required inputs. However, it lacks context about side effects, posture (e.g., VM must be running), and when to choose this over siblings. It is minimally adequate but not comprehensive.

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?

Input schema has 0% description coverage, so description must compensate. The description merely repeats the parameter names as 'Resource group name' and 'Virtual machine name', adding no additional semantic meaning like constraints, formats, or examples. This adds minimal value over the schema alone.

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 'Restart a virtual machine.' with specific verb and resource. It is distinct from sibling tools like start_vm, stop_vm, and deallocate_vm, which have different purposes.

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 explicit guidance on when to use this tool vs alternatives. The tool name implies restarting a running VM, but the description does not clarify prerequisites (e.g., VM must be running) or contrast with start/stop. Usage is implied but not explicit.

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