getStackNetworkList

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

No annotations are provided, so the description carries the full burden. It states the return value is 'VLAN interface assignments across all stack members', but does not disclose side effects, permissions, or confirm read-only behavior. For a simple GET, this is minimally sufficient.

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?

Two sentences with no extraneous information. The first sentence states the purpose, the second provides a key prerequisite reference. Efficient and well-structured.

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 very brief. It does not explain pagination behavior, error conditions, or contrast with sibling tools like listSwitchNetworks. Given the tool's simplicity and rich schema, it is adequate but leaves gaps for a less-informed agent.

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 100% coverage, with all 5 parameters fully described in the schema. The description adds no additional parameter semantics beyond referencing getSwitchStackDetail for stackId, so baseline 3 is appropriate.

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 the verb 'get' and the resource 'VLAN network list for a switch stack', and distinguishes itself from sibling tools by noting which tool to use to obtain the required stackId.

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 explains that the tool is for retrieving VLAN network lists for a switch stack and provides a prerequisite hint to use getSwitchStackDetail for the stackId. It does not explicitly contrast with similar list tools like listSwitchNetworks, but the context is adequate.

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