zyxel_show_vlan

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It only states 'Display VLAN information', implying a read-only operation, but does not explicitly confirm non-destructiveness, describe the output format, or mention whether all VLANs are shown when no vlanId is given. No side effects or device interaction details are disclosed.

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, concise sentence with no redundant verbiage. It is front-loaded with the verb and resource. However, it is slightly under-specified for a tool with an optional parameter, but this is more a completeness issue than conciseness.

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?

This is a simple tool with one optional parameter and no output schema, so the description is minimally viable. It fails to clarify behavior with and without vlanId, the return structure, or required connection state, which leaves gaps in completeness.

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 100% for the sole parameter vlanId, which includes a clear description ('Specific VLAN ID to show') and constraints (min/max). The tool description itself adds no extra meaning to the parameter, so the baseline of 3 is appropriate since the schema adequately handles parameter semantics.

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 uses a specific verb 'Display' and target resource 'VLAN information', which clearly distinguishes it from sibling tools like 'zyxel_create_vlan' (create). However, 'VLAN information' is somewhat vague, as it could imply a subset or full configuration, and it does not mention the optional vlanId scope.

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 provides no guidance on when to use this tool versus alternatives, such as when to use 'zyxel_show_interfaces' or 'zyxel_create_vlan'. It also fails to mention prerequisites (e.g., an active connection to the device) or contexts where this tool is appropriate.

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