myob_entity_prepare_update

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

With no annotations provided, the description carries the full burden. It does not disclose whether this tool makes a network call, whether it mutates data, whether authentication is required, or what the output schema represents. The term 'prepare' hints at a two-phase commit but that is not explicitly stated.

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 sentence, so it is concise. However, it is under-specified, omitting essential information about behavior and parameters. It is concise but not effectively informative.

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?

This is a complex tool with 6 parameters, nested objects, and an output schema, yet the description is only one sentence. It does not explain the prepare/commit workflow, return values, or parameter relationships. The tool is severely under-documented given its complexity and the absence of annotations.

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%, and the description does not describe any of the six parameters. While parameter names like 'entity', 'uid', and 'json_body' are self-explanatory, the description adds no clarity about formats, relationships, or how 'layout' and 'summary' affect the operation. The description fails to compensate for low schema coverage.

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 specifies the action 'prepare update' and the resource 'supported entity', which is somewhat clear. However, it does not explain what 'prepare' means or distinguish this generic tool from sibling update tools like 'myob_customer_prepare_update' or 'myob_raw_prepare_mutation'. The phrase 'using the endpoint registry' is vague.

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?

There is no guidance on when to use this tool versus alternatives. The description does not mention any specific contexts, prerequisites, or exclusions, and it fails to differentiate this tool from the many other prepare tools in the sibling list.

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