Create Vm_interface

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

Annotations provide readOnlyHint=false, openWorldHint=true, etc. The description adds that it 'adds a new row' and specifies output formats (markdown/json). It does not contradict annotations, but omits details like error behavior or prerequisites beyond the schema.

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 front-loaded with the purpose. It avoids fluff but could be more structured (e.g., separate sections). Every sentence adds value, though one sentence is a tautology of the purpose.

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 (14 parameters, no output schema), the description is incomplete. It does not explain the need for a virtual machine ID, the distinction from device interfaces, or how to structure custom_fields. The output format info is helpful but insufficient.

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?

With schema description coverage at only 36%, the description provides no additional parameter details. The returns section is about output format, not parameters. This is insufficient for the 14 parameters, many lacking schema descriptions.

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 vm_interface in NetBox,' using a specific verb and resource. It distinguishes itself from siblings like netbox_get_vm_interface, netbox_update_vm_interface, and netbox_delete_vm_interface by indicating it is a create operation.

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 advises to ask about dry-run before calling, which is a safety guideline. However, it fails to clarify when to use this tool over netbox_create_interface (for physical devices), leaving a critical distinction unaddressed.

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