doc2x_parse_image_layout_sync

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

With no annotations provided, the description carries the full burden. It discloses the synchronous behavior and return format (raw JSON with convert_zip), which is useful. However, it lacks details on error handling, performance expectations (e.g., timeouts for large images), or authentication needs, leaving gaps for a mutation-like tool.

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 a single, efficient sentence that front-loads the core action and output. Every word earns its place, with no redundancy or unnecessary details, making it easy to parse quickly.

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 annotations, no output schema, and a single parameter with full schema coverage, the description is minimally adequate. It covers the purpose and output format but lacks context on errors, limitations (e.g., supported image types beyond png/jpg implied by schema), or integration with sibling tools, leaving room for improvement.

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 100%, with the schema fully documenting the 'image_path' parameter (type, constraints, path resolution). The description adds no parameter-specific information beyond what the schema provides, so it meets the baseline but doesn't enhance understanding.

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 action ('parse an image layout synchronously') and the resource ('image'), specifying it returns raw Doc2x result JSON. It distinguishes from siblings like 'doc2x_parse_image_layout_submit' (async) and 'doc2x_parse_image_layout_wait_text' (text-focused), but could be more explicit about the distinction.

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 synchronous parsing of image layouts, but lacks explicit guidance on when to use this vs. alternatives like 'doc2x_parse_image_layout_submit' (async) or 'doc2x_parse_pdf_*' tools. It mentions 'convert_zip when present' as a feature, but no clear when-not scenarios or prerequisites are stated.

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