get_workflow

Fetch one workflow by id.

Workflowread-onlyidempotentMCP tool

Returns not_found if no workflow has that id.

Calling it#

curl -X POST http://127.0.0.1:8787/workflow.v1.WorkflowService/GetWorkflow \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "<id>"
}'

Request#

GetWorkflowRequest#

FieldTypeDescription
idstring

Which workflow to read.

required

Response#

GetWorkflowResponse#

FieldTypeDescription
workflowWorkflow

The workflow, with its context whole rather than cut to its opening.

Types#

Workflow#

FieldTypeDescription
idstring

The handle every other call names this workflow by.

namestring

What the panel groups its agents under.

contextstring

Text appended to the system prompt of every agent launched into it, taken as a snapshot at launch rather than read again.

cwdstring

The directory its agents start in, and the checkout new worktrees are cut from.

flagsstring

Command-line flags prefilled for each new agent.

harnessstring

Which CLI its agents run, blank for komrad's default.

archivedAtstring

When it was hidden from the panel, unset while it is live.

worktreeWorktreeConfig

Whether its agents each get a worktree of their own, and how those are built.

hookslist of WorkflowHook

Scripts hung on moments in its agents' lives, one per moment.

contextTruncatedbool

Whether context holds only its opening, which a summary listing returns.

WorktreeConfig#

FieldTypeDescription
enabledbool

Whether komrad cuts a worktree for each agent, or leaves it in the directory it was given.

baseBranchstring

The branch worktrees are cut from and every agent's work is measured against, filled in from the clone when left blank on create and never blank once stored.

at most 255 characters

copyPathslist of string

Files copied into each new worktree, for the untracked ones a build needs.

symlinkPathslist of string

Files linked into each new worktree rather than copied, for the large shared ones.

diffExcludelist of string

Paths or globs the panel leaves out of the diff it draws, such as generated output.

dirstring

Where new worktrees are made, blank for the parent every workflow shares.

at most 4096 characters

WorkflowHook#

FieldTypeDescription
eventstring

Which moment fires it, such as pre-launch or post-resume.

required, at most 40 characters

scriptstring

The file in the hooks directory to run, blank to fire nothing at that moment.

required, at most 255 characters