get_gp_task_job_status

The get_gp_task_job_status tool fetches the current status of an asynchronous geoprocessing job by its job ID. It is the polling counterpart to async GP task submission—agents call it repeatedly until the job reaches a terminal state, then read the result.

Tool Name

get_gp_task_job_status

Tool Alias

Get GP Task Job Status

Objective

Return the current jobStatus (and, once available, the final result) for an asynchronous GPServer job, given the task URL and job ID returned when the job was originally submitted.

Description

get_gp_task_job_status fetches the status for an asynchronous GPServer job and returns the current job information.

This tool is paired with async GP task submission—the jobId parameter is the identifier returned when the job was originally submitted. The agent calls get_gp_task_job_status repeatedly to poll the job until it finishes.

Polling pattern

  • Poll the tool until jobStatus reaches a terminal state (success or failure) before reading result.
  • While the job is still running, result is null. Only inspect result once jobStatus confirms the job has completed.

Pointing at the right URL

Important: taskUrl must point at the specific task, not the container

The taskUrl parameter must point at the specific task within a GPServer—not at the GPServer container itself—and must match the URL the job was submitted against. Submitting against one task URL and polling another will return errors or unrelated job statuses.

When to use

  • An async GP job has been submitted and the agent needs to check its progress.
  • The agent needs to retrieve the final result of an async GP job once it has completed.

When not to use

  • The job was submitted synchronously. Synchronous jobs return their results directly; there is no separate status to poll.
  • The agent does not yet have a jobId. get_gp_task_job_status cannot start a job—use the corresponding GP task submission flow first.
  • The agent needs the task definition (its inputs and outputs) rather than a job's status. Use get_gp_task_definition for that.

Schema

The full JSON Schema definitions for the input parameters accepted by get_gp_task_job_status and the output payload it returns are provided as separate files alongside this document.

Input schema

The input schema describes the required taskUrl (the fully qualified URL of the specific GPServer task) and jobId (the identifier returned when the job was submitted).

Download or view GetGPTaskJobStatusToolInputSchema.json

Output schema

The output schema describes the response object: the current jobStatus string and an optional result object that contains the task's outputs once the job has succeeded (null while the job is still running or if it has failed).

Download or view GetGPTaskJobStatusToolOutputSchema.json

Sample prompts to test the tool

To be added.