library_ingest_documents

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

With no annotations, description discloses the non-destructive but write-oriented behavior (queue ingest), conditions for processing, deduplication, and the meaning of max_documents=0. However, it does not mention authentication, rate limits, or potential side effects like locking.

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?

Two sentences: first delivers the core action and condition, second provides usage guidance and return value. 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?

Cover essential points: action, condition, usage, return values (counts). Output schema exists but description adds value beyond it. Could mention default behavior for null root or error handling.

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%, but the description explains root as the selected directory and max_documents cap behavior. The force parameter is not explained, leaving part of the parameter semantics unclear.

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?

Description clearly states the tool scans a root and queues background ingest for EPUB/PDF documents that are not READY or have stale metadata. It distinguishes from sibling tool document_ingest by noting it's for whole-library operations instead of parallel individual calls.

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?

Explicitly states 'Use this for whole-library initialization or refresh instead of calling document_ingest many times in parallel,' providing clear when-to-use and an alternative.

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