Bulk Update Company Observation Templates

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

Annotations declare readOnlyHint false and destructiveHint false, indicating a write operation. The description adds that it performs a partial update ('only supplied fields are changed') and returns the modified object. It also specifies the HTTP method (PATCH) via the endpoint. This adds context beyond annotations.

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, using two main sentences plus a required parameter note and API reference. The first sentence repeats the title, but overall it is efficient and well-structured.

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?

The description explains the update behavior and return value. However, it does not clarify the role of the 'observation_template_ids' parameter (whether it's required for specifying which templates to update) or how partial failures in a bulk operation are handled. Given the tool's complexity, this missing detail reduces completeness.

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 input schema covers 100% of parameters with descriptions. The description notes the required company_id but adds no further meaning beyond the schema. For a high-coverage schema, a 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 clearly states the verb 'Bulk Update' and the resource 'Company Observation Templates'. It distinguishes from sibling tools like 'bulk_update_project_observation_templates' by specifying 'company' in the name and description. The scope is unambiguous.

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 indicates when to use the tool: 'to update an existing Observations (only the supplied fields are changed)'. It provides a precondition (required company_id) but does not explicitly mention when not to use it or alternatives (e.g., project-level counterpart). The guidance is adequate but lacks exclusions.

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