`skyvern_cancel_run`

Pack: skyvern · Connect: https://pipeworx.io/mcp (see Connect below for a single-pack URL)

No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/skyvern_cancel_run for the schema, then POST the same URL with its arguments for the data.

Cancel a Skyvern run that is still queued or running, to stop further per-step billing. Requires your own Skyvern API key as _apiKey.

Parameters

Name	Type	Required	Description
`run_id`	string	yes	The run_id to cancel.
`_apiKey`	string	no

Example call

Arguments

{
  "run_id": "tsk_123456789",
  "_apiKey": "your-skyvern-api-key"
}

curl

curl -X POST https://gateway.pipeworx.io/skyvern/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"skyvern_cancel_run","arguments":{"run_id":"tsk_123456789","_apiKey":"your-skyvern-api-key"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('skyvern_cancel_run', {
  "run_id": "tsk_123456789",
  "_apiKey": "your-skyvern-api-key"
});

Response shape

Field	Type	Description
`run_id`	string \| null
`status`	string \| null
`finished`	boolean
`succeeded`	boolean
`output`	unknown
`failure_reason`	string \| null
`step_count`	number \| null
`created_at`	string \| null
`finished_at`	string \| null
`recording_url`	string \| null
`screenshot_urls`	array
`app_url`	string \| null
`warning`	string \| null
`next`	string \| null
`max_steps`	number \| null
`cancel_requested`	boolean
`source`	string \| null

Full JSON Schema

{
  "type": "object",
  "properties": {
    "run_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "type": [
        "string",
        "null"
      ]
    },
    "finished": {
      "type": "boolean"
    },
    "succeeded": {
      "type": "boolean"
    },
    "output": {},
    "failure_reason": {
      "type": [
        "string",
        "null"
      ]
    },
    "step_count": {
      "type": [
        "number",
        "null"
      ]
    },
    "created_at": {
      "type": [
        "string",
        "null"
      ]
    },
    "finished_at": {
      "type": [
        "string",
        "null"
      ]
    },
    "recording_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "screenshot_urls": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "app_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "warning": {
      "type": [
        "string",
        "null"
      ]
    },
    "next": {
      "type": [
        "string",
        "null"
      ]
    },
    "max_steps": {
      "type": [
        "number",
        "null"
      ]
    },
    "cancel_requested": {
      "type": "boolean"
    },
    "source": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "additionalProperties": true
}

Connect

Add this to your MCP client config — every tool in the catalog, including this one — or use one-click install buttons:

{
  "mcpServers": {
    "pipeworx": {
      "url": "https://pipeworx.io/mcp"
    }
  }
}

Connect to just the skyvern pack

{
  "mcpServers": {
    "skyvern": {
      "url": "https://gateway.pipeworx.io/skyvern/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

skyvern_cancel_run