getStackNetworkList

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

With no annotations, the description bears full responsibility. It indicates a read operation but lacks details on pagination, rate limits, authentication needs, or any side effects. The description does not go beyond the minimal verb+object.

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 well-organized sentences with a clear action, output description, and a prerequisite tip. No redundant or extraneous information.

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 tool with 5 parameters and no output schema, the description only vaguely explains the return value ('VLAN interface assignments'). It lacks details on format, structure, or any example. While the schema covers parameter domains, the description should provide more context on the output to be minimally complete.

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 covers 100% of parameters with descriptive texts and constraints (e.g., page, pageSize, stackId). The description adds no additional parameter semantics beyond what the schema already provides, meeting the baseline for high schema coverage.

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 action: 'Get the VLAN network list for a switch stack' and specifies the output: 'Returns VLAN interface assignments across all stack members.' This distinguishes it from sibling tools like getStackPorts or getSwitchStackDetail.

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 provides a prerequisite instruction: 'Use getSwitchStackDetail to get the stackId,' but does not explicitly state when to use this tool versus alternatives or any exclusion criteria. The guideline is helpful but limited.

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