get_vlans

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

readOnlyHint=true already declares the safety profile, and '[READ]' merely restates it. The one genuine addition is '(driver support varies)', which warns the agent that output completeness depends on the platform driver — a useful behavioral caveat not present in annotations, though error/auth behavior remains unstated.

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?

Front-loaded and compact: the resource and return shape come first, arguments second. The '[READ]' prefix is redundant with the annotation but costs only a few tokens, so the structure is efficient.

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?

For a simple one-parameter read with annotations covering safety, the description covers purpose, return fields, and a driver caveat. With no output schema the field list does real work, though null-target behavior and error cases are left implicit.

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 carry the load; 'target: Device name from config' does supply the meaning and provenance of the single parameter, which the schema lacks. However, it omits that target is optional (default null) and what happens if it is omitted, leaving partial compensation.

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?

States a clear verb+resource (retrieve VLANs) and even enumerates the returned fields (id, name, member interfaces), which is more specific than most siblings. It does not explicitly distinguish itself from adjacent tools like get_interfaces or get_mac_address_table, so it stops short of full differentiation.

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 when-to-use guidance, no prerequisites, and no mention of alternative tools. The presence of 'target' implies a device-scoped read, but nothing tells the agent when to prefer this over the other get_* siblings.

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