Skip to main content
Glama

Extend MCP

Run a batch of extract runs

run_extract_batch

Submit up to 1,000 documents as one batch of extract runs (extract group) against a saved processor. Returns a batchId immediately; runs execute async — poll aggregate status with get_extract_batch, and fetch individual results with the extract-run list tool filtered by batchId. Follow any llmContext guidance included in results.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
inputsYes1-1000 documents.
priorityNoQueue priority (1-100).
processorYesThe saved processor every run in the batch uses.
environmentYes"TEST" = the Test (development) environment, "PRODUCTION" = live. Must match a granted target from get_me (an API key pins one environment).
workspaceIdYesTarget workspace (ws_...). Must be a granted workspace — get_me lists the accepted values.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusNo
batchIdYes
runCountNo
llmContextNo

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the annotations (readOnlyHint=false, idempotentHint=false), the description discloses the key behavioral trait: runs execute asynchronously and the response returns only a batchId, not results. It also tells the agent to follow llmContext guidance in results, which is useful non-obvious behavior. No contradiction with annotations exists.

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 sentences, each earning its place: the first states scope and limit, the second explains the async contract and follow-up tools, and the third adds an important instruction about result guidance. It is front-loaded and free of 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?

With a rich input schema, an output schema present, and safety annotations available, the description adds exactly the missing contextual pieces: batch-size cap, async semantics, aggregation polling, individual-result retrieval, and llmContext handling. Nothing important needed for an agent to call and follow up on this tool is missing.

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 description coverage is 100%, so the schema already documents all five parameters, including constraints like maxItems, enums, and the exactly-one-of id/url/text requirement. The description adds little parameter-level meaning beyond framing inputs as 1-1000 documents and the processor as 'saved'. This is the expected baseline when the schema carries the full burden.

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 description states a specific action (submit), a specific resource (batch of extract runs/extract group), and a specific target (a saved processor). It clearly distinguishes this batch tool from single-run operations such as extract_data and from sibling batch tools like run_parse_batch.

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?

The description gives clear operational guidance: it explains that the call returns immediately, that execution is asynchronous, and that follow-up must be done via get_extract_batch and the extract-run list tool filtered by batchId. It does not explicitly name a single-run alternative or state when not to use this tool, but the batching and async framing sufficiently imply the intended usage.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4/5.0
Disambiguation5/5

Each tool targets a distinct resource+action combination, and the descriptions actively disambiguate potential overlaps (e.g., extract_data vs parse_document, detect_form_fields vs edit_pdf, get_file vs get_file_upload). The consistent verb_noun prefix pattern makes the semantic boundary of every tool immediately recognizable.

Naming Consistency4/5

The dominant verb_noun pattern is highly consistent across all nine domains (list_*, get_*, create_*, update_*, delete_*, run_*, get_*_run, get_*_batch, publish_*_version). Minor deviations exist: deploy_workflow_version vs publish_*_version for the same freeze-a-draft concept, and get_form_detection_run doesn't mirror its detect_form_fields counterpart.

Tool Count2/5

86 tools is a very heavy agent-facing surface, well past the 25+ threshold. The count is inflated by the near-identical 13-tool lifecycle repeated across extract, classify, and split (each with list/get/create/update/publish/runs/batches/versions), and while each tool has a distinct purpose, the sheer volume makes selection harder.

Completeness4/5

Core lifecycles are thoroughly covered: create → update → publish → run (single and batch) → poll → cancel → delete-run → list runs/versions. Notable gaps include no delete tool for extractors, classifiers, splitters, workflows, or evaluation sets, and edit/form-detection runs have no list endpoint (documented workaround: keep run IDs). These are hygenic gaps that don't block primary workflows.

Resources