akb_update

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

No annotations are provided, and the description gives only basic behavioral context (mutation, partial update). It does not disclose concurrency control details (OCC pins), side effects, or authentication requirements.

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 two short, clear sentences with no unnecessary words. It front-loads the core action and key usage rule.

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 complexity (12 parameters, concurrency controls), the description is too brief. It omits explanation of commit message, OCC pins, and the relationship with similar tools like 'akb_edit'. The lack of output schema also requires more behavioral description.

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 coverage is 75%, so most parameters already have descriptions. The description adds the helpful principle of partial updates, but does not elaborate on the optional OCC or content hash parameters, which are important for correct usage.

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 action ('Update an existing document') and resource, but does not distinguish it from the sibling tool 'akb_edit', which likely has similar semantics.

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 instruction 'Only provide fields you want to change' implies partial update behavior, but there is no explicit guidance on when to use this tool versus alternatives like 'akb_edit' or 'akb_put'.

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