Skip to main content
Glama

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

NameRequiredDescriptionDefault
jobIdYesthe jobId from an index reply
actionYesstatus or cancel
storageNoabsolute custom storage directory, only for a workspace kept outside the default storage; must be under the server's --storage-root

Output Schema

NameRequiredDescriptionDefault
kindNoprepare, refresh, rebuild, track, embed (the model layer of a published scope) or visual (its rendered and, with a vision profile, embedded units)
errorNo
jobIdYes
stageNonull until the job starts
stateYesqueued, running, succeeded, failed, cancelled or interrupted (its owner exited)
cancelNocancel only: accepted, pending, too_late or not_active
progressNo
nextStepsNo
workspaceIdNothe workspace the job builds in, for index status
evictedScopesNoa publish that retired the source's least recently published scope (past 8) names it

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.11.3

TDQS

A4.1/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Without relying on the annotations, the description discloses real behavior: status returns stage, progress and error or published generation; cancel kills the build and its worker process; an already-publishing job cannot be stopped and answers too_late; and it responds while builds and searches run (non-blocking). The only nuance is a mild tension with destructiveHint=false, since cancelling terminates a worker and discards in-flight work, but that is a threshold judgement, not an outright contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with purpose, then action semantics, then edge cases; nothing extraneous. The single long compound sentence is dense but every clause carries information an agent needs.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return shapes need not be described, and the state/enum semantics for cancel are covered. The description plus schema give enough to call either action correctly; only the storage parameter's role in job lookup is unaddressed outside the schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds genuine meaning: it spells out what action=status yields (state, stage, progress, error/generation) and what action=cancel does including the too_late outcome. The storage parameter is left to the schema, which already documents it fully.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names a specific resource (an index job) and the two operations it performs (status, cancel), and enumerates the exact states status can return. An agent can tell this is the job-lifecycle tool and not any of the sibling search/inspect/index tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied rather than stated: the jobId is 'from an index reply' and cancel 'stops the build', so an agent can infer this is polled after starting an index job. But there is no explicit when-to-use/when-not guidance or naming of an alternative (e.g., index for starting a job, inspect for something else).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.