Update a Twenty CRM record

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

Annotations already indicate readOnlyHint=false, destructiveHint=true, and idempotentHint=true, so the description does not need to repeat these. The description aligns with annotations by stating 'patch', which is a write operation. However, it adds no extra behavioral context such as error handling or what happens on missing records, which would be helpful given the destructive hint.

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 a single, efficient sentence that conveys the core purpose without any extraneous words. It is perfectly concise and 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 that there is no output schema and the tool has moderate complexity (5 params, nested objects), the description could mention what the response contains (e.g., updated record or success confirmation). It adequately covers the action but leaves the return value unspecified.

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 description coverage is high (80%), with clear descriptions for most parameters (id, entity, depth, response_format). The description adds no parameter-specific details beyond what is in the schema, so its contribution is neutral. 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 'Patch one record' with the verb 'patch' and resource 'one record', scoped by 'allowed business object' and 'UUID'. This distinguishes it from sibling tools like batch create/update and soft delete, making the tool's purpose 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 provides no guidance on when to use this tool versus alternatives. It does not mention batch operations for multiple records or other update strategies, leaving the agent to infer usage context from the sibling tool list.

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