Skip to main content
Glama

shopify_bulk_operation_status

Read-onlyIdempotent

Check the current status of a Shopify bulk operation, either the latest one or a specific operation by ID, to confirm completion or progress.

Instructions

Get the current status of the most recent (or a specific) Shopify bulk operation.

Args: bulk_operation_id: Optional bulk-operation GID. Defaults to the latest. project_id: Authenticated Project UUID. project_ref: Exact project correlation reference. connector_account_ref: Project-bound connector account alias. idempotency_key: Stable business-action identity. effect: Required and must be read; Spring verifies it. approval_ref: Approved platform task UUID when resuming a write.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
effectYes
project_idNo
project_refNo
approval_refNo
idempotency_keyNo
bulk_operation_idNo
connector_account_refNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv0.1.1
    • addedInput schema / properties / approval_ref
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Approval Ref"
      +}
    • addedInput schema / properties / connector_account_ref
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Connector Account Ref"
      +}
    • addedInput schema / properties / effect
      Added value: +{
      +  "const": "read",
      +  "title": "Effect",
      +  "type": "string"
      +}
    • addedInput schema / properties / idempotency_key
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Idempotency Key"
      +}
    • addedInput schema / properties / project_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Project Id"
      +}
    • addedInput schema / properties / project_ref
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Project Ref"
      +}
    • addedInput schema / required
      Added value: +[
      +  "effect"
      +]
  2. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already carry the safety profile (readOnlyHint=true, idempotentHint=true, destructiveHint=false), so the burden on the description is lower. It adds genuine value beyond the annotations: the default-to-latest behavior, the 'Spring verifies it' runtime check on effect, and the contextual role of approval_ref for resuming a write. There is no contradiction with the annotations — the tool is read-only and the approval_ref mention describes an identifier used in a broader write-resume flow, not a write performed here.

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 purpose sentence is front-loaded and the args block is compact. Given the 0% schema coverage, documenting every parameter is justified and earns its place. Minor redundancy exists — the effect line repeats the schema's required/const information — but the added 'Spring verifies it' detail keeps it from being pure waste.

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

Completeness3/5

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

The picture is largely complete: annotations cover the safety profile, an output schema exists so return values need no explanation, and all parameters are documented. The gaps are the missing guidance on the status→result lifecycle with shopify_bulk_operation_result and the vagueness of a few parameter glosses (project_ref, connector_account_ref), which could leave an agent unsure how to populate them correctly.

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 description coverage is 0%, so the description carries the full burden — and it compensates well by glossing every one of the 7 parameters with a semantic meaning (e.g., bulk_operation_id is a GID defaulting to latest, effect is required and must be 'read'). Some glosses are template-sounding and vague (project_ref as 'Exact project correlation reference', connector_account_ref as 'Project-bound connector account alias') and do not tell the agent how to obtain the values, which prevents 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 opening sentence uses a specific verb (Get) and resource (current status of a Shopify bulk operation), and it distinguishes itself from the closely-related siblings shopify_bulk_operation_create and shopify_bulk_operation_result by explicitly focusing on 'status' rather than creation or result retrieval. The 'most recent (or a specific)' qualifier further pins down the selection semantics.

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?

The description conveys clear context — this is for polling the status of the latest or a named bulk operation — and the bulk_operation_id note explains when to omit it (defaults to latest) versus when to supply it (specific operation). However, it never explicitly contrasts this tool with its closest sibling shopify_bulk_operation_result, so an agent must infer the status-vs-result workflow (poll status first, then fetch result) from the name alone rather than from stated guidance.

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