Documents: Update

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

The description merely says 'Update', which is consistent with the annotations (readOnlyHint=false). However, it adds no additional behavioral context beyond the annotation and schema. It does not disclose what happens on success/failure, whether the operation is idempotent, or any side effects. With annotations present, the bar is lower, but the description still fails to add value.

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 with no wasted words. It clearly states the core function. However, it could benefit from slightly more detail (e.g., partial update behavior) without becoming verbose.

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?

For a mutation tool with no output schema, the description should clarify what is returned (e.g., updated document) or error conditions. It lacks completeness for the agent to fully understand the tool's behavior. The 100% schema coverage and annotations help but do not compensate for missing operational context.

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 100%; the description adds no extra meaning beyond what the schema provides. The baseline is 3, and there is no additional parameter guidance or examples to exceed that.

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 states the verb 'update' and resource 'document', and specifies the updatable fields 'title or content'. It clearly distinguishes from sibling tools like documents-create (create) and documents-get-by-id (read). However, it does not explicitly mention that updates are partial (only provided fields are updated), which would enhance clarity.

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 provides no guidance on when to use this tool versus alternatives. It does not mention prerequisites, when not to use it, or suggest other tools for different scenarios. This is a significant gap given the many sibling tools.

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