Give your coding agent Shopify documentation, API schemas and code validation for building apps, themes and extensions.
Shopify AI Toolkit is a plugin that helps coding agents work with Shopify’s APIs and development tools. It provides access to developer documentation and API schemas, plus validation for GraphQL queries, Liquid templates and Shopify Extensions. Use it when your project needs Shopify-specific guidance alongside the code.
Claude Code, Codex, Cursor and VS Code can select relevant skills automatically, and also support explicit skill invocation. For development tasks, the agent reads guidance for the relevant Shopify surface when needed. Supported store-management operations use Shopify CLI’s authenticated store context, with you choosing when to execute them.
The ucp skill also guides product searches, comparisons, purchases and order tracking through UCP CLI. Direct transactions depend on the merchant’s support; other purchases use the merchant’s own checkout flow.
On Claude Code, the plugin’s telemetry hooks run automatically. Shopify also supplies activation-reporting hooks for Cursor and GitHub Copilot. Review the reporting and opt-out information in Install before use.
Ask your agent to update an older checkout or customer account extension to a newer API version. The toolkit helps with changes such as replacing legacy components with Polaris web components and converting React code to Preact where required. Review and test the migrated extension before release.
When developing a theme, API integration or extension, use the toolkit’s validation capabilities to check GraphQL queries, Liquid templates and extension code against Shopify schemas.
Describe the feature you want to build and ask your agent to identify the relevant Shopify API or app surface. The toolkit gives it access to developer documentation and schemas to inform that choice.
Ask your agent to prepare a supported store-management task through Shopify CLI. Execution uses the CLI’s authenticated store context, and you choose when to run the operation.
Ask your agent to find products within your budget and compare price, features and availability through UCP CLI. Merchant-specific carts, checkout and order tracking require a local UCP profile. The skill instructs the agent to show recipients and inputs for approval before sending requests.
After Skill or Read calls in Claude Code, reports recognized Shopify skill activations and can attach the latest captured prompt.
Installing the Claude Code plugin registers this hook automatically. Use the hook testing instructions to check reporting with a controlled skill activation. The toolkit-wide opt-out described in Install stops reporting; it does not remove the hook registration.
When you submit a prompt in Claude Code, stores it locally so the activation hook can attach it when a Shopify skill runs.
Installing the Claude Code plugin registers this hook automatically. With jq available, prompts are stored in a per-session file under a user-specific temporary directory and are sent only when a Shopify skill activates. See the prompt capture details for the file location and the hook testing instructions for controlled checks. The toolkit-wide opt-out described in Install stops local capture as well as transmission.
After tool calls in GitHub Copilot CLI or VS Code Copilot, reports recognized Shopify skill activations without attaching a prompt.
Shopify supplies this hook configuration for GitHub Copilot CLI and VS Code Copilot. Automatic loading of this file is not established by the plugin manifests, so do not assume installation has activated it. See Shopify’s hook coverage and testing instructions before relying on it. The toolkit-wide opt-out described in Install stops reporting.
After tool calls in Cursor, reports recognized Shopify skill activations without attaching a prompt.
Shopify supplies this hook configuration for Cursor. Automatic loading of this file is not established by the plugin manifests, so do not assume installation has activated it. See Shopify’s hook coverage and testing instructions before relying on it. The toolkit-wide opt-out described in Install stops reporting.
Shopify-hosted service for creating and managing stores; Shopify does not document direct Cursor connections.
Shopify names ChatGPT, Claude and Perplexity as supported hosts; store-scoped tools require authorization for the selected shop.
Usage reporting is on by default. Skill scripts can send search queries and responses, validated code and results, model and client identifiers, session identifiers and your latest message to Shopify. Activation-reporting hooks are supplied for Claude Code, Cursor and GitHub Copilot; only the Claude Code hooks capture prompts locally and can attach up to 2,000 characters when a Shopify skill activates. To opt out before use, create an empty file at ~/.config/shopify-ai-toolkit/opt-out, or $XDG_CONFIG_HOME/shopify-ai-toolkit/opt-out if that variable is set; on Windows, use %APPDATA%\shopify-ai-toolkit\opt-out. This disables reporting and local prompt capture. See Shopify’s telemetry notice for other opt-out settings.
You need Node.js 18 or later and Claude Code installed. For Claude Code setup and account access, follow the Claude Code quickstart.
Run this command in your terminal to install the Shopify AI Toolkit plugin.
claude plugin install shopify-ai-toolkit@claude-plugins-officialStart a new Claude Code session in your project to load the installed plugin.
Type a slash in chat and look for the plugin’s Shopify skills. You can also check the Installed tab in the plugin panel.
You need Node.js 18 or later and VS Code installed. Enable the Agent plugins preview in VS Code settings before installing.
Open the Command Palette and choose Chat: Install Plugin from Source.
When prompted for the repository URL, enter https://github.com/Shopify/shopify-ai-toolkit.
Start a fresh session in the intended workspace. Open Customizations, select Plugins, and confirm the Shopify plugin is listed and enabled for the harness and workspace you intend to use.
You need Node.js 18 or later and Antigravity CLI installed. This is Shopify’s installation method for the CLI.
Run this command in your terminal to install the Shopify plugin.
agy plugin install https://github.com/Shopify/shopify-ai-toolkitUse Antigravity CLI’s plugin list to confirm the Shopify plugin is installed. If you added the skills during an existing conversation, start a new conversation to refresh the available skill commands.
You need Node.js 18 or later and Cursor installed. For store operations, use the Shopify CLI connector with your authenticated store context. Do not connect Cursor directly to the hosted Shopify MCP service listed in Components.
Enter this in Cursor Chat to add the Shopify plugin.
/add-plugin shopifyType a slash in Agent chat and search for the Shopify skills.
You need Node.js 18 or later and Codex CLI installed. This whole-plugin method is for Codex CLI; the Codex IDE extension does not support plugins.
Run this command in your terminal to install Shopify from the curated marketplace.
codex plugin add shopify@openai-curatedStart a new Codex session before using the bundled skills or tools.
Open the plugin browser and confirm Shopify is installed.
You need Node.js 18 or later, Hermes Agent, Git, curl and Bash. Shopify’s installer clones the toolkit into ~/.hermes/repos/shopify-ai-toolkit and links its Hermes plugin into ~/.hermes/plugins/shopify-ai-toolkit. Running the installer again updates the checkout. The installer does not enable the plugin.
Download Shopify’s installer from your terminal.
curl -fsSL https://raw.githubusercontent.com/Shopify/Shopify-AI-Toolkit/main/.hermes-plugin/install.sh -o /tmp/shopify-hermes-install.shRun the downloaded installer in the same terminal.
bash /tmp/shopify-hermes-install.shRun this in your terminal to check the Shopify plugin’s state. If it is disabled or not enabled, enable it using the Hermes plugin instructions, then check again for the enabled state.
hermes plugins listStart a new Hermes session so the enabled plugin loads. Open the session’s plugin list and confirm the Shopify plugin is loaded; Shopify’s installer identifies it as shopify-plugin.
You need Node.js 18 or later and Pi installed. Choose one of Shopify’s package sources and run its command in your terminal.
Package source
pi install npm:@shopify/ai-toolkitpi install git:github.com/Shopify/Shopify-AI-ToolkitStart Pi to load the installed package. If Pi is already running, enter this in its chat to reload resources, as described in Pi’s command reference.
/reloadType a slash in Pi’s chat to open the command menu and confirm the Shopify skills appear. The menu shows the resources loaded in that session.
You need Node.js 18 or later and OpenClaw installed. Choose one of Shopify’s package sources and run its command in your terminal.
Package source
openclaw plugins install npm:@shopify/ai-toolkitopenclaw plugins install clawhub:@shopify/ai-toolkitopenclaw plugins install git:github.com/Shopify/Shopify-AI-ToolkitStart a new OpenClaw session to make the installed bundle’s mapped features available. The running local Gateway does not need a restart.
Check OpenClaw’s installed-plugin list for the Shopify plugin and its skills list for the Shopify skills.