sdcloud_preview_firewall_policy

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

With no annotations, the description must disclose behavioral traits. It indicates 'preview' which implies a read-only diff, but does not explicitly state that no changes are made, nor does it mention authentication or rate limits. Adequate but not fully 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 two sentences and directly conveys the purpose and required body structure without unnecessary words. It's well-structured and front-loaded.

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?

The description explains what the tool does and what the body requires, but does not mention the output format or return value, which is important for a preview tool. It also lacks context on synchrony or job execution. Adequate but incomplete for a more complex tool.

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% with minimal descriptions. The description adds significant value by specifying that the body requires deploy_targets and/or undeploy_targets with a structure of {target_id, target_type}, compensating for the schema's lack of detail.

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 tool 'previews the configuration diff' of a firewall policy deployment, distinguishing it from deploy or cleanup siblings. The verb 'preview' and resource 'firewall policy' are specific and unambiguous.

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 specifies that the body requires deploy_targets and/or undeploy_targets, guiding on required input. However, it does not explicitly state when to use this tool versus alternatives like sdcloud_deploy_firewall_policy or sdcloud_selective_deploy_firewall_policy.

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