Update A Time Off Record

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

Annotations indicate it is a mutation (non-read-only) and not destructive. The description adds that it performs a partial update (only supplied fields changed) and returns the modified object, but does not disclose permissions, error handling, or side effects.

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 contains repetition (e.g., 'only supplied fields are changed' appears twice) and extraneous details like the full endpoint path. It could be more concise while retaining key information.

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 complexity (11 parameters, no output schema), the description explains partial update and lists required parameters, but lacks details on return format, error conditions, or validation rules, making it adequate but not comprehensive.

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?

Input schema has 100% coverage with parameter descriptions. The description redundantly lists required parameters but adds no semantic meaning beyond the schema, such as value constraints or behavior when fields are omitted.

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 existing Time Off record for a specified person and company, and that only supplied fields are modified. The verb 'update' and resource identification are specific, but it does not explicitly differentiate from sibling CRUD tools like create or 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?

The description says 'Use this to update an existing Resource Planning records' implying when to use, but it does not explicitly mention when not to use or provide alternatives such as create_time_off_for_a_person for new records.

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