catalog_update_catalog_item_version

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

Annotations already disclose that this is a non-read-only, non-destructive, non-idempotent, open-world mutation. The description adds a useful behavioral rule beyond the annotations: an empty-string formId nullifies the value. It does not disclose authorization needs, side effects, or response behavior.

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 first sentence is repeated verbatim, which is wasted space. The REST endpoint line is useful but the duplicate opening sentence makes the description less front-loaded than it should be.

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 mutation tool with annotations and full schema coverage, the description is minimally adequate. It explains the formId nullification behavior but omits prerequisites, permissions, and what the operation returns.

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 description coverage is 100%, so the schema already documents all three parameters. The description adds meaning beyond the schema by explaining that an empty-string formId is treated as nullification rather than an ordinary patch 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?

The description states a specific verb (Patch) and resource (catalog item version) and ties it to formId. It is clear what the tool does, but it does not differentiate this tool from adjacent catalog update tools such as catalog_update_catalog_item.

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?

There is no explicit guidance on when to use this tool versus catalog_update_catalog_item, catalog_get_version_by_id, or other version-related siblings. The only usage signal is implicit from the phrase 'with form id'.

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