Shopify AI Toolkit
AI coding agents can search the web, read documentation, and inspect your codebase, but they still need the right context at the right time to be effective. Shopify development depends on platform-specific details: which API surface applies, what fields exist in a schema, which CLI command to run, and how an app or extension configuration should be validated.
Shopify AI Toolkit gives your AI coding tool a Shopify-aware starting point. The toolkit connects your agent to:
- Developer docs and API schemas: look up the relevant Shopify API surface and work from current reference material, rather than relying only on model memory or broad web search.
- Code validation: validate GraphQL queries, Liquid templates, and Shopify Extensions against Shopify schemas to catch issues earlier.
- Store management: prepare and run supported store-management tasks through Shopify CLI's authenticated store context, with you choosing when to execute them.
Anchor to RequirementsRequirements
Before you install the Shopify AI Toolkit, make sure you have:
- Node.js 18 or higher installed on your system.
- A supported AI tool: Claude Code, Codex, Antigravity CLI, Cursor, Hermes (plugin only), or Visual Studio Code.
Anchor to Install with a plugin (recommended)Install with a plugin (recommended)
Plugins are the recommended way to install the AI Toolkit. The plugin bundles everything into a single install and updates automatically as new capabilities are released.
Claude Code
In your terminal, run claude plugin install:
Terminal
Codex
In your terminal, run codex plugin add:
Terminal
Antigravity CLI
In your terminal, install the Shopify plugin:
Terminal
Cursor
In Cursor Chat, add the Shopify plugin:
Cursor Chat
Hermes
In your terminal, download the install script and run it:
Terminal
VS Code
-
Ensure the Agent plugins preview is enabled in your VS Code settings.
-
Open the Command Palette (
Cmd+Shift+Pon macOS,Ctrl+Shift+Pon Windows/Linux) and run:VS Code: Command Palette
Chat: Install Plugin From Source -
When prompted, enter the repository URL:
VS Code: Plugin source URL
https://github.com/Shopify/shopify-ai-toolkit
In your terminal, run claude plugin install:
Terminal
Anchor to Install with agent skillsInstall with agent skills
If you prefer to pick specific capabilities, you can manually add individual agent skills. You can browse the full list of available skills on GitHub. Note that manually added skills don't auto-update, so you'll need to pull updates yourself.
To install all skills:
Terminal
To install a single skill, use the --skill flag. For example, to install only the GraphQL Admin API skill:
Terminal
Anchor to Install with the Dev MCP serverInstall with the Dev MCP server
If you prefer MCP, you can connect to Shopify's developer resources through the Dev MCP server. The server runs locally and doesn't require authentication.
Claude Code
-
In your terminal, tell
claudeto add the MCP server:Terminal
claude mcp add --transport stdio shopify-dev-mcp -- npx -y @shopify/dev-mcp@latest -
Restart Claude Code to load the new configuration.
Codex CLI
-
Add this configuration to your
~/.codex/config.tomlfile:Codex configuration
[mcp_servers.shopify-dev-mcp]command = "npx"args = ["-y", "@shopify/dev-mcp@latest"]NoteCodex uses TOML format with
mcp_servers(snake_case) instead of JSON withmcpServers(camelCase). For more information, see the Codex MCP documentation.Note:Codex uses TOML format with
mcp_servers(snake_case) instead of JSON withmcpServers(camelCase). For more information, see the Codex MCP documentation. -
Restart Codex to load the new configuration.
Antigravity CLI
-
Add this configuration to your
~/.gemini/config/mcp_config.jsonfile:Antigravity CLI configuration
{"mcpServers": {"shopify-dev-mcp": {"command": "npx","args": ["-y", "@shopify/dev-mcp@latest"]}}} -
Restart Antigravity CLI to load the new configuration.
Cursor
-
Open Cursor and go to Cursor > Settings > Cursor Settings > Tools and MCP > New MCP server.
-
Add this configuration to your MCP servers (or use this link to add it automatically):
Cursor configuration
{"mcpServers": {"shopify-dev-mcp": {"command": "npx","args": ["-y", "@shopify/dev-mcp@latest"]}}}If you see connection errors on Windows, try this alternative configuration:
Alternative configuration for Windows
{"mcpServers": {"shopify-dev-mcp": {"command": "cmd","args": ["/k", "npx", "-y", "@shopify/dev-mcp@latest"]}}} -
Save your configuration and restart Cursor.
VS Code
-
Open VS Code and open the Command Palette (
Cmd+Shift+Pon MacOS,Ctrl+Shift+Pon Windows/Linux). -
Search for and select MCP: Open User Configuration.
-
Add this configuration to your user-level
mcp.jsonfile:VS Code MCP configuration
{"servers": {"shopify-dev-mcp": {"command": "npx","args": ["-y", "@shopify/dev-mcp@latest"]}}} -
Save your configuration and restart VS Code.
-
In your terminal, tell
claudeto add the MCP server:Terminal
claude mcp add --transport stdio shopify-dev-mcp -- npx -y @shopify/dev-mcp@latest -
Restart Claude Code to load the new configuration.
Anchor to Example: migrate extensions with the toolkitExample: migrate extensions with the toolkit
One clear use case is extension migration. Checkout and customer account Shopify Extensions on API versions before 2025-10 need to adopt Polaris web components when upgrading to newer API versions.
These migrations involve repetitive, detail-heavy work:
- Updating the extension API version in
shopify.extension.toml. - Converting React-based extension code to Preact where required.
- Replacing legacy components with Polaris web components.
- Updating extension APIs and target-specific imports.
- Reviewing the migration guide to confirm all required steps.
- Running and testing the migrated extension locally.
With the toolkit installed, you can ask your agent to handle the migration. For example:
Example prompt
The toolkit doesn't remove the need to review and test the result. It helps automate the bulk of the migration work so you can spend more time validating behavior and preparing the updated extension for release.
Anchor to Next stepsNext steps
After installing, your AI tool automatically draws on Shopify's developer resources when you ask it Shopify-related questions. Ask it to:
- Use Shopify CLI to scaffold a new Shopify app.
- Explain what Shopify app surfaces are and help you choose the right one.
- Explore Shopify APIs and find the right one for your use case.
- Review your app against Shopify App Store requirements.