Update Equipment Model (Company)

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

The description adds valuable behavioral context beyond annotations: it specifies that only supplied fields are changed (partial PATCH behavior) and that the modified object is returned on success. Annotations already indicate non-read-only and non-destructive, so the description complements them without contradiction.

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 concise—two sentences covering purpose, update behavior, and return value, plus a brief endpoint reference. Every sentence is necessary and front-loaded with the core function.

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 no output schema, the description states that the modified object is returned. It includes the endpoint and API version. All essential information for an update operation is present: what it does, partial update, required params, and return. No gaps.

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 coverage is 100% with clear descriptions. The description highlights required parameters (model_id, company_id) and explains that only supplied fields are changed, which clarifies the partial update semantics. This adds meaningful context beyond the schema.

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 it updates an equipment model at the company level, with a specific verb ('Update') and resource ('equipment model (Company)'). It distinguishes itself from sibling tools like 'create_equipment_model_company' and 'delete_equipment_model_company' by explicitly stating it updates existing records.

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 tells when to use this tool ('Update an existing Equipment records') and implies partial updates. It does not explicitly state when not to use it or mention alternatives, but the context is clear for a standard update operation.

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