Skip to main content
Glama

Search a Shopify Resource

shopify_search
Read-onlyIdempotent

Search or list Shopify records such as products, orders, customers, and discounts across one store or several stores in parallel, with cursor pagination and resource-specific query filters.

Instructions

List or search one kind of record with cursor pagination, on one store (store) or several in parallel (stores; each store returns its own result and cursor). Resources:

  • products: Products (query: Shopify product search syntax).

  • collections: Manual and smart collections.

  • orders: Orders, newest first (query: Shopify order search syntax).

  • customers: Customers. Protected customer data permissions apply.

  • publications: Sales channel publication IDs (no query; 100 per page).

  • redirects: URL redirects.

  • pages: Online Store pages.

  • files: Files (images, videos, generic files).

  • metaobjects: Metaobjects of one type (type required).

  • markets: Markets (no query).

  • themes: Themes with their role; MAIN is live (no query).

  • delivery_profiles: Delivery profiles with zones, methods and flat rates (no query).

  • locations: Locations with address, active status and fulfillment capabilities (query: location search syntax).

  • price_lists: Price lists with currency, adjustment and catalog (no query).

  • metafield_definitions: Metafield definitions for one owner type (type required: PRODUCT, PRODUCTVARIANT, CUSTOMER, ORDER, COLLECTION, ...).

  • draft_orders: Draft orders, most recently updated first (query: draft order search syntax).

  • webhooks: This app's webhook subscriptions (query: such as "topic:ORDERS_CREATE"). Shopify shows an app only the webhook subscriptions it created; other apps' subscriptions are not listed.

  • blogs: Online Store blogs (query: such as "handle:news" or "title:Recipes"). Returns id, title, handle, commentPolicy, articlesCount, templateSuffix, updatedAt.

  • metaobject_definitions: Metaobject definitions: type, name, displayNameKey, field definitions (key, name, type, required), entry count, access and capabilities. No query filter; page with after.

  • marketing_events: Marketing events (campaigns, ads, posts) recorded by marketing apps, newest first: id, type, remoteId, startedAt, endedAt, description, marketingChannelType, utm fields and sourceAndMedium. query: Shopify search syntax such as "started_at:>=2026-10-01" or "type:AD".

  • abandoned_checkouts: Abandoned checkouts, newest first: id, name, createdAt, updatedAt, abandonedCheckoutUrl, totalPriceSet, customer id and email when present, and lineItemsQuantity (units, not distinct lines). Needs the protected customer data permission for customer fields; Shopify returns only checkouts from the last 90 days. query: such as "created_at:>=2026-10-01".

  • discounts: Code and automatic discounts, newest first, with title, status (ACTIVE, SCHEDULED, EXPIRED), type (__typename), summary, startsAt, endsAt, usage count and the first 3 codes of code discounts. query: Shopify discount search syntax, such as "status:active", "method:code", "type:percentage" (also fixed_amount, free_shipping, bxgy), "title:summer", "times_used:>0" or "starts_at:>2026-11-01".

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": {
      "resource": "<resource>"
    },
    "name": "shopify_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
typeNometaobjects: the metaobject type. metafield_definitions: the owner type, such as PRODUCT or CUSTOMER.
afterNoCursor from pageInfo.endCursor (single store only).
firstNo
queryNoShopify search syntax for the resource, where it takes one.
storeNoOne store alias. Give store or stores.
storesNoSeveral store aliases, searched in parallel.
resourceYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.2.0
    • changedInput schema / properties / resource / enum
      Previous value: -[
      -  "products",
      -  "collections",
      -  "orders",
      -  "customers",
      -  "publications",
      -  "redirects",
      -  "pages",
      -  "files",
      -  "metaobjects",
      -  "markets",
      -  "themes",
      -  "delivery_profiles"
      -]New value: +[
      +  "products",
      +  "collections",
      +  "orders",
      +  "customers",
      +  "publications",
      +  "redirects",
      +  "pages",
      +  "files",
      +  "metaobjects",
      +  "markets",
      +  "themes",
      +  "delivery_profiles",
      +  "locations",
      +  "price_lists",
      +  "metafield_definitions",
      +  "draft_orders",
      +  "webhooks",
      +  "blogs",
      +  "metaobject_definitions",
      +  "marketing_events",
      +  "abandoned_checkouts",
      +  "discounts"
      +]
    • changedInput schema / properties / type / description
      Previous value: -"metaobjects: the metaobject type."New value: +"metaobjects: the metaobject type. metafield_definitions: the owner type, such as PRODUCT or CUSTOMER."
  2. Addedv2.0.1

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so safety is covered; the description goes further by disclosing cursor pagination, per-store independent cursors, Shopify's app-scoped visibility for webhooks, the protected-customer-data permission requirement, and the 90-day checkout retention limit. Minor gaps remain around default page size behavior and how partial store failures in `stores` are reported.

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 the operating model, then a scannable bulleted resource list, so the density is justified by 22 resources. A few bullets carry heavy return-field detail (blogs, marketing_events, abandoned_checkouts, discounts), which is verbose but earns its place given there is no output schema.

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 22-resource, 7-parameter fan-out search tool with no output schema, the definition supplies resource enumeration, query dialect, pagination model, permission and windowing limits, and rough return shapes. An agent has enough to select the resource and construct a call without further probing.

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 71%, and the description compensates where it matters most: `query` semantics are given per resource with concrete syntax examples ("status:active", "topic:ORDERS_CREATE", "handle:news"), `stores` is explained as parallel fan-out returning a separate result and cursor per store, and `type` is clarified with owner-type values. `first` is not described in the text, leaving one moderate gap.

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 gives a specific verb and resource class ("List or search one kind of record") plus the scope (single store or several in parallel), and the 22-item resource list makes the tool's domain unambiguous against siblings like shopify_get or shopify_graphql_query.

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?

Per-resource notes tell the agent which resources accept a query and which do not ("no query" for markets, themes, publications, price_lists), which resources require `type`, and which permission/limit applies (protected customer data, 90-day abandoned checkout window). It does not, however, state when to prefer this over shopify_get, shopify_graphql_query, or the per-resource update tools, leaving that routing to inference.

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