catia_set_document_properties

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

The annotations are all false and thus provide no behavioral information stub: readOnlyHint=false, idempotentHint=false, destructiveHint=false. The description only restates that the tool 'sets' fields, which is tautological, and does not disclose whether it operates on the active document, what happens when a field is omitted or set to an empty string, whether it overwrites existing values, or if any document type restrictions apply.

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?

Two sentences with zero redundancy. The first sentence introduces the action, resource, and field list; the second gives the motivational context. Every word earns its place, and the core information is 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?

For a mutation tool with 5 parameters and no output schema, an agent needs to know which document is modified (active document?), whether empty values clear fields or leave them untouched, and what confirmation is expected. None of this is mentioned. The description covers what the fields are but not how the tool behaves at runtime, which is a meaningful gap for a CATIA automation 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 description coverage is 100%, so each parameter already has a description (e.g., 'Part number.', 'Revision string.'). The tool description adds collective framing by calling them 'product identity fields' and explaining their downstream purpose, but it provides no additional per-parameter meaning, formatting constraints, or interaction rules. The baseline of 3 is appropriate.

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 opens with a specific verb ('Set') and a concrete resource ('product identity fields CATIA stores on a Part or Product document'), then enumerates the exact fields: part number, revision, definition, nomenclature and description. This precisely separates it from generic parameter-setting siblings like catia_set_parameter and gives the agent a clear mental model.

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 gives clear context: these fields flow into a bill of materials and a drawing title block, so an agent can decide when to use the tool. It does not explicitly name alternatives or exclusions, but the scope is evident and no competing sibling handles this exact set of identity fields.

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