update_record

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

No annotations are provided, so the description carries full burden. It clearly discloses that the tool performs a PUT mutation and describes the two-phase pattern (preview vs actual update). It does not detail authentication or error behavior, but the core behavioral trait is well explained.

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 consists of two efficient sentences. The first states the purpose and endpoint, the second provides critical usage guidance. No wasted words, and the key 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?

Given the tool has 4 parameters (3 required) and nested objects, the description covers the essential behavioral aspect (confirm pattern). It mentions 'returns a preview' for confirm=false, which is helpful, though it could be more specific about the preview contents or success/error responses.

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 is 3. The description adds value by explaining that body is a 'Full JSON body with updated fields' and reinforces the confirm parameter's purpose with 'Set ONLY after explicit user approval.' This goes beyond the schema's description.

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 starts with 'MUTATING: update a record via PUT /api/{object_type}/{record_id}', clearly stating the action (update) and resource (record). This distinguishes it from sibling tools like create_record, delete_record, and archive_record.

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 provides explicit guidance on when to use confirm=false vs confirm=true, and warns against calling confirm=true without user approval. However, it does not explicitly state when to use this tool over siblings like archive_record or delete_record.

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