Skip to main content
Glama

Extend MCP

Get (or wait on) an extract run

get_extract_run
Read-onlyIdempotent

Get the state and output of an extract run (extract group) — resume a status: "running" run or inspect a failed one. wait: true blocks until terminal or wait-budget expiry. While status is "running", call again with wait: true (same workspaceId and environment) until it is terminal; never re-submit the document. On UNAUTHORIZED or NOT_FOUND, re-call get_me for the granted targets. Output shape is documented at https://docs.extend.ai/extraction/response-format.md (get_documentation).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
waitNoBlock until terminal or budget expiry. Default false.
runIdYesThe run ID returned by extract_data or list_extract_runs.
detailNo"concise" (default): status, output, failure fields, dashboardUrl. "full": adds config, confidence/citations, usage, timestamps.
environmentYes"TEST" = the Test (development) environment, "PRODUCTION" = live. Must match a granted target from get_me (an API key pins one environment).
waitSecondsNoMax seconds to block waiting on the run (clamped to the server wait budget).
workspaceIdYesTarget workspace (ws_...). Must be a granted workspace — get_me lists the accepted values.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileNo
filesNo
runIdYes
outputNoExtracted values (PROCESSED only).
statusYesTerminal status, or "running" (resume via the get tool).
runTypeNo
dashboardUrlNo
failureReasonNo
failureMessageNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • removedOutput schema / properties / llmContext
      Removed value: -{
      -  "type": "string"
      -}
  2. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already mark this readOnlyHint, idempotentHint, and destructiveHint=false. The description adds non-obvious behavioral context: wait blocks until terminal or budget expiry, polls may need repeated calls, and the caller must reuse the same workspaceId and environment. It also links to output format documentation, which is useful beyond structured fields.

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?

The description is front-loaded with the primary purpose, then covers the polling behavior, error handling, and documentation link in a compact set of sentences. Every clause earns its place and no content 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 a read-only polling tool, the description covers state retrieval, wait semantics, repeated polling, error recovery, and points to detailed output documentation. With a full output schema present and annotations already declaring safety, nothing essential 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 description coverage is 100%, so the baseline is 3. The description adds extra parameter-related nuance by saying the caller must reuse the same workspaceId and environment when resuming, and warns against re-submitting the document. It does not repeat the schema text, which is appropriate.

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 verb and resource: 'Get the state and output of an extract run (extract group)' and immediately clarifies the two main use cases: resuming a running run or inspecting a failed one. This clearly differentiates it from extraction-related siblings like run_extract_batch or cancel_extract_run.

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?

The description gives explicit when-to and when-not-to guidance: call again with wait: true while status is 'running', never re-submit the document, and on UNAUTHORIZED or NOT_FOUND call get_me. It also names get_me as a recovery path, which counts as an alternative.

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.

Resources