Skip to main content
List jobs that belong to a specific batch

Tool details

FieldValue
Namelist_job_batch_jobs
GroupJobs

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "batch_id": {
      "type": "string",
      "description": "Batch ID"
    },
    "status": {
      "type": "string",
      "enum": [
        "submitted",
        "working",
        "completed",
        "failed",
        "canceled"
      ],
      "description": "Filter by job status"
    },
    "limit": {
      "type": "number",
      "minimum": 1,
      "maximum": 100,
      "description": "Number of results per page (default: 20, max: 100)",
      "default": 20
    },
    "cursor": {
      "type": "string",
      "description": "Pagination cursor (job ID) from previous response"
    }
  },
  "required": [
    "project_reference",
    "batch_id"
  ],
  "additionalProperties": false,
  "description": "Input schema for the list_job_batch_jobs tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "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."
      },
      "description": "Job records for the requested page."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor representing the current result page."
        },
        "first": {
          "type": "null",
          "description": "Always null because these job list endpoints do not expose a first-page cursor."
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the next page of results, or null when exhausted."
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the previous page when available, otherwise null."
        }
      },
      "required": [
        "self",
        "first",
        "next",
        "prev"
      ],
      "additionalProperties": false,
      "description": "Pagination cursors for traversing the job list."
    }
  },
  "required": [
    "data",
    "page_info"
  ],
  "additionalProperties": false,
  "description": "Paginated list of runtime jobs for a project.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}