get_prompt_status
Check the completion status of a submitted ComfyUI workflow prompt to monitor progress and determine when processing finishes.
Instructions
Get the status of a submitted prompt.
Args:
prompt_id: The prompt ID from submit_workflow()
Returns status information including completion state.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| prompt_id | Yes | Prompt ID to check |
Implementation Reference
- The handler function for the 'get_prompt_status' MCP tool. It queries the ComfyUI /history/{prompt_id} endpoint to retrieve and parse the prompt's status, completion state, messages, and output availability.@mcp.tool() def get_prompt_status( prompt_id: str = Field(description="Prompt ID to check"), ctx: Context = None, ) -> dict: """Get the status of a submitted prompt. Args: prompt_id: The prompt ID from submit_workflow() Returns status information including completion state. """ if ctx: ctx.info(f"Checking status: {prompt_id}") try: history = comfy_get(f"/history/{prompt_id}") if prompt_id not in history: return {"status": "pending", "completed": False} entry = history[prompt_id] status = entry.get("status", {}) return { "status": status.get("status_str", "unknown"), "completed": status.get("completed", False), "messages": status.get("messages", []), "has_outputs": len(entry.get("outputs", {})) > 0, } except Exception as e: return ErrorResponse.unavailable(str(e)).model_dump()
- src/comfy_mcp_server/tools/__init__.py:28-28 (registration)Top-level registration call for execution tools module, which includes the registration of 'get_prompt_status' via its @mcp.tool() decorator in execution.py.register_execution_tools(mcp)