Skip to main content

workspace debug-node

Kanban has no executor or registry and does not support debug node; the server returns an explicit error that static projects do not support execution.

workspace debug-node calls the Workflow Server debug-node API to run only a node registered by the selected Workflow entry point, or by the Conversation executor. Use it to diagnose a specific parsing, LLM, or output node.

Command Format

pnpm exec workflow-code workspace debug-node <workflow> <node> [--target draft|latest|version] [--entrypoint <id>] [--] [...args]

Parameter

ParameterDescription
<workflow>Remote workflow name.
<node>Node name registered in the executor registry.
argsArguments passed to the debug-node API.
--target <target>Debug target. Defaults to latest; a specific version must be online.
--entrypoint <id>Workflow entry point. Omit it for the target version's default entry point; Conversation does not accept a non-empty value.

Registry Requirements

ConfigurationDescription
entrypoint.registryThe selected Workflow entry point must contain <node>; Server never searches across entry points. Conversation uses executor.registry.
entry.nodePoints to the node or stream node to debug.
entry.streamThe stream node needs to be marked as true.
entry.createInputOptional. When absent, Server uses the selected entry point's createInput, or the Conversation executor's.

API

StepsEndpoint
Single-node debuggingPOST /api/workflows/{workflow}/debug/nodes/{node}

The request body contains target, optional entrypointId and args, and is also compatible with entrypoint_id. When calling HTTP API directly, you can also use version as an alias for the specific version number. If target is not provided, the server will use version as the debugging target. Unknown entry returns 400 before starting debugging.

Output

SituationOutput
Debugging succeedsServer debug API JSON; data is the node output.
Node is not registeredServer returns a standard error and exit code 1.
Invalid stream flagServer returns a standard error and exit code 1.

Example

pnpm exec workflow-code workspace debug-node hello output --target draft --entrypoint main -- --message "debug"
pnpm exec workflow-code workspace debug-node hello classifier --entrypoint classify -- --query "What are the refund rules?"

Troubleshooting Recommendations

ProblemProcessing
Node not foundFirst check the registry with the local workflow-code structure.
Input not as expectedChecks whether the registry entry has a standalone createInput defined.
Streaming node reports an errorVerify that the registry entry has stream: true set.