list_sdwan_configs

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

No annotations are provided, so the description must cover behavioral traits. It only states 'List all SD-WAN configurations' without disclosing pagination, permissions, rate limits, or any side effects. The read-only nature is implied but not explicit.

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, but it includes an inaccurate 'Args' section that takes space without value. It is not efficiently structured; front-loading would be better.

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 that the tool has an output schema and no parameters, the description could be minimal. However, it fails to explain the scope of 'all' configurations, any sorting or filtering, or how the output relates to other tools. The mention of a non-existent parameter further reduces completeness.

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 zero properties, but the description introduces a non-existent parameter 'settings: Application settings'. This directly contradicts the schema and misleads about required inputs, earning a low score.

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 states 'List all SD-WAN configurations,' which clearly indicates a list operation on SD-WAN configs. However, it includes an 'Args' section mentioning 'settings' that does not exist in the input schema, causing confusion. Siblings like get_sdwan_config imply singular retrieval, but the description does not explicitly differentiate.

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 like get_sdwan_config or get_sdwan_config_status. There is no mention of prerequisites, filters, or context for selection.

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