get_vlans

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

With no annotations, the description must disclose behavioral traits. It reveals that the tool executes a show command, implying read-only behavior, but it doesn't describe the output format, potential authorization requirements, or what happens if no VLANs are configured. This is adequate for a simple read command but not rich.

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, front-loaded sentence that includes the exact CLI command in parentheses, providing high-value context with zero wasted words.

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?

The tool is simple (one parameter, no annotations, output schema exists), and the description provides the core purpose and command. However, it lacks any guidance on usage context or parameter meaning, making it minimally complete rather than fully self-sufficient.

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?

The input schema has one required parameter 'device' with no description (0% coverage). The tool description does not explain what 'device' is or how to format it, leaving the agent to infer it means the target network device. This is a minimal but non-trivial gap, so the description does not compensate for the schema's lack of detail.

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 reads "Show configured VLANs ('show vlan brief')." This uses a specific verb (Show) and a specific resource (configured VLANs), and the parenthetical command identifies the exact underlying operation, making it distinct from sibling queries like get_interfaces or get_trunks.

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?

There is no explicit guidance on when to use this tool versus alternatives such as run_show_command or other get_* tools. The purpose is clear, but the description does not state prerequisites, exclusions, or preferred contexts, leaving usage to inference.

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