start_workflow
Initiate workflow executions in Netflix Conductor by specifying workflow name, version, input parameters, and optional correlation ID for tracking.
Instructions
Start a new workflow execution. Returns the workflow execution ID of the newly started workflow.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workflowName | Yes | Name of the workflow to start | |
| version | No | Version of the workflow (optional, defaults to latest) | |
| input | No | Input parameters for the workflow as a JSON object | |
| correlationId | No | Optional correlation ID for tracking | |
| priority | No | Workflow execution priority (0-99, default: 0) |
Implementation Reference
- src/index.ts:488-510 (handler)Handler for the 'start_workflow' tool. Extracts parameters from input arguments, constructs a request body, sends a POST request to the Conductor API's /workflow endpoint to start the workflow, and returns the new workflow execution ID.case "start_workflow": { const { workflowName, version, input = {}, correlationId, priority = 0 } = args as any; const requestBody: any = { name: workflowName, input, priority, }; if (version) requestBody.version = version; if (correlationId) requestBody.correlationId = correlationId; const response = await conductorClient.post("/workflow", requestBody); return { content: [ { type: "text", text: `Workflow started successfully. Workflow ID: ${response.data}`, }, ], }; }
- src/index.ts:85-114 (schema)Schema definition for the 'start_workflow' tool, including name, description, and input schema with properties for workflowName (required), version, input, correlationId, and priority.{ name: "start_workflow", description: "Start a new workflow execution. Returns the workflow execution ID of the newly started workflow.", inputSchema: { type: "object", properties: { workflowName: { type: "string", description: "Name of the workflow to start", }, version: { type: "number", description: "Version of the workflow (optional, defaults to latest)", }, input: { type: "object", description: "Input parameters for the workflow as a JSON object", }, correlationId: { type: "string", description: "Optional correlation ID for tracking", }, priority: { type: "number", description: "Workflow execution priority (0-99, default: 0)", }, }, required: ["workflowName"], },
- src/index.ts:435-439 (registration)Registration of all tools including 'start_workflow' via the ListToolsRequestHandler that returns the tools array containing the start_workflow tool definition.server.setRequestHandler(ListToolsRequestSchema, async () => { return { tools, }; });