Skip to main content
Glama
Antonytm

mcp-sitecore-server

by Antonytm

authoring-get-job

Read-only

Retrieve a Sitecore background job's state, progress, and messages by name or handle. Use it to check whether an index rebuild or queued operation has finished.

Instructions

Reads one Sitecore background job by name or handle over the Authoring and Management API, returning its state, progress and messages. This is how you find out whether an index rebuild or other queued operation finished. Supply exactly one of jobName or handle.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
handleNoThe job handle returned when the job was queued. Supply this or jobName.
jobNameNoThe exact job name, e.g. 'Index_Update_IndexName=sitecore_master_index'. Supply this or handle.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.5

TDQS

A4.5/5.0
Behavior4/5

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

readOnlyHint=true already establishes this as a safe read. The description adds useful behavior beyond the annotation: the returned fields and the mutual-exclusion rule ('exactly one of jobName or handle'). Missing details like error behavior when neither/both are supplied, but the added context exceeds the annotation baseline.

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

Conciseness5/5

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

Three short sentences: purpose, usage context, and the parameter constraint, front-loaded and free of filler. Every sentence carries distinct information.

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

Completeness5/5

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

For a two-parameter read-only lookup with no output schema, the description covers what it does, why you'd call it, what it returns, and how to disambiguate the inputs. Nothing needed to invoke it correctly is absent.

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. The description adds real value by stating the exactly-one-of constraint between jobName and handle — the schema lists both as optional with no such rule — so it earns above baseline.

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?

States a specific verb (Reads), a precise resource (one Sitecore background job), the transport (Authoring and Management API), and the lookup keys (name or handle). It also declares what the return contains (state, progress, messages), which is enough to distinguish it from the sibling list-style tools like authoring-list-jobs.

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

Usage Guidelines4/5

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

Gives a clear use-case: 'This is how you find out whether an index rebuild or other queued operation finished.' That tells the agent when to reach for it. It does not name alternatives (e.g. authoring-list-jobs) or say when not to use it, so it stops short of a 5.

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

Deploy Server

Other Tools