DocImprint

Get Job Status

get_job_status

Read-onlyIdempotent

Poll the status of an async job (extract, indexing, batch). Free — no credits consumed. Use after add_document_to_collection or async extract to check when processing completes. Poll this endpoint in a loop until status is "complete" or "failed". Completed jobs include the bundle_id or result_json in the response. Jobs are created when you POST /v1/extract with a webhook, or when add_document_to_collection triggers async indexing. Returns: { id, type: "extract"|"extract_batch"|"index_collection", status: "queued"|"processing"|"complete"|"failed"|"cancelled", progress_pct: number (0–100), progress_message, bundle_id (when complete), result_json (when complete), error (when failed), created_at, completed_at } Example prompts:

"Check the status of my indexing job job_550e8400."
"Is my async extract job done yet?"
"Poll job [job_id] — what is the current progress?"

Input Schema

TableJSON Schema

Name	Required	Description	Default
`job_id`	Yes	Job ID (job_...) returned by async extract or add_document_to_collection. Example: "job_550e8400-e29b-41d4-a716-446655440000"

Output Schema

TableJSON Schema

Name	Required	Description	Default
`id`	Yes
`type`	Yes
`error`	Yes
`status`	Yes
`bundle_id`	Yes
`created_at`	Yes
`result_json`	Yes
`completed_at`	Yes
`progress_pct`	Yes
`collection_id`	Yes
`progress_message`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

AddedSep 29, 2026
RemovedJul 26, 2026

Changed1 schema field changedJul 10, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
+  "properties": {
+    "bundle_id": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "collection_id": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "completed_at": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "created_at": {
+      "type": "string"
+    },
+    "error": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "id": {
+      "type": "string"
+    },
+    "progress_message": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "progress_pct": {
+      "type": "number"
+    },
+    "result_json": {
+      "anyOf": [
+        {},
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "status": {
+      "enum": [
+        "queued",
+        "processing",
+        "complete",
+        "failed",
+        "cancelled"
+      ],
+      "type": "string"
+    },
+    "type": {
+      "enum": [
+        "extract",
+        "extract_batch",
+        "index_collection"
+      ],
+      "type": "string"
+    }
+  },
+  "required": [
+    "id",
+    "type",
+    "status",
+    "progress_pct",
+    "progress_message",
+    "bundle_id",
+    "collection_id",
+    "result_json",
+    "error",
+    "created_at",
+    "completed_at"
+  ],
+  "type": "object"
+}

Changed1 schema field changedJun 24, 2026

changedInput schema / properties / job_id / description

Previous value: -"Job ID (job_...) returned by async extract or add_document_to_collection"New value: +"Job ID (job_...) returned by async extract or add_document_to_collection. Example: \"job_550e8400-e29b-41d4-a716-446655440000\""

First observedJun 10, 2026

TDQS

A4.6/5.0

Behavior5/5

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

Annotations already declare readOnlyHint and idempotentHint, but the description adds material context beyond them: it is free with no credits consumed, it is meant to be polled repeatedly, and it explains how jobs are created (webhook extract or async indexing). That is exactly the extra disclosure the annotations cannot carry.

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?

Front-loaded with the core action and cost, then usage, then returns. The full return-shape block duplicates the existing output schema and is somewhat verbose, but the example prompts and job-creation note are cheap and useful.

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?

Given a single-param, read-only polling tool with an output schema, the description covers everything an agent needs: trigger points, polling loop, terminal statuses, and validation via example prompts.

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% for the single job_id parameter, and the description largely mirrors the schema by noting the ID comes from extract or add_document_to_collection. Baseline 3 is appropriate since the schema already does the work.

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 (poll) and resource (async job status), and immediately scopes the job types it covers (extract, indexing, batch). An agent can distinguish this from list_collections or get_bundle without opening a 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?

Explicitly names when to use it (after add_document_to_collection or an async extract) and how (poll in a loop until status is complete or failed). This is prescriptive sequencing guidance, not just implied context.

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

All DocImprint tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?