Skip to main content
Glama

comfyui_get_job

Read-onlyIdempotent

Look up a job by prompt_id to check its status across queue and history. Get a unified response with timing, outputs, and error details for queued, running, or finished jobs.

Instructions

Look up a single job by prompt_id across queue + history.

    Returns a flat unified job object with top-level keys: prompt_id, status
    (pending/in_progress/completed/failed/cancelled), timing fields (created_at,
    started_at, completed_at, execution_duration), outputs (when completed),
    and error (when failed). Use this to check on a job that may be queued,
    running, or already finished.

    Note: this replaces the previous /history/{prompt_id} envelope shape
    (`{prompt_id: {...}}`); callers should index fields directly on the
    returned object.
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
prompt_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior5/5

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

The description goes well beyond the readOnlyHint/idempotentHint annotations by detailing the exact return structure: a unified job object with specific fields (status values, timing fields, outputs, error). It also transparently discloses the breaking change in the envelope shape, which is crucial behavioral context for callers.

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 core purpose, then logically expands into return shape, usage, and a migration note. Every sentence adds value and the structure is easy to scan. It is slightly longer than minimal but all content is necessary for a tool that replaces a previous API shape.

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 the tool's low complexity (single parameter, simple lookup), the description is complete: it explains the operation, the unified return schema (including statuses and error fields), when to use it, and an important backward-incompatibility note. The presence of an output schema further reduces the burden, but the description already covers the essential context.

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?

With schema_description_coverage at 0%, the description does compensate by tying the sole parameter to the lookup action ('by prompt_id'). However, it does not explain what a prompt_id is, how it is created, or its format. The reference in the return keys reinforces its role but adds no syntactic detail. Despite this gap, the single-parameter context makes the meaning reasonably clear.

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 pair: 'Look up a single job by prompt_id' and further scopes it 'across queue + history.' This clearly distinguishes it from sibling tools like comfyui_list_jobs (listing) and comfyui_get_history (history envelope). The purpose is unambiguous and immediately actionable.

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?

It states exactly when to use the tool: 'Use this to check on a job that may be queued, running, or already finished.' Additionally, the note about replacing the old /history/{prompt_id} envelope shape gives explicit migration guidance, making the when-not and alternative context clear.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/hybridindie/comfyui_mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server