Skip to main content
Glama

execute_workflow_stream

Runs a ComfyUI workflow while streaming real-time progress updates over WebSocket, returning the final result and progress event history for execution monitoring.

Instructions

Execute workflow with streaming real-time progress updates. Requires WebSocket support. Returns result and progress event history. Use for monitoring execution progress. Requires COMFYUI_HOST and WebSocket connection.

Input Schema

NameRequiredDescriptionDefault
workflowYesWorkflow JSON string (from build_workflow or loaded file)
timeout_msNoMax wait in milliseconds (default 300000)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden and does disclose important traits: WebSocket dependency, COMFYUI_HOST requirement, and that it returns a result plus progress event history. It still omits failure behavior, side effects on the queue, and whether execution blocks until completion, so it is only moderately transparent.

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?

The description is short and front-loads the key purpose and streaming behavior. It is mildly repetitive in mentioning WebSocket support twice, but the redundancy is minor and does not obscure the essential information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no annotations and no output schema, the description does well to mention return values and environmental prerequisites. However, it does not describe progress event structure, failure modes, or execution side effects, leaving some important context for a streaming execution tool unaddressed.

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 the description does not add parameter-level meaning beyond what the schema provides. The schema already explains workflow JSON and timeout_ms, so a baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific action and resource: executing a workflow with streaming real-time progress updates. It distinguishes itself from non-streaming execution siblings by emphasizing streaming and progress monitoring. It could be slightly sharper by explicitly naming the non-streaming alternative, but the core purpose is clear.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives a clear use case, 'Use for monitoring execution progress,' and states a prerequisite, WebSocket support. However, it does not explicitly compare against execute_workflow, execute_workflow_sync, or get_execution_progress, leaving the agent to infer when this tool is preferable.

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