entity_update

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

The description reveals the soft-delete/restore behavior via the deleted flag, adding context beyond the annotations. However, it does not disclose whether updates are merged or replaced, or mention side effects like validation or permissions.

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, concise sentence that directly conveys the tool's purpose without unnecessary detail.

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's simplicity, the description covers the core update behavior but lacks information about return values, partial vs. full updates, and the meaning of project/namespace in context. These gaps could lead to ambiguity for an agent.

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?

The description partially explains the 'updates' parameter by mentioning fields, aliases, and deleted, but does not clarify the roles of 'id', 'project', or 'namespace'. Schema coverage is low, but the description adds meaning to the most important update fields.

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 the tool updates entity fields, aliases, or the deleted flag for soft-delete/restore, distinguishing it from sibling tools like entity_add or entity_get.

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?

No explicit guidance on when to use this tool versus alternatives such as entity_add or entity_update (though entity_update is unique). It does not mention prerequisites or scenarios where this should be preferred.

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