Skip to main content
Glama

Bulk Export

shopify_bulk_export
Read-only

Export entire Shopify resource—orders, products, customers, inventory, collections, or draft orders—from one store in one bulk operation with optional search filters and get a JSONL download URL.

Instructions

Export a whole resource from one store in one step, with no pagination or size limit: orders, products, variants, customers, inventory (levels per location), collections or draft orders, with an optional Shopify search filter such as "created_at:>=2026-10-01". Starts a Shopify bulk operation, waits up to waitSeconds, and returns the JSONL download URL (valid 7 days) and row counts; sampleRows also returns the first rows. Large stores can take minutes: call again with action:"status" and the id. resource custom runs your own bulk query. Changes nothing in the store.

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": {
      "store": "<store>"
    },
    "name": "shopify_bulk_export"
  }
}

Input Schema

NameRequiredDescriptionDefault
idNostatus/cancel: BulkOperation GID from start
queryNostart with resource custom: your own bulk query (one top-level connection, no variables)
storeYesConfigured store alias
actionNostart (default), status, or cancelstart
filterNostart: Shopify search filter, such as "created_at:>=2026-10-01" or "status:active"
ticketNostatus/cancel on a hosted server: the ticket start returned
resourceNostart: what to export. custom needs query.
sampleRowsNoWhen finished: also return the first rows of the file
waitSecondsNostart/status: wait up to this long for the export to finish

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.2.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already establish read-only and non-destructive; the description adds real operational detail beyond them: it starts an async bulk operation, blocks up to waitSeconds, returns a JSONL URL valid 7 days, and short-circuits via action:'status'. It omits the per-store concurrency limit (Shopify typically permits one bulk operation at a time), which matters given idempotentHint:false — a repeated start could spawn a second operation.

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-loads the capability and scope before the operational caveats, and nearly every clause adds information. The closing 'Changes nothing in the store' partly restates readOnlyHint and the density of the run-on first sentence costs a little readability.

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 9-parameter tool with no output schema, the description still tells the agent what comes back (JSONL URL, 7-day validity, row counts, optional sample rows), how long it may block, and how to resume. Nothing needed to call it correctly is 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 goes further by explaining parameter interaction across actions: id/ticket are for status/cancel, query is required only with resource:'custom', sampleRows applies only when finished, and filter accepts Shopify search syntax with a worked example. That is meaning the schema states only piecemeal.

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 and resource ('Export a whole resource from one store in one step') and then enumerates the exact resource set, immediately distinguishing it from paginated read tools by declaring 'no pagination or size limit'. An agent can identify it without opening the schema.

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 concrete routing: use this for whole-resource dumps, use action:'status' with the id when a large store takes minutes, and use resource:'custom' with your own query. It does not compare against specific siblings such as shopify_search or shopify_graphql_query_many, so the 'prefer this over X' decision is implied rather than stated.

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