update_document

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

No annotations provided. Description implies mutation but does not disclose whether updates are destructive, reversible, or require special permissions. Lacks details on behavior when fields are omitted.

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?

Single sentence, concise but could benefit from additional context. Appropriately short for a simple update, but lacks structure and essential details.

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?

Incomplete given three parameters, no annotations, and an output schema. Does not explain return values, error handling, or behavior when only one field is updated. Needs more information for effective usage.

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 has no descriptions (0% coverage). The description only mentions 'filename' and 'description', corresponding to 'name' and 'description' parameters, but does not explain the 'doc_id' parameter or the effect of leaving fields empty (defaults). Insufficient compensation for missing schema descriptions.

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'), the resource ('document'), and the specific fields ('filename or description'). It distinguishes from sibling tools that update other resources like cases or clients.

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 guidance on when to use this tool versus alternatives such as upload_document, delete_document, or get_document. No context about prerequisites or typical use cases.

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