appliance-get-vlans

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

Only the 'read-only' behavior is mentioned. No annotations are provided, so the description should disclose more, such as what happens if the VLAN is not found or authorization requirements.

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 very short (one sentence) and front-loaded with the action. It uses concise language with a parenthetical for read-only. However, it lacks structure like examples or return value hints.

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 description is incomplete for a simple getter. It doesn't mention what the returned VLAN object contains, error behavior, or that 'fields' can filter response. Given no output schema, this is a significant gap.

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 covers all parameters with descriptions (100% coverage). The tool description adds no additional meaning beyond the schema, which is acceptable but not above baseline 3.

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 'Return a VLAN (read-only)'. The verb 'Return' and resource 'VLAN' are specific. It distinguishes from sibling 'appliance-list-vlans' by implying a single VLAN retrieval.

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 on when to use this tool versus alternatives. The description does not mention that it is for fetching a specific VLAN by ID, nor does it contrast with the list sibling.

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