shopify-plugin
v1.6.1Shopify developer tools for OpenAI Codex — search Shopify docs, generate and validate GraphQL, Liquid, and UI extension code. Skill scripts send usage telemetry (queries, code, model/client identifiers) to shopify.dev by default; set OPT_OUT_INSTRUMENTATION=true to disable.
by ShopifyMIT491updated 3 days ago
Source
git clone https://github.com/Shopify/Shopify-AI-ToolkitClone the source, then follow the repository's marketplace instructions for your runtime. The repository root is the plugin root.
Layout
├── .codex-plugin/plugin.json├── .claude-plugin/plugin.json├── skills/shopify-admin/SKILL.md├── skills/shopify-app-store-review/SKILL.md├── skills/shopify-custom-data/SKILL.md├── skills/shopify-customer/SKILL.md├── skills/shopify-dev/SKILL.md├── skills/shopify-functions/SKILL.md├── skills/shopify-hydrogen/SKILL.md├── skills/shopify-liquid/SKILL.md├── skills/shopify-onboarding-dev/SKILL.md├── skills/shopify-onboarding-merchant/SKILL.md├── skills/shopify-partner/SKILL.md├── skills/shopify-payments-apps/SKILL.md├── skills/shopify-polaris-admin-extensions/SKILL.md├── skills/shopify-polaris-app-home/SKILL.md├── skills/shopify-polaris-checkout-extensions/SKILL.md├── skills/shopify-polaris-customer-account-extensions/SKILL.md├── skills/shopify-pos-ui/SKILL.md├── skills/shopify-shopifyql/SKILL.md├── skills/shopify-storefront-graphql/SKILL.md├── skills/shopify-use-shopify-cli/SKILL.md└── skills/ucp/SKILL.md
Skills21
Write or explain **Admin GraphQL** queries and mutations for apps and integrations that extend the Shopify admin. Use when the user wants to **understand, design, or generate** the operation itself—even before deciding how to run it. Do **not** choose `admin` first for **app or extension config validation** —use **`use-shopify-cli`**. Do **not** choose `admin` first to **execute** Admin GraphQL **now via Shopify CLI** or for CLI setup/troubleshooting on store workflows—use **`use-shopify-cli`** (store auth/execute, handle/SKU/location lookups, inventory changes).
Run a pre-submission compliance check against your Shopify app's codebase. Reviews App Store requirements and surfaces likely issues before you submit for official review.
MUST be used first when prompts mention Metafields or Metaobjects. Use Metafields and Metaobjects to model and store custom data for your app. Metafields extend built-in Shopify data types like products or customers, Metaobjects are custom data types that can be used to store bespoke data structures. Metafield and Metaobject definitions provide a schema and configuration for values to follow.
The Customer Account API allows customers to access their own data including orders, payment methods, and addresses.
Search Shopify developer documentation across all APIs. Use only when no API-specific skill applies.
Shopify Functions allow developers to customize the backend logic that powers parts of Shopify. Available APIs: Discount, Cart and Checkout Validation, Cart Transform, Pickup Point Delivery Option Generator, Delivery Customization, Fulfillment Constraints, Local Pickup Delivery Option Generator, Order Routing Location Rule, Payment Customization
Hydrogen storefront implementation cookbooks. Some of the available recipes are: B2B Commerce, Bundles, Combined Listings, Custom Cart Method, Dynamic Content with Metaobjects, Express Server, Google Tag Manager Integration, Infinite Scroll, Legacy Customer Account Flow, Markets, Partytown + Google Tag Manager, Subscriptions, Third-party API Queries and Caching. MANDATORY: Use this API for ANY Hydrogen storefront question - do NOT use Storefront GraphQL when 'Hydrogen' is mentioned.
Liquid is an open-source templating language created by Shopify. It is the backbone of Shopify themes and is used to load dynamic content on storefronts. Keywords: liquid, theme, shopify-theme, liquid-component, liquid-block, liquid-section, liquid-snippet, liquid-schemas, shopify-theme-schemas
Get started building on Shopify. Use when a developer asks to build an app, build a theme, create a dev store, set up a partner account, scaffold a project, or get started developing for Shopify. NOT for merchants managing stores.
Set up and connect a Shopify store from your AI assistant. Use when the user wants to start selling online, open a first Shopify store, try Shopify before they have an account, or get merchant-facing next steps after a preview store is created, including how to keep it, save it, or make it real. This is for store owners — not developers. Preview-store creation for brand-new merchants belongs here via `shopify store create preview`; explicit CLI troubleshooting and named-store command execution belong in **`use-shopify-cli`**.
The Partner API lets you programmatically access data about your Partner Dashboard, including your apps, themes, and affiliate referrals.
The Payments Apps API enables payment providers to integrate their payment solutions with Shopify's checkout.
Add custom actions and blocks from your app at contextually relevant spots throughout the Shopify Admin. Admin UI Extensions also supports scaffolding new adminextensions using Shopify CLI commands.
Build your app's primary user interface embedded in the Shopify admin. If the prompt just mentions `Polaris` and you can't tell based off of the context what API they meant, assume they meant this API.
Build custom functionality that merchants can install at defined points in the checkout flow, including product information, shipping, payment, order summary, and Shop Pay. Checkout UI Extensions also supports scaffolding new checkout extensions using Shopify CLI commands.
Build custom functionality that merchants can install at defined points on the Order index, Order status, and Profile pages in customer accounts. Customer Account UI Extensions also supports scaffolding new customer account extensions using Shopify CLI commands.
Build retail point-of-sale applications using Shopify's POS UI components. These components provide a consistent and familiar interface for POS applications. POS UI Extensions also supports scaffolding new POS extensions using Shopify CLI commands. Keywords: POS, Retail, smart grid
Answer a merchant's **analytics and reporting** questions with **ShopifyQL** — Shopify's query language for aggregated store metrics that the Admin GraphQL API cannot compute. Choose this (not `admin`) whenever the ask is for **numbers, totals, trends, or breakdowns** rather than fetching or mutating individual records: including but not limited to total/gross/net sales and revenue, order counts, average order value, refunds, quantity sold, sessions, conversion rate, and traffic — sliced by product, channel, region, or customer, trended over time, or compared period-over-period. Examples: "total sales last 7 days", "orders by sales channel this month", "top products by revenue", "conversion rate this week", "sales this year vs last year". This topic covers writing the ShopifyQL query; if the merchant wants to run it against their store, execution is handed off to `use-shopify-cli`. Not for general Admin GraphQL record operations — fetching or mutating individual resources (use `admin`).
Use for custom storefronts requiring direct GraphQL queries/mutations for data fetching and cart operations. Choose this when you need full control over data fetching and rendering your own UI. NOT for Web Components - if the prompt mentions HTML tags like <shopify-store>, <shopify-cart>, use storefront-web-components instead.
Choose when the user needs **Shopify CLI** to run or fix something now: validate app or extension config on disk (`shopify.app.toml`, `shopify.app.<name>.toml`, `shopify.extension.toml`); run or troubleshoot store workflows (`shopify store auth`, `shopify store execute`); or perform explicit store-scoped reads/writes on a named store domain (for example, show/list/find the first 10 products on my store at `foo.myshopify.com`, or inventory and product changes by handle, SKU, or location name). Emphasize **commands and operational steps**, not only authoring GraphQL. Skip for API-only understanding or codegen with no CLI execution, and skip for brand-new merchant asks to start a Shopify store or try Shopify before they have an account. Examples: validate configuration before deploy; run an existing query via CLI; show the first 10 products on `foo.myshopify.com`; missing `shopify store execute`.
Use when the user wants to use the UCP CLI to find, compare, buy, or track products from online merchants, or to set up and troubleshoot the local UCP profile required for merchant-scoped operations. Covers global catalog search ("find me X under $Y"), named-merchant transactions ("buy this from Z.com"), order tracking, `ucp profile init`, `ucp doctor`, carts, checkout, orders, and UCP setup/help. Falls back to merchant-hosted handoff when direct in-protocol checkout isn't available.
Manifests2
{
"name": "shopify-plugin",
"version": "1.6.1",
"description": "Shopify developer tools for OpenAI Codex — search Shopify docs, generate and validate GraphQL, Liquid, and UI extension code. Skill scripts send usage telemetry (queries, code, model/client identifiers) to shopify.dev by default; set OPT_OUT_INSTRUMENTATION=true to disable.",
"author": {
"name": "Shopify"
},
"homepage": "https://shopify.dev/docs/apps/build/devmcp",
"repository": "https://github.com/Shopify/shopify-plugins",
"license": "MIT",
"keywords": [
"shopify",
"graphql",
"liquid",
"storefront",
"admin-api"
],
"skills": "./skills/",
"interface": {
"displayName": "Shopify",
"shortDescription": "Search Shopify docs, validate GraphQL & Liquid, build Shopify apps faster.",
"longDescription": "Search live Shopify documentation, generate and validate Admin API GraphQL, Storefront API queries, Liquid theme code, and UI extension components — all without leaving your workflow.",
"developerName": "Shopify",
"category": "Productivity",
"capabilities": [
"Read"
],
"logo": "./assets/shopify_glyph.svg",
"composerIcon": "./assets/shopify_glyph.svg",
"brandColor": "#008060",
"websiteURL": "https://shopify.dev",
"defaultPrompt": [
"How do I create a product using the Shopify Admin API?",
"Generate a Liquid section with a product image gallery",
"Validate my GraphQL query against the Storefront API schema",
"Create a cart validation Function requiring minimum 5 items"
]
}
}{
"name": "shopify-plugin",
"description": "Shopify developer tools for Claude Code — search Shopify docs, generate and validate GraphQL, Liquid, and UI extension code. Skill scripts send usage telemetry (queries, code, model/client identifiers) to shopify.dev by default; set OPT_OUT_INSTRUMENTATION=true to disable.",
"version": "1.6.1",
"author": {
"name": "Shopify"
},
"license": "MIT",
"keywords": [
"shopify",
"mcp",
"graphql",
"liquid",
"storefront",
"admin-api"
]
}