reader_update_document

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

The description reveals key behaviors beyond annotations, such as the fact that tags replace existing tags (not append) and that an empty string in notes clears them. Annotations indicate non-readonly and non-destructive, which aligns with the update action.

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 well-structured with 'Args' and 'Returns' sections, uses bullet-like formatting, and each line earns its place. It is concise, front-loaded with purpose, and contains no redundant information.

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 (11 parameters, output schema exists), the description covers the essential update behavior, including side-effects like tag replacement. It lacks explicit mention that the document must already exist, but that is implied by the required 'id'.

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?

With 0% schema description coverage, the description adds meaning to most parameters. For example, it clarifies that 'id' is required, 'tags' replaces (not appends), 'notes' can be cleared, and 'location' and 'category' have cited enum values. Some parameters like 'author' only repeat the parameter name.

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 'Update a document in your Readwise Reader library,' which is a specific verb+resource. It distinguishes itself from sibling tools like 'reader_delete_document' and 'reader_bulk_update_documents' by focusing on a single document update.

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 does not provide explicit guidance on when to use this tool versus alternatives, such as 'reader_bulk_update_documents' for bulk updates or 'reader_create_document' for new documents. No when-not-to-use or scenario context is given.

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