set_port_vlan

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

Annotations already provide destructiveHint=true, so the description adds value by explaining the two modes (preview/apply) and the required parameters for apply. However, it does not disclose what gets destroyed (previous VLAN assignment), auth needs, or the return format, which is especially relevant without an output 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 a single 14-word sentence that front-loads the main purpose and provides essential usage details. Every word is necessary and there is no redundancy.

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 moderate complexity (5 nested parameters, destructive, preview/apply modes) and lack of output schema, the description covers the basic usage scenario but omits what the preview output looks like, error conditions, and the specific meaning of the required parameters. It is adequate but not complete.

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 description coverage is 0%, so the description must compensate. It explains the purpose of dry_run and confirmation parameters (e.g., apply requires dry_run=false and confirmation='CONFIRM'), which adds meaning beyond the schema defaults. However, it does not explain the required parameters device_id, interface, and vlan_id, leaving a gap.

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 the tool is for previewing or applying a port VLAN change, which is a specific verb-resource combination. It distinguishes from read-only sibling tools like get_device_info and get_vlan_list by indicating a mutation 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 explicitly states the conditions for applying (dry_run=false and confirmation='CONFIRM'), providing clear guidance on when to use preview vs apply. However, it does not mention when not to use the tool or any alternative tools, though siblings are all read-only.

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