Skip to main content
Glama

doc2x_materialize_pdf_layout_json

Wait for a PDF parse task and write the raw Doc2x result JSON (with page layout) to output_path. Prefer passing uid. If only pdf_path is provided, this tool reuses a cached uid or submits a new parse with model='v3-2026' by default.

Instructions

Wait for a PDF parse task and write the raw Doc2x result JSON (with page layout) to output_path. Prefer passing uid. If only pdf_path is provided, this tool reuses a cached uid or submits a new parse with model='v3-2026' by default.

Input Schema

NameRequiredDescriptionDefault
uidNoDoc2x parse task uid returned by doc2x_parse_pdf_submit.
modelNoOptional parse model used only when submitting from pdf_path. Supported values: 'v2' and 'v3-2026'. Defaults to 'v3-2026' for this tool because v2 does not return layout.
pdf_pathNoAbsolute path to a local PDF file. If uid is not provided, this tool will reuse cached uid (if any) or submit a new task.
max_wait_msNo
output_pathYesAbsolute path for the output JSON file. The file will be overwritten if it exists.
poll_interval_msNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.7

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations, the description does disclose the key hidden behavior: it blocks/waits, it may submit a new parse task when only pdf_path is given, and it reuses a cached uid. It does not explain what happens on wait timeout (max_wait_ms), polling mechanics, or failure/partial-result behavior, which matter for a long-running blocking tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences with no filler; the core action and output destination lead, followed by parameter selection rules. Every sentence carries information the schema does not.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Six parameters, no annotations, and no output schema, so the description carries the full burden. It covers the main execution path but omits timeout/polling semantics and what the written JSON contains beyond 'raw result with page layout', leaving the two undocumented integer parameters ambiguous.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 67%; max_wait_ms and poll_interval_ms are completely undocumented in both schema and description. The description does add value the schema lacks — the uid-over-pdf_path preference and the cached-uid reuse rule — but leaves the timeout/polling knobs unexplained.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Specific verb chain ('wait for a PDF parse task and write the raw Doc2x result JSON with page layout to output_path') plus a concrete resource and destination. The 'with page layout' and file-writing framing implicitly separate it from doc2x_parse_pdf_wait_text and doc2x_parse_pdf_status, but no sibling is named explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

'Prefer passing uid' and the pdf_path fallback rule give real guidance on how to call it, but nothing states when to choose this tool over doc2x_parse_pdf_wait_text, doc2x_parse_pdf_status, or doc2x_parse_image_layout_sync. Usage is implied by the layout-JSON output rather than contrasted with alternatives.

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