For the complete documentation index, see llms.txt. This page is also available as Markdown.

Jobs

Back to the MCP tool reference.

run_job

Start a policy-authorized job; direct secret values are forbidden. Mount item schemas, included here for MCP clients that do not expand JSON Schema references: - storage_volumes: {storage, container_path, read_only=false} - disk_volumes: {disk, container_path, read_only=false} - secret_files: {secret, container_path} storage and disk accept short references or exact same-context URIs. secret must be a secret: reference. secret_env maps an environment variable name to a secret: reference; env accepts non-sensitive literal values only.

Operation type: Write

Annotations: read-only false, destructive false, idempotent false, open-world true

Input schema:

{
  "$defs": {
    "DiskVolumeInput": {
      "properties": {
        "container_path": {
          "title": "Container Path",
          "type": "string"
        },
        "disk": {
          "description": "Disk URI/reference",
          "title": "Disk",
          "type": "string"
        },
        "read_only": {
          "default": false,
          "title": "Read Only",
          "type": "boolean"
        }
      },
      "required": [
        "disk",
        "container_path"
      ],
      "title": "DiskVolumeInput",
      "type": "object"
    },
    "SecretFileInput": {
      "properties": {
        "container_path": {
          "title": "Container Path",
          "type": "string"
        },
        "secret": {
          "description": "secret: reference only; never a secret value",
          "title": "Secret",
          "type": "string"
        }
      },
      "required": [
        "secret",
        "container_path"
      ],
      "title": "SecretFileInput",
      "type": "object"
    },
    "StorageVolumeInput": {
      "properties": {
        "container_path": {
          "title": "Container Path",
          "type": "string"
        },
        "read_only": {
          "default": false,
          "title": "Read Only",
          "type": "boolean"
        },
        "storage": {
          "description": "Storage URI/reference, never a credential",
          "title": "Storage",
          "type": "string"
        }
      },
      "required": [
        "storage",
        "container_path"
      ],
      "title": "StorageVolumeInput",
      "type": "object"
    }
  },
  "properties": {
    "cluster": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cluster"
    },
    "command": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Command"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Description"
    },
    "disk_volumes": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/DiskVolumeInput"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Disk Volumes"
    },
    "energy_schedule": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Energy Schedule"
    },
    "entrypoint": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Entrypoint"
    },
    "env": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Env"
    },
    "http_auth": {
      "default": true,
      "title": "Http Auth",
      "type": "boolean"
    },
    "http_port": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Http Port"
    },
    "image": {
      "title": "Image",
      "type": "string"
    },
    "life_span_seconds": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Life Span Seconds"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "org": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Org"
    },
    "preset": {
      "title": "Preset",
      "type": "string"
    },
    "priority": {
      "anyOf": [
        {
          "enum": [
            "low",
            "normal",
            "high"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Priority"
    },
    "project": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Project"
    },
    "restart_policy": {
      "default": "never",
      "enum": [
        "never",
        "on-failure",
        "always"
      ],
      "title": "Restart Policy",
      "type": "string"
    },
    "schedule_timeout_seconds": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Schedule Timeout Seconds"
    },
    "scheduler_enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Scheduler Enabled"
    },
    "secret_env": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Secret Env"
    },
    "secret_files": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/SecretFileInput"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Secret Files"
    },
    "storage_volumes": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/StorageVolumeInput"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Storage Volumes"
    },
    "tags": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Tags"
    },
    "wait_for_jobs_quota": {
      "default": false,
      "title": "Wait For Jobs Quota",
      "type": "boolean"
    },
    "workdir": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Workdir"
    }
  },
  "required": [
    "image",
    "preset"
  ],
  "title": "run_jobArguments",
  "type": "object"
}

Output schema:

list_jobs

List jobs using context and bounded status/name/tag/owner/time filters.

Operation type: Read-only

Annotations: read-only true, destructive false, idempotent true, open-world true

Input schema:

Output schema:

get_job

Get one job and its resolved context.

Operation type: Read-only

Annotations: read-only true, destructive false, idempotent true, open-world true

Input schema:

Output schema:

exec_job

Execute one non-interactive command in an owned running job. The executable and argument list are shell-quoted separately; no stdin or TTY is exposed. Output is duration/byte bounded and credential-redacted. Use mounted secrets or secret environment references instead of command arguments for credentials.

Operation type: Write

Annotations: read-only false, destructive false, idempotent false, open-world true

Input schema:

Output schema:

start_job_port_forward

Start a loopback-only background forward to one running owned job. Forwarded bytes never enter MCP results. The listener remains active until stop_job_port_forward is called or the MCP server exits.

Operation type: Write

Annotations: read-only false, destructive false, idempotent false, open-world true

Input schema:

Output schema:

list_job_port_forwards

List active forwards owned by this MCP process and exact context.

Operation type: Read-only

Annotations: read-only true, destructive false, idempotent true, open-world true

Input schema:

Output schema:

stop_job_port_forward

Stop one exact background forward owned by this MCP process.

Operation type: Write

Annotations: read-only false, destructive false, idempotent false, open-world true

Input schema:

Output schema:

wait_for_job

Poll until terminal state, always bounded by timeout_seconds.

Operation type: Read-only

Annotations: read-only true, destructive false, idempotent true, open-world true

Input schema:

Output schema:

get_job_logs

Read a bounded log prefix with explicit timeout and truncation metadata.

Operation type: Read-only

Annotations: read-only true, destructive false, idempotent true, open-world true

Input schema:

Output schema:

get_job_telemetry

Collect a bounded telemetry summary and optionally bounded raw samples.

Operation type: Read-only

Annotations: read-only true, destructive false, idempotent true, open-world true

Input schema:

Output schema:

bump_job_life_span

Extend a job lifespan under full or owned managed policy.

Operation type: Write

Annotations: read-only false, destructive false, idempotent false, open-world true

Input schema:

Output schema:

send_job_signal

Send the SDK's graceful signal under full or owned managed policy.

Operation type: Write

Annotations: read-only false, destructive false, idempotent false, open-world true

Input schema:

Output schema:

save_job_image

Save an owned job filesystem to a policy-authorized image target.

Operation type: Write

Annotations: read-only false, destructive false, idempotent false, open-world true

Input schema:

Output schema:

kill_job

Kill a job under full or owned managed policy.

Operation type: Destructive write

Annotations: read-only false, destructive true, idempotent true, open-world true

Input schema:

Output schema:

Last updated

Was this helpful?