Skip to main content
Glama
suparse

Suparse MCP Server

Official
by suparse

Start Quick Schema Creation

start_quick_schema_creation

Upload a local document to start schema creation and generate extraction templates, returning a run ID to poll for generated template and saved document IDs.

Instructions

Upload one local file to automatically create extraction schemas/templates; use when the user authorized schema creation, which may consume credits. Returns run_id for get_quick_schema_creation or wait_for_quick_schema_creation, not an extraction task_id or export_job_id. Completed runs return generated template IDs and saved document IDs; inspect those before submitting another extraction. Supply upload_batch_id and source_upload_id only when provided by an external batched-upload workflow; MCP does not create upload batches. Starting again can create duplicate work.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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 the source document.
pdf_passwordNoOptional encrypted-PDF password. Treat this as a secret.
upload_batch_idNoOptional existing upload batch ID from an external batch workflow.
source_upload_idNoOptional source upload ID from an external batch workflow.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
run_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.5.0

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare write/non-idempotent/open-world, and the description adds real behavioral context beyond them: credit consumption, the duplicate-work hazard, the fact that MCP does not create upload batches, and what a completed run returns (template IDs and saved document IDs) that should be inspected before another extraction.

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?

Purpose is front-loaded in the first clause and every sentence carries information (output routing, return contents, conditional params, duplicate warning). It is dense and clause-heavy, but no sentence is filler.

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 a write tool with an output schema, the description covers the trigger condition, the cost implication, the correct follow-up tools, and the idempotency hazard. Nothing an agent needs to invoke this 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 83%, so the baseline is 3, and the description adds genuine meaning for two parameters: upload_batch_id and source_upload_id are only supplied by an external batched-upload workflow, and only one local file is accepted. It does not add detail for file_path, folder_id, or pdf_password beyond the schema.

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?

States a specific verb and resource ('Upload one local file to automatically create extraction schemas/templates') and explicitly distinguishes its output from sibling artifacts ('not an extraction task_id or export_job_id'). An agent can separate this from start_file_extraction and the export tools without opening any schema.

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

Usage Guidelines5/5

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

Gives the triggering condition ('use when the user authorized schema creation, which may consume credits') and routes the agent to the correct polling siblings (get_quick_schema_creation / wait_for_quick_schema_creation). It also warns against re-invocation ('Starting again can create duplicate work').

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