PAIDEIA__ingest_pdfs

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

Discloses OCR engine fallback behavior and idempotency. No annotations exist, so description carries full burden. Could mention if original PDFs are preserved, but the info provided is sufficient for non-destructive understanding.

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?

Three concise sentences, front-loaded with purpose and namespace alias. No wasted words; each sentence contributes meaningful 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?

Description covers key behaviors and parameters, but lacks explanation of return values or output format. With no output schema, this leaves a gap for the agent to know what to expect from the tool.

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 coverage is 100%, but description adds value: it clarifies that idempotency relates to force parameter, and describes engine fallback (qwen3-vl to tesseract). This goes beyond 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?

Description states it renders PDFs to markdown via OCR, which is clear verb+resource. It also clarifies it's a namespace alias for ingest_pdfs, but doesn't fully differentiate from that sibling tool.

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?

Mentions idempotency and that force=True redoes conversion, providing some usage context. However, no explicit when-to-use or comparison to alternatives (e.g., plain ingest_pdfs) is given.

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