Update Accident Log

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

Adds context beyond annotations: specifies PATCH behavior (partial update), returns modified object, and references a guide for attachments. Annotations only indicate non-read-only, non-destructive, non-idempotent.

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?

Description is concise at 5 sentences, includes key information and a link. Minor redundancy ('Update single Accident Log' and 'Use this to update') but not detrimental.

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?

Covers operation, partial update, required params, return value. Lacks error handling details but sufficient for an update tool. With no output schema, description adequately compensates.

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 coverage is 100% so baseline 3. Description lists required parameters and mentions 'only supplied fields' but does not explain param structure beyond schema. Attachments reference a guide.

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 single Accident Log' and explains it updates existing Daily Log records, with only supplied fields changed. It distinguishes from sibling tools like create_accident_log and delete_accident_log.

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?

Describes when to use (to update existing records) and mentions only supplied fields are changed. However, it does not explicitly exclude other operations or provide alternatives.

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