Skip to content

Shopify/Shopify-AI-Toolkit

Shopify Dev MCP - AI Agent Plugin

Connect your AI tools to the Shopify platform.

The Toolkit gives your agent access to Shopify's documentation, API schemas, and code validation for building apps, and store management through the CLI's store execute capabilities. For more info, see the docs.

Install

  • For Claude Code: Run these two commands in a chat:

    /plugin marketplace add Shopify/shopify-ai-toolkit
    /plugin install shopify-plugin@shopify-ai-toolkit
    
  • For Cursor: Install from the Cursor Marketplace.

  • For Gemini CLI: Run this command in your terminal:

    gemini extensions install https://github.com/Shopify/shopify-ai-toolkit
    
  • For OpenAI Codex: In the Codex CLI, run /plugins, search for Shopify, and select Add to Codex.

  • For VS Code: Open the Command Palette (CMD+SHIFT+P) and run Chat: Install Plugin From Source.

    Then paste:

    https://github.com/Shopify/shopify-ai-toolkit
    

What you get

  • Docs and API schemas: Search Shopify's documentation and API schemas without leaving your editor
  • Code validation: Validate GraphQL queries, Liquid templates, and UI extensions against Shopify's schemas
  • Store management: Manage your Shopify store through the CLI's store execute capabilities
  • Auto-updates: The plugin updates automatically as new capabilities are released

Telemetry

The skill scripts (scripts/search_docs.mjs, scripts/validate.mjs) send a usage event to https://shopify.dev/mcp/usage on each invocation. The payload includes:

  • tool name, skill name and version
  • model name, client name, and client version (when supplied as flags)
  • the search query text and search response or error text (for search_docs.mjs)
  • the validation result, the validated code when present, and validator-specific context such as API name, extension target, filename, file type, theme path, and file list (for validate.mjs)
  • artifact ID and revision number (when supplied)

This is on by default. To opt out, set the environment variable:

OPT_OUT_INSTRUMENTATION=true

Other install methods

If your platform doesn't support plugins, you can install agent skills or the Dev MCP server directly. For instructions, see shopify.dev/docs/apps/build/ai-toolkit.

Contributing

Thanks for your interest but we don't accept pull requests. Any pull requests will be automatically closed.

About

Agent plugins/extensions for CLIs and IDEs

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors