shopify-dev — Codex skill: what it does, how to install
Vector search across shopify.dev documentation. Use it when requests cross multiple platform APIs or lack dedicated skills.
npx skills add openai/plugins --skill shopify-dev -a codexWhat shopify-dev does
The skill queries the developer portal documentation via a vector search runner named scripts/search_docs.mjs. Instead of letting the model guess field names, it pulls real payload specifications, field types, and code snippets directly into context.
Node.js must be present on your machine, because the search runner cannot run without the runtime. By default, queries and error logs stream telemetry to shopify.dev/mcp/usage. Setting OPT_OUT_INSTRUMENTATION=true in your shell environment disables this tracking.
Keep in mind this is an umbrella searcher. If your question focuses strictly on Admin GraphQL, Liquid templates, or Checkout Extensions, use targeted skills like shopify-liquid instead.
What it helps with
- fetch code patterns across general Shopify APIs
- inspect data types and allowable field values from shopify.dev
- resolve questions spanning multiple Shopify services
Example prompts for the agent
- Search Shopify documentation on app authentication flows
- Find API rate limits across Shopify developer guides
- Look up webhook delivery mechanics on Shopify
How to install shopify-dev
1Skills CLI (Vercel)
npx skills add openai/plugins --skill shopify-dev -a codex2Manually: put the files in place
.agents/skills/shopify-dev/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add openai/plugins --skill shopify-dev -a claude-code2Manually: put the files in place
~/.claude/skills/shopify-dev/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/shopify-dev/
Manually: put the files in place
.cursor/skills/shopify-dev/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install openai/plugins shopify-dev2Manually: put the files in place
.github/skills/shopify-dev/SKILL.mdPlatform CLI
gemini skills install https://github.com/openai/plugins --path plugins/shopify/skills/shopify-devManually: put the files in place
.devin/skills/shopify-dev/SKILL.mdThe legacy .windsurf/skills/ path still works
Claude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: Codex skills: how to install, where they live, how to call them
Questions about shopify-dev
How to install shopify-dev in Codex?
Run npx skills add openai/plugins --skill shopify-dev -a codex. The skill definition will be added to .agents/skills/shopify-dev/SKILL.md.
What does shopify-dev do?
It searches general developer guides across shopify.dev using vector queries, retrieving types, valid parameters, and code snippets before the assistant replies.
What are the system requirements for shopify-dev?
You need Node.js installed to execute the search script. If you want to disable telemetry sent to shopify.dev/mcp/usage, set OPT_OUT_INSTRUMENTATION=true.