jobs
Check an index build's status or cancel it, with queued, running, succeeded, failed, cancelled and interrupted states, stage, progress, errors, and publication details.
Instructions
Status or cancellation of an index job. status reports state (queued, running, succeeded, failed, cancelled, interrupted), stage, progress and the error or published generation; cancel stops the build and its worker process before reporting cancelled, and a job already publishing finishes (too_late). Responds while builds and searches run.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"action": "<action>",
"jobId": "<jobId>"
},
"name": "jobs"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| jobId | Yes | the jobId from an index reply | |
| action | Yes | status or cancel | |
| storage | No | absolute custom storage directory, only for a workspace kept outside the default storage; must be under the server's --storage-root |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | prepare, refresh, rebuild, track, embed (the model layer of a published scope) or visual (its rendered and, with a vision profile, embedded units) | |
| error | No | ||
| jobId | Yes | ||
| stage | No | null until the job starts | |
| state | Yes | queued, running, succeeded, failed, cancelled or interrupted (its owner exited) | |
| cancel | No | cancel only: accepted, pending, too_late or not_active | |
| progress | No | ||
| nextSteps | No | ||
| workspaceId | No | the workspace the job builds in, for index status | |
| evictedScopes | No | a publish that retired the source's least recently published scope (past 8) names it |