update_entity_metadata

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

With no annotations, the description carries the full burden and largely meets it: it discloses the write nature, the required write scope, the destructive semantics of mode='overwrite' ('rebuilds it'), the preservation semantics of 'merge', and a read-back verification. It omits edge behavior such as what happens to fields not mentioned in a merge or any rate limits.

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?

Front-loaded with the purpose and the WRITE OPERATION/scope warning, then parameter detail. The 'fields' schema description is dense but every element earns its place; no filler sentences.

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?

An output schema exists, so return values need not be spelled out, yet the description still summarizes the read-back verification. Combined with the write-scope note and mode semantics, this is nearly complete for a 6-param write tool; only the trace_id parameter and merge edge cases are unaddressed.

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 0%, so the description must compensate, and it does for the complex parameters — it gives the JSON shape of 'fields' ({key, value | values, type, group_id, allow_multi_values, description}), the structure of 'groups' ([{id, name}]), and the default/values of 'mode'. The simple params (id, entity_type) are self-evident, but 'trace_id' is left undocumented.

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?

States a specific verb ('Update') and resource ('metadata (custom fields)') and enumerates the four entity types it applies to, so the agent knows what it targets. It does not differentiate itself from the sibling 'update_entity_fields', which sounds like a near-identical operation, leaving a routing ambiguity.

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 explains the merge vs overwrite modes and flags 'WRITE OPERATION — requires the update write scope', which is useful operational guidance. However, it never states when to choose this tool over the sibling 'update_entity_fields', so the agent must infer the distinction.

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