Skip to main content
Cancel a running or submitted job

Tool details

FieldValue
Namecancel_job
GroupJobs

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "job_id": {
      "type": "string",
      "description": "Job ID to cancel"
    }
  },
  "required": [
    "project_reference",
    "job_id"
  ],
  "additionalProperties": false,
  "description": "Input schema for the cancel_job tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Job identifier."
    },
    "project_id": {
      "type": "string",
      "description": "Project identifier that owns the job."
    },
    "environment_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Environment identifier associated with the job, or null when not environment-scoped."
    },
    "branch_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Branch identifier associated with the job, or null when using mainline project state."
    },
    "cron_job_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cron job identifier when the job was scheduled from a cron definition."
    },
    "batch_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Batch identifier when the job belongs to a grouped submission."
    },
    "name": {
      "type": "string",
      "description": "Human-readable job name."
    },
    "status": {
      "type": "string",
      "description": "Lifecycle status of the job."
    },
    "target": {
      "type": "string",
      "description": "Execution target, such as a container image, script path, or task target name."
    },
    "config": {
      "type": "object",
      "additionalProperties": {
        "description": "Additional structured values associated with this result."
      },
      "description": "Resolved job configuration payload passed to the runtime."
    },
    "timeout_seconds": {
      "type": "number",
      "description": "Execution timeout for the job in seconds."
    },
    "backoff_limit": {
      "type": "number",
      "description": "Maximum retry count configured for the job."
    },
    "exit_code": {
      "type": [
        "number",
        "null"
      ],
      "description": "Process exit code when the job has completed."
    },
    "failed_reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "Failure reason when the job did not complete successfully."
    },
    "started_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Timestamp when job execution started."
    },
    "completed_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Timestamp when job execution finished."
    },
    "created_at": {
      "type": "string",
      "description": "Timestamp when the job was created."
    },
    "updated_at": {
      "type": "string",
      "description": "Timestamp when the job was last updated."
    }
  },
  "required": [
    "id",
    "project_id",
    "environment_id",
    "branch_id",
    "cron_job_id",
    "batch_id",
    "name",
    "status",
    "target",
    "config",
    "timeout_seconds",
    "backoff_limit",
    "exit_code",
    "failed_reason",
    "started_at",
    "completed_at",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false,
  "description": "Runtime job record returned by MCP job tools.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}