Skip to main content
Glama

Extend MCP

Run a workflow on a document

run_workflow

Start a run of a deployed multi-step workflow on a document (workflows group; not runnable until a version is deployed, or pass version "draft"). Workflow runs commonly take minutes to hours: a status: "running" response is normal, not an error — NEEDS_REVIEW means paused for human review in the dashboard (see dashboardUrl). For one merged run over 2-50 related files, pass package instead of file. outputs injects pre-computed results for specific extractors/classifiers/splitters so the workflow skips recomputing them (not allowed with package). Follow any llmContext guidance included in results.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileNoInput document. Mutually exclusive with package. Exactly one of id/url/text — e.g. { "url": "https://..." } or { "id": "file_..." }, never a bare string.
detailNo"concise" (default): status, output, failure fields, dashboardUrl. "full": adds config, confidence/citations, usage, timestamps.
outputsNoPre-computed results the workflow should use instead of recomputing those steps. Not allowed with package.
packageNo2-50 files (id/url only) processed together as one merged run. Mutually exclusive with file and with outputs.
secretsNoSecrets passed to external-data-validation steps.
metadataNoArbitrary key-value metadata stored on the run.
priorityNoQueue priority (1-100).
workflowYesThe workflow to run.
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
filesNo
runIdYes
statusYesPROCESSED | FAILED | NEEDS_REVIEW | REJECTED | CANCELLED, or "running" (resume via the get tool).
outputsNoPer-step output values from completed steps.
runTypeNo
llmContextNo
stepSummaryNo
dashboardUrlNo
failureReasonNo
failureMessageNo

TDQS

A4.4/5.0
Behavior5/5

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

Annotations carry only generic flags (readOnlyHint=false, idempotentHint=false, openWorldHint=true), so the description carries the behavioral burden and delivers. It discloses that runs take minutes to hours and a 'running' response is normal rather than an error, that NEEDS_REVIEW means paused for human review in the dashboard, and that the workflow must be deployed before it is runnable. It also adds the outputs/package exclusion and directs the agent to follow llmContext guidance in results.

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?

Four dense sentences, each carrying operational weight: purpose, deployment prerequisite, async/status semantics, the package alternative, outputs injection, and llmContext guidance. Purpose is front-loaded and there is no filler, though the trailing llmContext clause is a slightly tacked-on afterthought and the density makes it a demanding read for an 11-parameter tool.

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 high-complexity tool with nested objects, mutual exclusions, and an output schema, the description covers the operational essentials: deployment gating, async expectations, special status meanings, mode selection, and the draft version escape hatch. The output schema handles return-value documentation and the schema handles parameter detail, so nothing an agent needs to invoke correctly 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%, and every parameter is already richly documented, including mutual-exclusivity constraints on file/package/outputs and environment restrictions tied to get_me. The description adds some semantic rationale (why outputs exists: to skip recomputation; package for merged multi-file runs) but mostly restates what the schema already covers, so the marginal value over the schema is modest.

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 opens with a specific verb+resource: 'Start a run of a deployed multi-step workflow on a document.' It anchors the tool in the 'workflows group' and its single-run scope distinguishes it from siblings like run_workflow_batch, get_workflow_run, and cancel_workflow_run. The file-vs-package modes further delimit the tool's operation.

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?

Provides concrete when-to-use context: a workflow is not runnable until a version is deployed (or pass 'draft'), and for one merged run over 2-50 related files you should use package instead of file. The async status note implies the agent should poll elsewhere, but it never explicitly names alternative tools (e.g., run_workflow_batch or get_workflow_run), so routing guidance is clear but not fully explicit.

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