vsz_update_zone

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

No annotations are provided, so the description must fully disclose behavior. It says 'update' but does not explain whether unspecified fields are left unchanged, what happens if the zone_id does not exist, or any required permissions. This is minimal disclosure for a mutation tool.

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 brief and front-loaded with the purpose statement. The Args list is structured and provides essential information without redundancy, making every sentence earn its place.

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?

This is a simple tool with 4 parameters and an output schema. The description covers the action and parameter meanings, but lacks usage guidance and behavioral context. It is minimally adequate for a straightforward update operation, but not rich enough to fully inform the agent.

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 schema has 0% description coverage, so the Args list in the description compensates by explaining each parameter: host is the controller IP/hostname, zone_id is the UUID, and name/description are the new values. This adds clear meaning, though it does not explicitly note that name and description are optional or that null means no change.

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 explicitly states 'Update an existing zone's configuration', which is a specific verb and resource. This clearly distinguishes it from sibling tools like vsz_create_zone, vsz_delete_zone, and vsz_get_zone.

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 provides no explicit when-to-use or alternatives. It merely states the action, leaving the agent to infer that this is the tool for updating a zone, but does not mention when not to use it or compare to other zone operations.

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