list_vlans

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

With no annotations, the description carries the full burden of behavioral disclosure. It only states the action without detailing filtering behavior, pagination, archive inclusion, permissions, or return format. This is a minimal description that does not meaningfully exceed what the name implies.

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 short sentence, but it is under-specified rather than appropriately concise. It does not earn its place by adding useful information beyond the tool name. For a tool with 7 optional parameters, this level of brevity is not appropriate.

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 (7 parameters, no output schema, no annotations), the description is severely incomplete. It does not explain how to filter results, whether archived VLANs are included, or what the response structure is. This is inadequate for effective tool selection and invocation.

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%, and the description does not mention any of the 7 parameters. The schema also lacks parameter descriptions, so there is no added meaning. The description fails to compensate for the low coverage, leaving the parameters entirely unexplained.

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 'Get a list of VLANs' clearly states the verb (get/list) and resource (VLANs), and the plural form distinguishes it from singular get_vlan. However, it does not explicitly differentiate from other list tools or mention the scope of the listing, so it's clear but not maximally distinguishing.

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?

No guidance is provided on when to use this tool versus alternatives. Sibling tools like get_vlan exist for single retrieval, and other list tools may share patterns, but the description lacks any contextual cues or exclusions.

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