Get Virtual_machine

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

The description adds details about return formats (Markdown default, JSON option) beyond the annotations which already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint. No contradiction with annotations.

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 very concise, two short paragraphs, front-loaded with the main purpose, and no extraneous information.

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 annotations and schema coverage, the description provides complete context: it explains when to use, what parameters are needed, and what the return options are. No output schema exists but the description addresses it.

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 covers 100% of parameters. The description adds value by explaining the purpose of response_format ('Use json when chaining follow-up tool calls'), which is not 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 states 'Get a single virtual_machine from NetBox by numeric id', which is a specific verb+resource. It clearly distinguishes from the sibling tool netbox_list_virtual_machines that is used for listing.

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 guides when to use: 'Use after netbox_list_virtual_machines has located the object, or when you already have the id.' This provides clear context on when it is appropriate.

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