list_workflows

List the workflows agents are grouped into, in alphabetical order, with each one's shared context, the working directory and flags its agents start from, and the scripts hooked to moments in their agents' lives.

Workflowread-onlyidempotentMCP tool

Archived workflows are excluded unless archived is set, which lists those and only those. Returns one page; pass the response's nextPageToken back as pagination.cursor for the next. The summary this returns by default holds only the opening of each workflow's context, marked by contextTruncated; get_workflow returns one whole, and view VIEW_FULL returns every context on the page.

Calling it#

curl -X POST http://127.0.0.1:8787/workflow.v1.WorkflowService/ListWorkflows \
  -H 'Content-Type: application/json' \
  -d '{}'

Request#

ListWorkflowsRequest#

FieldTypeDescription
paginationPagination

Where to carry on from.

archivedbool

True to list the archived workflows and only those.

viewView

How much of each record to return, since the panel draws every field and a model reading the same endpoint has a context window to spend.

Response#

ListWorkflowsResponse#

FieldTypeDescription
workflowslist of Workflow

One page of workflows, in alphabetical order.

nextPageTokenstring

Pass this back as the pagination cursor for the next page.

Types#

Pagination#

FieldTypeDescription
limitint32

How many rows to return, capped by the server, and left to the server entirely when unset.

cursorstring

The next_page_token a previous reply carried, or unset to start from the beginning.

at most 2048 characters

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

View#

View is how much of each record a listing returns, so that the panel, which draws every field, and a model reading the same endpoint through a context window ask for different amounts of the same rows.

ValueDescription
VIEW_SUMMARY

Long text is cut to its opening, and the record says which fields were cut.

VIEW_FULL

Every field whole, however long.