describe_vswitches

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

Annotations already indicate readOnlyHint true. Description reinforces read-only behavior with the query verb and adds the constraint about required parameters. No contradictions.

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?

Structure is clear with Args and Returns sections. Front-loaded with action statement. Could be slightly more concise but remains well-organized.

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?

Covers all parameters and return type. Output schema exists, so return details are implicit. Pagination is explained. For a simple list query, completeness is good.

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?

Description explains all parameters except 'is_default', which is present in schema but omitted. It adds defaults for page_number and page_size, and the mutual exclusion rule. With 0% schema coverage, this is significant value.

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?

Description starts with 'Query VSwitch list.', clearly stating the action and resource. It distinguishes from sibling tools like describe_vpcs by explicitly targeting VSwitches.

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?

States requirement that at least one of region_id or vpc_id must be specified, providing context for valid usage. However, it does not explicitly mention when to use this tool over alternatives 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.