Skip to main content
Glama

Follow an apply

apply_status
Read-only

Track a Shopify store sync apply's progress: steps completed, skipped or failed by resource type, current phase, bulk operation progress, elapsed and estimated time, and recent failures.

Instructions

How far an apply has got: steps created, updated, skipped, failed and left per resource type, the current phase, progress inside a Shopify bulk operation, time so far and an estimate of the time left, failures counted per resource type and reason, and the latest failures. Also answers for an apply that ended or was interrupted by a server restart. Call it after apply_plan returns a background apply, every minute or so until state is done or error. resource narrows only the listed failures; the counts always cover every resource type. For what each step wrote use get_audit_log, to stop the apply use cancel_apply, and for what was planned use get_plan.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "apply_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
plan_idNoThe plan whose apply to report on. Default: the most recent apply.
failuresNoHow many of the latest failures to list (default 20).
resourceNoList only the failures of this resource type, e.g. products.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.11.6
    • addedInput schema / properties / plan_id / description
      Added value: +"The plan whose apply to report on. Default: the most recent apply."
  2. Addedv0.11.4

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the readOnlyHint=true and openWorldHint=false annotations, it discloses that it works for applies that ended or were interrupted by a server restart, that it is a polling tool with a stop condition, and what the payload contains. It also flags the non-obvious scoping rule that filtering failures does not change the aggregate counts.

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?

The reporting scope is front-loaded and every clause carries information, but the opening sentence is a long comma-chained enumeration that is harder to scan than a short lead plus bullets. No sentence is pure filler, so the only cost is density.

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?

With no output schema, the description compensates fully by describing the returned fields, and it covers timing, polling termination, defaults, and sibling routing. Nothing an agent needs in order to call this correctly appears to be missing.

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 earns a bump by clarifying the interaction between 'resource' and the failure listing versus the always-global counts. The plan_id default and failures limit are left entirely to the schema, so it stops short of a 5.

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?

The description names the specific resource (an apply's progress) and enumerates exactly what is reported: per-resource step counts, current phase, Shopify bulk-operation progress, elapsed and estimated time, and failures by type and reason. It also explicitly separates itself from get_audit_log, cancel_apply and get_plan, so an agent can pick it without opening a schema.

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

Usage Guidelines5/5

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

It gives an explicit trigger and cadence: 'Call it after apply_plan returns a background apply, every minute or so until state is done or error.' It also routes other intents to named alternatives ('For what each step wrote use get_audit_log, to stop the apply use cancel_apply, and for what was planned use get_plan').

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