Create Virtual_machine

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

Annotations already indicate a write operation (readOnlyHint=false) and non-destructive nature. The description adds context about return format and a safety caution (dry-run), but does not provide deeper behavioral details like side effects or permissions. With annotations present, the description provides moderate added value.

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 concise: three sentences covering purpose, a behavioral note, and return format. No redundant or irrelevant information, and it is front-loaded with the primary action.

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 complexity (22 parameters, no output schema, no examples), the description lacks critical guidance on parameter combinations (e.g., need for cluster or device_id), prerequisites, or error handling. While the return format is noted, the description is insufficient for an agent to confidently invoke the tool without additional context.

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 22 parameters with 50% description coverage. The tool description does not elaborate on any parameter meanings, expected values, or usage patterns beyond the schema. It fails to compensate for the parameters that are undocumented in the 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 clearly states 'Create a new virtual_machine in NetBox', specifying the verb (create) and resource (virtual_machine). It distinguishes from numerous sibling tools that perform other operations on VMs or different objects.

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 explicitly advises to ask the user if they want a dry-run before calling, providing a clear usage guideline for non-idempotent operations. However, it does not explicitly compare to alternatives like update or get, though the purpose is self-evident.

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