Flows Tools
Tools for creating, updating, and executing automation flows.
Available Tools
flow_createCreate a new automation flow
Input Schema
name | stringrequired | Name for the new automation flow |
description | string | Optional description of the flow |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_create",
"arguments": {
"name": "example",
"description": "example"
}
}
}flow_listList all automation flows. Returns array with id, name, description, isActive, triggerType, nodes[], edges[].
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_list",
"arguments": {}
}
}flow_getAvailableNodesGet available node types for building flows. Use type filter to reduce response size.
Input Schema
type | string | Filter by node type |
category | string | Filter utilities/tools by category |
mcpServerId | string | Filter tools by specific MCP server |
search | string | Search by name or description |
limit | number | Max items for tools (default 50) |
offset | number | Offset for tools pagination |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_getAvailableNodes",
"arguments": {
"type": "example",
"category": "example",
"mcpServerId": "example"
}
}
}flow_getByIdGet flow details with nodes and edges
Input Schema
id | stringrequired | Flow ID from list |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_getById",
"arguments": {
"id": "example"
}
}
}flow_updateUpdate flow configuration. Only provided fields are updated.
Input Schema
id | stringrequired | Flow ID from list |
name | string | New name for the flow |
description | string | New description |
nodes | array | Array of flow nodes |
edges | array | Array of flow edges connecting nodes |
triggerType | string | Trigger type: "manual", "webhook", "schedule", "table" |
isActive | boolean | Whether the flow is active |
usedSequenceNumbers | array | Used sequence numbers for node ordering |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_update",
"arguments": {
"id": "example",
"name": "example",
"description": "example"
}
}
}flow_updateNodeConfigUpdate configuration for a single node
Input Schema
flowId | stringrequired | Flow ID |
nodeId | stringrequired | Node ID within the flow |
config | objectrequired | Node configuration object |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_updateNodeConfig",
"arguments": {
"flowId": "example",
"nodeId": "example",
"config": {}
}
}
}flow_deletePermanently delete a flow
Input Schema
id | stringrequired | Flow ID to delete |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_delete",
"arguments": {
"id": "example"
}
}
}flow_createWebhookCreate a webhook trigger for a flow
Input Schema
flowId | stringrequired | Flow ID |
triggerId | stringrequired | Trigger node ID in the flow |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_createWebhook",
"arguments": {
"flowId": "example",
"triggerId": "example"
}
}
}flow_getWebhookGet webhook details for a trigger
Input Schema
triggerId | stringrequired | Trigger node ID |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_getWebhook",
"arguments": {
"triggerId": "example"
}
}
}flow_deleteWebhookDelete a webhook trigger
Input Schema
triggerId | stringrequired | Trigger node ID |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_deleteWebhook",
"arguments": {
"triggerId": "example"
}
}
}flow_createScheduleCreate a schedule trigger for a flow
Input Schema
flowId | stringrequired | Flow ID |
triggerId | stringrequired | Trigger node ID |
cronExpression | stringrequired | Cron expression (5 parts): minute hour day month weekday. Example: "0 9 * * *" for 9am daily |
timezone | string | Timezone (default: UTC). Example: "America/New_York" |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_createSchedule",
"arguments": {
"flowId": "example",
"triggerId": "example",
"cronExpression": "example"
}
}
}flow_getScheduleGet schedule details
Input Schema
triggerId | stringrequired | Trigger node ID |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_getSchedule",
"arguments": {
"triggerId": "example"
}
}
}flow_updateScheduleUpdate a schedule trigger configuration
Input Schema
triggerId | stringrequired | Trigger node ID |
cronExpression | stringrequired | Cron expression (5 parts): minute hour day month weekday |
timezone | stringrequired | Timezone. Example: "America/New_York", "UTC" |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_updateSchedule",
"arguments": {
"triggerId": "example",
"cronExpression": "example",
"timezone": "example"
}
}
}flow_deleteScheduleDelete a schedule trigger
Input Schema
triggerId | stringrequired | Trigger node ID |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_deleteSchedule",
"arguments": {
"triggerId": "example"
}
}
}flow_getExecutionsGet execution history for a flow with pagination
Input Schema
flowId | stringrequired | Flow ID |
limit | number | Max results (1-50, default 10) |
cursor | string | Pagination cursor from previous response |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_getExecutions",
"arguments": {
"flowId": "example",
"limit": 0,
"cursor": "example"
}
}
}flow_getExecutionDetailsGet full execution details with node results and flow snapshot
Input Schema
executionId | stringrequired | Execution ID from getExecutions |
includeFullData | boolean | Include full node results (for copying data) |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_getExecutionDetails",
"arguments": {
"executionId": "example",
"includeFullData": true
}
}
}flow_getActiveExecutionGet the most recent running execution for a flow
Input Schema
flowId | stringrequired | Flow ID |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_getActiveExecution",
"arguments": {
"flowId": "example"
}
}
}flow_getActiveExecutionsGet all currently running executions for a flow
Input Schema
flowId | stringrequired | Flow ID |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_getActiveExecutions",
"arguments": {
"flowId": "example"
}
}
}flow_getSnapshotsGet flow version history (snapshots). Each save creates a snapshot for rollback.
Input Schema
flowId | stringrequired | Flow ID |
cursor | string | Pagination cursor |
limit | number | Max results (1-50, default 20) |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_getSnapshots",
"arguments": {
"flowId": "example",
"cursor": "example",
"limit": 0
}
}
}flow_deleteSnapshotDelete a snapshot (cannot delete the latest snapshot)
Input Schema
snapshotId | stringrequired | Snapshot ID from getSnapshots |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_deleteSnapshot",
"arguments": {
"snapshotId": "example"
}
}
}flow_restoreFromSnapshotByIdRestore flow nodes and edges from a previous snapshot
Input Schema
flowId | stringrequired | Flow ID |
snapshotId | stringrequired | Snapshot ID to restore from |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_restoreFromSnapshotById",
"arguments": {
"flowId": "example",
"snapshotId": "example"
}
}
}flow_stopExecutionStop a running execution
Input Schema
executionId | stringrequired | Execution ID to stop |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_stopExecution",
"arguments": {
"executionId": "example"
}
}
}flow_runManualFlowExecute a flow manually with optional trigger data
Input Schema
flowId | stringrequired | Flow ID to execute |
triggerData | object | Data to pass to the trigger node |
triggerId | string | Specific trigger node ID (uses manual trigger if not specified) |
executionId | string | Custom execution ID (generated if not provided) |
executionMode | string | Execution mode: "test" uses pinned data, "live" runs normally |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_runManualFlow",
"arguments": {
"flowId": "example",
"triggerData": {},
"triggerId": "example"
}
}
}flow_pinNodeDataPin data to a node for testing. Pinned nodes use fixed output instead of executing.
Input Schema
flowId | stringrequired | Flow ID |
nodeId | stringrequired | Node ID to pin data to |
input | any | Input data to pin |
output | any | Output data to pin - used as fixed output in test mode |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_pinNodeData",
"arguments": {
"flowId": "example",
"nodeId": "example",
"input": {}
}
}
}flow_unpinNodeDataRemove pinned data from a node so it executes normally
Input Schema
flowId | stringrequired | Flow ID |
nodeId | stringrequired | Node ID to unpin |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_unpinNodeData",
"arguments": {
"flowId": "example",
"nodeId": "example"
}
}
}flow_toggleActiveToggle flow active/inactive. Inactive flows do not process webhook or schedule triggers.
Input Schema
flowId | stringrequired | Flow ID |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_toggleActive",
"arguments": {
"flowId": "example"
}
}
}flow_enterListenModeEnter listen mode to capture incoming webhook/table events without executing the flow
Input Schema
flowId | stringrequired | Flow ID |
triggerType | stringrequired | Type of trigger to listen for |
duration | number | Listen duration in ms (default 5 minutes) |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_enterListenMode",
"arguments": {
"flowId": "example",
"triggerType": "example",
"duration": 0
}
}
}flow_exitListenModeExit listen mode and stop capturing events
Input Schema
flowId | stringrequired | Flow ID |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_exitListenMode",
"arguments": {
"flowId": "example"
}
}
}flow_getHelpGet help for Flows API. Call with topic to get focused guidance.
Input Schema
topic | string | Topic: "overview", "nodes", "triggers", "execution", "testing" |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "flow_getHelp",
"arguments": {
"topic": "example"
}
}
}