Skip to main content
Glama
fastocr-org

FastOCR MCP server

Official
by fastocr-org

get_document

Idempotent

Check an OCR document's processing status, then retrieve its extracted text or searchable PDF once ready. Use the document ID from an upload or document list.

Instructions

Get a FastOCR document's status, and optionally its text or searchable PDF.

Statuses: awaiting_upload, processing, completed, partial (the account ran out of pages partway), failed. With output='text' or 'pdf' this waits up to 45 seconds; if the document is still processing, call it again. Fetching a result again costs no pages. Without output_path, long text and PDFs are saved in the system temp directory.

Input Schema

NameRequiredDescriptionDefault
outputNo'status' (default) returns the status at once; 'text' or 'pdf' waits for the document to finish and fetches the result.status
document_idYesThe document id returned by ocr_file or list_documents.
output_pathNoOptional absolute path for the result file. An existing file there is replaced.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior5/5

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

Beyond the annotations, it discloses the 45-second blocking window, the retry pattern, the fact that repeated fetches cost no pages, and that results land in the system temp directory when output_path is omitted — which explains why readOnlyHint=false despite being a 'get'. The status enumeration (including 'partial' from page exhaustion) further clarifies behavior.

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?

Front-loaded with the core purpose, then status values, then timing/retry behavior, then the file-location caveat. Every sentence carries distinct information; the status list is compact and disambiguates a non-obvious value ('partial').

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

Completeness5/5

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

With an output schema and full annotation set present, the description covers everything an agent needs: what each mode returns, how long it blocks, when to retry, the cost model, and where files are written.

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

Parameters4/5

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

With 100% schema coverage the baseline is 3; the description earns credit beyond that by explaining the timing semantics of the output enum and the temp-directory default for output_path, which the schema itself does not state.

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?

The description opens with a specific verb and resource ('Get a FastOCR document's status, and optionally its text or searchable PDF') and enumerates the three output modes, so an agent knows exactly what the tool returns. It never names or contrasts a sibling (list_documents, ocr_file), leaving that differentiation to the schema.

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

Usage Guidelines4/5

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

It gives clear operational guidance: output='text'/'pdf' waits up to 45s and should be re-called if still processing, and re-fetching is free. It does not say when an agent should choose this over list_documents to check progress, so no explicit alternative routing.

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