getStackNetworkList

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

The description implies a read-only operation but provides no explicit behavioral traits beyond the obvious 'Get' nature. With no annotations, the description carries the full burden; it lacks details like pagination behavior (though schema shows page/pageSize), performance impact, 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 extremely concise: one sentence for purpose plus one short tip. Every word adds value with no redundancy or filler.

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 no output schema, the description explains the return (VLAN interface assignments across all stack members) sufficiently. It covers the key outcome, though more detail on return structure could be helpful. Overall adequate for a list tool with well-documented parameters.

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 coverage is 100%, so parameters are well-defined in the schema. The description adds minimal extra meaning; it only reiterates that stackId comes from getSwitchStackDetail. Baseline of 3 is appropriate as the schema does the heavy lifting.

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 it retrieves the VLAN network list for a switch stack, specifying it returns VLAN interface assignments across all stack members. This distinguishes it from sibling tools like getSwitchDetail or listSwitchNetworks by focusing on stack-specific VLANs.

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 gives a clear prerequisite: 'Use getSwitchStackDetail to get the stackId.' This instructs the agent on obtaining the required parameter. However, it does not mention when to choose this tool over alternatives like listSwitchNetworks, or when not to use it.

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