feat(copilot): execute workflow run cancellations

Author: j15z

apps/sim/lib/copilot/generated/tool-catalog-v1.ts

@@ -34,6 +34,7 @@ export interface ToolCatalogEntry {
     | 'browser_type'
     | 'browser_wait_for'
     | 'call_integration_tool'
+    | 'cancel_workflow_run'
     | 'connect_slack_bot'
     | 'cp'
     | 'create_empty_file'
@@ -163,6 +164,7 @@ export interface ToolCatalogEntry {
     | 'browser_type'
     | 'browser_wait_for'
     | 'call_integration_tool'
+    | 'cancel_workflow_run'
     | 'connect_slack_bot'
     | 'cp'
     | 'create_empty_file'
@@ -1614,6 +1616,31 @@ export const CallIntegrationTool: ToolCatalogEntry = {
   requiresApproval: true,
 }
 
+export const CancelWorkflowRun: ToolCatalogEntry = {
+  id: 'cancel_workflow_run',
+  name: 'cancel_workflow_run',
+  route: 'sim',
+  mode: 'async',
+  parameters: {
+    type: 'object',
+    properties: {
+      executionId: {
+        type: 'string',
+        description:
+          'Required workflow execution ID returned by run_workflow with async:true or found with query_logs. This identifies a workflow run, not an agent invocation or chat request.',
+      },
+      workflowId: {
+        type: 'string',
+        description:
+          'Workflow ID that owns the execution. Optional; omit it to target the current workflow. Pass it when cancelling a run from another workflow.',
+      },
+    },
+    required: ['executionId'],
+  },
+  requiredPermission: 'write',
+  requiresApproval: true,
+}
+
 export const ConnectSlackBot: ToolCatalogEntry = {
   id: 'connect_slack_bot',
   name: 'connect_slack_bot',
@@ -4426,7 +4453,11 @@ export const Run: ToolCatalogEntry = {
         description: 'Pre-gathered context: workflow state, block IDs, input requirements.',
         type: 'string',
       },
-      request: { description: 'What to run or what logs to check.', type: 'string' },
+      request: {
+        description:
+          'What to run or cancel, or what logs to check. Include a known workflow executionId when cancelling.',
+        type: 'string',
+      },
     },
     required: ['request'],
     type: 'object',
@@ -7015,6 +7046,7 @@ export const TOOL_CATALOG: Record<string, ToolCatalogEntry> = {
   [BrowserType.id]: BrowserType,
   [BrowserWaitFor.id]: BrowserWaitFor,
   [CallIntegrationTool.id]: CallIntegrationTool,
+  [CancelWorkflowRun.id]: CancelWorkflowRun,
   [ConnectSlackBot.id]: ConnectSlackBot,
   [Cp.id]: Cp,
   [CreateEmptyFile.id]: CreateEmptyFile,

apps/sim/lib/copilot/generated/tool-schemas-v1.ts

@@ -1560,6 +1560,25 @@ export const TOOL_RUNTIME_SCHEMAS: Record<string, ToolRuntimeSchemaEntry> = {
     },
     resultSchema: undefined,
   },
+  cancel_workflow_run: {
+    parameters: {
+      type: 'object',
+      properties: {
+        executionId: {
+          type: 'string',
+          description:
+            'Required workflow execution ID returned by run_workflow with async:true or found with query_logs. This identifies a workflow run, not an agent invocation or chat request.',
+        },
+        workflowId: {
+          type: 'string',
+          description:
+            'Workflow ID that owns the execution. Optional; omit it to target the current workflow. Pass it when cancelling a run from another workflow.',
+        },
+      },
+      required: ['executionId'],
+    },
+    resultSchema: undefined,
+  },
   connect_slack_bot: {
     parameters: {
       type: 'object',
@@ -4328,7 +4347,8 @@ export const TOOL_RUNTIME_SCHEMAS: Record<string, ToolRuntimeSchemaEntry> = {
           type: 'string',
         },
         request: {
-          description: 'What to run or what logs to check.',
+          description:
+            'What to run or cancel, or what logs to check. Include a known workflow executionId when cancelling.',
           type: 'string',
         },
       },

apps/sim/lib/copilot/tool-executor/register-handlers.ts

@@ -1,5 +1,6 @@
 import { createLogger } from '@sim/logger'
 import {
+  CancelWorkflowRun,
   ConnectSlackBot,
   Cp as CpTool,
   CreateWorkflow,
@@ -92,6 +93,7 @@ import {
   executeVfsRm,
 } from '../tools/handlers/vfs-mutate'
 import {
+  executeCancelWorkflowRun,
   executeCreateWorkflow,
   executeGenerateApiKey,
   executeMoveWorkflow,
@@ -146,6 +148,7 @@ function buildHandlerMap(): Record<string, ToolHandler> {
     rename_workflow: h(executeRenameWorkflow),
     move_workflow: h(executeMoveWorkflow),
     [RunWorkflow.id]: h(executeRunWorkflow),
+    [CancelWorkflowRun.id]: h(executeCancelWorkflowRun),
     [RunWorkflowUntilBlock.id]: h(executeRunWorkflowUntilBlock),
     [RunFromBlock.id]: h(executeRunFromBlock),
     [RunBlock.id]: h(executeRunBlock),

apps/sim/lib/copilot/tool-executor/router.test.ts

@@ -0,0 +1,29 @@
+/**
+ * @vitest-environment node
+ */
+
+import { describe, expect, it } from 'vitest'
+import { hasHandler } from '@/lib/copilot/tool-executor/executor'
+import { ensureHandlersRegistered } from '@/lib/copilot/tool-executor/register-handlers'
+import {
+  getToolEntry,
+  isSimExecuted,
+  toolRequiresApproval,
+} from '@/lib/copilot/tool-executor/router'
+
+describe('workflow-run cancellation tool routing', () => {
+  it('routes cancellation through Sim with write permission and explicit approval', () => {
+    expect(getToolEntry('cancel_workflow_run')).toMatchObject({
+      requiredPermission: 'write',
+      route: 'sim',
+    })
+    expect(isSimExecuted('cancel_workflow_run')).toBe(true)
+    expect(toolRequiresApproval('cancel_workflow_run')).toBe(true)
+  })
+
+  it('registers the Sim cancellation handler', () => {
+    ensureHandlersRegistered()
+
+    expect(hasHandler('cancel_workflow_run')).toBe(true)
+  })
+})

apps/sim/lib/copilot/tools/handlers/param-types.ts

@@ -60,6 +60,12 @@ export interface RunWorkflowParams {
   useDeployedState?: boolean
 }
 
+export interface CancelWorkflowRunParams {
+  workflowId?: string
+  /** The workflow execution ID returned by run_workflow or query_logs. */
+  executionId?: string
+}
+
 export interface RunWorkflowUntilBlockParams {
   workflowId?: string
   workflow_input?: unknown

apps/sim/lib/copilot/tools/handlers/workflow/mutations.test.ts

@@ -37,6 +37,7 @@ vi.mock('@/lib/core/telemetry', () => ({
 }))
 
 import {
+  executeCancelWorkflowRun,
   executeCreateWorkflow,
   executeGenerateApiKey,
   executeMoveWorkflow,
@@ -161,6 +162,51 @@ describe('workflow mutation Copilot adapters', () => {
     )
   })
 
+  it('cancels a workflow run through the registered application command', async () => {
+    mocks.executeWorkflowUseCase.mockResolvedValue({
+      success: true,
+      executionId: 'execution-1',
+      redisAvailable: true,
+      durablyRecorded: true,
+      locallyAborted: false,
+      pausedCancelled: false,
+      reason: 'recorded',
+      workflowId: 'workflow-1',
+      workspaceId: 'workspace-1',
+    })
+
+    const result = await executeCancelWorkflowRun(
+      { workflowId: 'workflow-1', executionId: 'execution-1' },
+      context
+    )
+
+    expect(result).toEqual({
+      success: true,
+      output: {
+        workflowId: 'workflow-1',
+        executionId: 'execution-1',
+        durablyRecorded: true,
+        locallyAborted: false,
+        pausedCancelled: false,
+        reason: 'recorded',
+      },
+    })
+    expect(mocks.executeWorkflowUseCase).toHaveBeenCalledWith(
+      context,
+      expect.objectContaining({
+        operation: expect.objectContaining({ id: 'workflows.runs.cancel' }),
+      }),
+      { workflowId: 'workflow-1', runId: 'execution-1' }
+    )
+  })
+
+  it('requires an execution ID before attempting workflow-run cancellation', async () => {
+    const result = await executeCancelWorkflowRun({ workflowId: 'workflow-1' }, context)
+
+    expect(result).toEqual({ success: false, error: 'executionId is required' })
+    expect(mocks.executeWorkflowUseCase).not.toHaveBeenCalled()
+  })
+
   it.each([
     {
       label: 'until',

apps/sim/lib/copilot/tools/handlers/workflow/mutations.ts

@@ -15,6 +15,7 @@ import {
 import { requireCopilotWorkspace } from '@/lib/copilot/tools/server/workspace-scope'
 import { decodeVfsPathSegments, encodeVfsPathSegments } from '@/lib/copilot/vfs/path-utils'
 import { PlatformEvents } from '@/lib/core/telemetry'
+import { cancelWorkflowRun } from '@/lib/workflows/application/cancel-run'
 import { createWorkflow } from '@/lib/workflows/application/create-workflow'
 import { moveWorkflowsBulk } from '@/lib/workflows/application/move-workflows-bulk'
 import {
@@ -171,6 +172,7 @@ function copilotRunLifecycle(context: ExecutionContext) {
 }
 
 import type {
+  CancelWorkflowRunParams,
   CreateWorkflowParams,
   GenerateApiKeyParams,
   MoveWorkflowParams,
@@ -282,6 +284,49 @@ export async function executeRunWorkflow(
   }
 }
 
+export async function executeCancelWorkflowRun(
+  params: CancelWorkflowRunParams,
+  context: ExecutionContext
+): Promise<ToolCallResult> {
+  try {
+    const workflowId = params.workflowId || context.workflowId
+    if (!workflowId) {
+      return { success: false, error: 'workflowId is required' }
+    }
+    const executionId = resolveInputFromExecutionId(params.executionId)
+    if (!executionId) {
+      return { success: false, error: 'executionId is required' }
+    }
+
+    assertWorkflowMutationNotAborted(
+      context,
+      'Request aborted before workflow run cancellation could be applied.'
+    )
+    const result = await executeCopilotWorkflowUseCase(context, cancelWorkflowRun, {
+      workflowId,
+      runId: executionId,
+    })
+
+    return {
+      success: result.success,
+      output: {
+        workflowId: result.workflowId,
+        executionId: result.executionId,
+        durablyRecorded: result.durablyRecorded,
+        locallyAborted: result.locallyAborted,
+        pausedCancelled: result.pausedCancelled,
+        reason: result.reason,
+      },
+      error: result.success ? undefined : 'Workflow run cancellation could not be completed',
+    }
+  } catch (error) {
+    return {
+      success: false,
+      error: messageForCopilotWorkflowError(error, 'Failed to cancel workflow run'),
+    }
+  }
+}
+
 export async function executeSetGlobalWorkflowVariables(
   params: SetGlobalWorkflowVariablesParams,
   context: ExecutionContext

apps/sim/lib/copilot/tools/tool-display.test.ts

@@ -646,6 +646,9 @@ describe('opaque id suppression', () => {
   it('falls back to the generic label instead of printing a workflow id', () => {
     expect(getToolDisplayTitle('run_workflow', { workflowName: uuid })).toBe('Running workflow')
     expect(getToolDisplayTitle('run_workflow', { name: uuid })).toBe('Running workflow')
+    expect(getToolDisplayTitle('cancel_workflow_run', { executionId: uuid })).toBe(
+      'Cancelling workflow run'
+    )
   })
 
   it('suppresses a bare-hex id too', () => {

apps/sim/lib/copilot/tools/tool-display.ts

@@ -550,6 +550,7 @@ const TOOL_TITLES: Record<string, string> = {
   prepare_file_edit: 'Editing file',
   apply_file_edit: 'Writing changes',
   create_workflow: 'Creating workflow',
+  cancel_workflow_run: 'Cancelling workflow run',
   edit_workflow: 'Editing workflow',
   manage_knowledge_base: 'Managing knowledge base',
   search_knowledge_base: 'Searching knowledge base',