foundry_update_actor_embedded_documents

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

The annotation readOnlyHint=false already signals a write operation, so the description adds no new transparency about update semantics, data loss risk, or required permissions. It does not explain whether the update replaces or patches the documents array.

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 (nine words) that is front-loaded and immediately understandable. Every word earns its place.

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 mutation nature and lack of output schema, the description omits critical context such as whether updates require document _ids, whether it replaces or merges, and any side effects. It is minimally viable but leaves major gaps for correct invocation.

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 60%, but the description does not explain the structure or application of the 'documents' array or clarify the 'documentType' values beyond their names. It fails to compensate for the undocumented parameters.

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 uses the specific verb 'Update' and identifies the exact resource ('Items or ActiveEffects embedded in one actor'). It clearly distinguishes from sibling create/delete tools and other entity update tools.

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 implies usage context (updating embedded documents on a single actor) but does not explicitly state when to use it over the create/delete sibling tools or mention any exclusions. Usage is clear from context but not formally separated.

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