get_sdwan_config

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

No annotations are provided, and the description does not disclose any behavioral traits such as read-only, destructive potential, or authorization needs. Merely states it returns configuration details.

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 concise but includes an extra Args section that does not match the schema, reducing clarity. The Returns line is empty. It is front-loaded but not entirely accurate.

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 simple get-by-ID operation, the description is minimal. It does not explain behavior on missing IDs, error handling, or provide details about the output despite an output schema existing. The mismatch between Args and schema further detracts from 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 description lists two parameters ('settings', 'config_id') in the Args block, but the input schema only contains 'config_id' as a required property. This mismatch misleads about available parameters. Schema description coverage is 0%, so the description fails to add meaningful semantic 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?

Clearly states 'Get SD-WAN configuration by ID', using a specific verb and resource. Distinguishes from siblings like 'list_sdwan_configs' and 'get_sdwan_config_status'.

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?

Implies usage for retrieving a specific config by ID, but lacks explicit guidance on when to use this tool versus alternatives, or any prerequisites.

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