sdcloud_preview_nat_policy

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

No annotations are provided, so the description carries the full burden. It only states the tool previews a diff, without disclosing read-only nature, side effects, permissions, or rate limits. For a preview operation, more behavioral context (e.g., it's safe, no side effects) would be beneficial.

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 two sentences: one for purpose and one for body requirements. Every sentence adds value, with no fluff. It is front-loaded with the most important 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 preview tool with no output schema, the description omits important details like what the output (the diff) looks like, how to interpret it, and any prerequisites. It provides enough to use the parameters but lacks completeness around results and integration with deploy workflow.

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 50% (only body has a vague description). The description adds significant value by specifying required fields inside the body (deploy_targets and/or undeploy_targets with format), which is beyond the schema's generic description.

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 'previews the configuration diff a NAT policy deployment would produce', which is a specific verb ('Preview') and resource ('configuration diff a NAT policy deployment'). It easily distinguishes from sibling deploy tools like sdcloud_deploy_nat_policy and sdcloud_selective_deploy_nat_policy.

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 explicitly states what the body requires ('deploy_targets and/or undeploy_targets') and provides the format. While it doesn't explicitly say when not to use it or list alternatives, the context is clear for a preview operation.

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