Skip to main content

Workflows

MCP tools for the Workflows module. See the Workflows module docs for permissions and data model.

list-workflows​

List workflows

Arguments​

ArgumentTypeRequiredDescription
project_idstringno—
limitnumbernoResults per page. Above the maximum it is clamped; below 1 or not an integer it is 400 VALIDATION_FAILED.
cursorstringnoThe previous page's next_cursor; omit it for the first page. Send it with the same filters as the request that returned it: a malformed cursor, or one sent with other filters, is 400 INVALID_CURSOR.

create-workflow​

Create a workflow

Arguments​

ArgumentTypeRequiredDescription
project_idstringno—
namestringyes—
descriptionstring | nullno—
statesarray<object>yes—
transitionsarray<object>yes—
payload_schemaobject | nullno—
version_labelstringnoOptional tag for the version this create archives, e.g. initial.

get-workflow​

Get a workflow

Arguments​

ArgumentTypeRequiredDescription
workflow_idstringyes—

update-workflow​

Update a workflow

Arguments​

ArgumentTypeRequiredDescription
workflow_idstringyes—
namestringno—
descriptionstring | nullno—
statesarray<object>no—
transitionsarray<object>no—
payload_schemaobject | nullno—
version_labelstringnoOptional tag for the version this write creates, e.g. rewired. Ignored when the write changes no definition field, since no version is archived.
expected_versionanynoRefuses the write unless the resource is at this version.

delete-workflow​

Delete a workflow

Arguments​

ArgumentTypeRequiredDescription
workflow_idstringyes—

list-workflow-versions​

List a workflow's versions

Arguments​

ArgumentTypeRequiredDescription
workflow_idstringyes—
limitnumbernoResults per page. Above the maximum it is clamped; below 1 or not an integer it is 400 VALIDATION_FAILED.
cursorstringnoThe previous page's next_cursor; omit it for the first page. Send it with the same filters as the request that returned it: a malformed cursor, or one sent with other filters, is 400 INVALID_CURSOR.

get-workflow-version​

Fetch an archived workflow version

Arguments​

ArgumentTypeRequiredDescription
workflow_idstringyes—
versionnumberyesThe archived version number

restore-workflow-version​

Restore an archived workflow state machine

Arguments​

ArgumentTypeRequiredDescription
workflow_idstringyes—
versionnumberyesThe archived version number
labelstringnoOptional tag for the new version the restore archives. Defaults to restored from vN.

create-workflow-migration​

Migrate a workflow's open tasks to one of its versions

Arguments​

ArgumentTypeRequiredDescription
workflow_idstringyesThe workflow whose tasks migrate.
to_versionnumberyesThe workflow version to move the open tasks onto.
state_mapobjectnoCurrent state name to a state the target version declares, applied to every task as migrate-task applies it to one.
waitbooleannoWhen omitted or false (default), the run is answered queued and settles in the background; poll get-workflow-migration. Pass true to answer once every task has settled.

get-workflow-migration​

Get a workflow migration

Arguments​

ArgumentTypeRequiredDescription
workflow_idstringyesThe workflow whose tasks migrate.
migration_idstringyesThe workflow migration to read.