ocr_scanned_books

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

With no annotations provided, the description carries the full disclosure burden and does it well: it skips books with cached OCR output, runs the full pipeline, attaches EPUBs when import_format is set, and is resumable. It does omit failure-mode or side-effect detail, but for a batch tool this is substantial.

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 opens with a one-sentence purpose, follows with a compact behavior paragraph, and ends with a terse Args list. Every sentence adds necessary information and there is no filler or repetition.

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 three-parameter batch tool with an output schema present, the description covers the what, the how (repeat calls), the safety of interruption, and detailed parameter semantics. The only minor omission is an explicit comparison to the single-book sibling, but nothing needed for correct invocation is missing.

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%, so the description fully compensates by documenting all three parameters with meaningful behavior, defaults, and constraints. For example, 'limit' gets a range and default, 'typeset' explains the pandoc EPUB step, and 'import_format' clarifies attaching to book records.

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 a specific action ('OCR'), a clear resource ('all scanned-PDF books in the library'), and a key mode ('resumable batches'). It also distinguishes itself from siblings by mentioning it runs the full ocr_book pipeline rather than just detection or a single book.

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 explains the intended invocation pattern: call repeatedly to work through the library, and per-batch caching makes interruptions safe. It does not explicitly contrast with single-book ocr_book or detect_scanned_books, but the batch scope and repeat-call guidance are clear.

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