uc_catalog_update

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

Annotations only indicate readOnlyHint=false. The description adds no behavioral details beyond 'Update a catalog'. It does not mention whether the update is a partial or full replacement, required permissions, or side effects. With sparse annotations, the description provides insufficient transparency.

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 very concise (one sentence). While it avoids verbosity, it lacks critical details that would make it earn its place. It could be slightly more informative without becoming verbose.

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?

Given the tool has 6 parameters, an output schema, and is a mutation operation, the description is insufficient. It does not explain what happens on success, error conditions, or how the update behaves (e.g., partial vs full replacement). The completeness is low.

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 only 17% (only 'name' has a description). The tool description does not elaborate on any parameter meanings, formatting, or constraints. The parameter names (comment, properties, owner, new_name, tags) are somewhat self-explanatory but the description adds no value beyond the schema's minimal titles.

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 'Update a catalog', indicating a specific verb ('update') and resource ('catalog'). This distinguishes it from sibling tools like uc_catalog_create (create) and uc_catalog_delete (delete).

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?

No guidance on when to use this tool versus alternatives. It does not explain prerequisites, ideal use cases, or situations where other tools (e.g., uc_catalog_create) would be more appropriate.

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