Skip to main content
Glama
suparse

Suparse MCP Server

Official
by suparse

Start File Extraction

start_file_extraction

Submit a local document to start background extraction and receive a task ID immediately after upload, without waiting for processing. Use it to kick off PDF or image parsing workflows.

Instructions

Start background extraction of one local file; return task_id after upload confirmation without waiting for processing or exporting results. This confirms submission, not successful extraction. Use wait_for_task_extraction, then fetch_document_result for a returned document ID or download_results to save an export; get_task_results can inspect partial documents. Uploads may consume credits. On timeout, use any returned recovery task_id rather than uploading again. auto_approve defaults true; false requests human review, which MCP cannot perform or approve. The returned auto_approve echoes the requested option, not backend approval status.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
splitNoEnable auto-splitting of multi-page documents with mixed document types.
api_urlNo
file_pathYesPath to a local document on the machine running this MCP server, not a URL or chat attachment. Supported extensions: .pdf, .jpg, .jpeg, .png, .heic, .heif. Prefer an absolute path; relative paths use the server's working directory and ~ is not expanded.
folder_idNoOptional remote Suparse folder ID to assign to uploaded documents.
template_idNoOptional extraction template ID. Use only a non-system team template ID from list_templates. System template IDs are discovery-only and cannot be passed directly. Omit to let Suparse auto-detect, or use an authorized quick-schema workflow to create a team template.
auto_approveNoAutomatically approve extracted documents. Defaults to true. Set false only when human review is requested; use a start-only extraction tool to retain the task ID. MCP cannot approve documents, and combined extraction may time out while review is pending.
pdf_passwordNoOptional password for an encrypted PDF. Treat this as a secret; it is used only for the upload and is not returned in results.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
task_idYes
file_pathYes
auto_approveYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.5.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already mark this as non-read-only and non-idempotent, and the description adds substantial context beyond them: credits are consumed, submission is confirmed but not success, a recovery task_id should be reused rather than re-uploading, and the returned auto_approve echoes the request rather than backend approval status.

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

Conciseness4/5

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

The core behavior is front-loaded in the first sentence and each subsequent clause carries distinct information (follow-ups, credits, timeout recovery, auto_approve). It is dense and semicolon-chained, which slightly hurts scanability, but little is wasted.

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?

For an async submission tool with annotations and an output schema already present, the description covers the async contract, downstream tool chain, cost, failure/recovery path, and the non-obvious auto_approve caveat. Nothing an agent needs to call it correctly is missing.

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?

Schema coverage is already 86%, so most parameters are self-documenting, but the description adds interpretation the schema does not: auto_approve=false triggers human review that MCP cannot perform or approve, and the echoed value is not approval status. It adds useful nuance above the baseline.

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

Purpose5/5

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

The first clause states a specific verb, resource, and scope: 'Start background extraction of one local file.' It also distinguishes itself from the async siblings by stating it returns task_id 'without waiting for processing,' making it clearly distinct from wait_for_task_extraction and extract_file.

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 maps the downstream workflow explicitly (wait_for_task_extraction, then fetch_document_result or download_results, with get_task_results for partials) and gives a recovery rule on timeout. It does not directly compare against extract_file/extract_folder, so the choice among the start/extract family is left partly implicit.

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