ingest_pdfs

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

The description discloses idempotency (unless force=True), the OCR engine with fallback behavior, and the effect of project_root. Since no annotations exist, it carries full burden; it covers key behavioral aspects well.

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 extremely concise—a single sentence plus a brief note on idempotency. No wasted words; front-loaded with essential purpose 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 no output schema and no annotations, the description covers core functionality, parameters, and behavior. It lacks explicit mention of output location but the force parameter schema hints at it. Overall sufficient for the tool's complexity.

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% and the description adds meaningful context: it explains engine fallback logic, default project_root behavior, and how categories restrict subfolders. This adds value beyond the schema.

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 tool's purpose: converting all PDFs in materials/**/*.pdf to markdown via an OCR engine. It specifies the action (render), the resource (PDFs), and differentiates from siblings like grade_pdf by focusing on ingestion.

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 implies usage for batch PDF conversion but does not explicitly state when to use this tool vs alternatives like grade_pdf or other siblings. No guidance on prerequisites or exclusions is provided.

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