parse_pdf_stream

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

Description lacks behavioral details such as stream format, error handling, rate limits, or real-time behavior. With no annotations, the burden is on the description, which only states the function without disclosing important traits.

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 very concise (one sentence), but it sacrifices necessary detail. While it's efficient, it fails to provide adequate information for a tool with many parameters.

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 (13 parameters, no schema descriptions, no annotations), the description is severely incomplete. It omits what the output stream contains, how to handle events, and how to configure parameters.

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%, and the description does not mention any parameters. The tool has 13 parameters, but no explanation of pdf_path, pages, use_ocr, etc., leaving the agent with no guidance 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?

Description clearly states the tool parses one PDF as an SSE stream, specifying the API endpoint. This distinguishes it from siblings like parse_pdf_sync (synchronous) and submit_parse_batch (batch processing).

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?

No guidance on when to use this tool versus alternatives (e.g., parse_pdf_sync for synchronous needs, submit_parse_batch for batch). No prerequisites or context provided.

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