Building on Shopify should not mean wrestling with APIs or writing boilerplate code. Shopify Dev Assistant helps you learn, code, and ship faster with AI trained on Shopify's developer documentation.
You can use Shopify Dev Assistant in two places:
- In the Shopify developer docs, where it can answer questions, explain concepts, and generate starter code.
- In supported IDEs through the Shopify Dev MCP server, where it can use your project files for context-aware help.
Anchor to Use Dev Assistant in the docsUse Dev Assistant in the docs
Your journey often begins on Shopify.dev. When you’re reading the docs and a question comes up, Dev Assistant is available from the top navigation bar.
Use it to ask quick questions, understand APIs, and work through multi-step development flows without leaving the docs.
For example, you can ask:
What’s the best way to paginate through orders using GraphQL?Or you can walk through a full workflow:
I want to offer a free gift with every purchase over $100. What kind of Function should I use?How do I build a Cart Transform Function to do that?Now that I have the code, how do I activate this function on my store?Anchor to Generate code from the docsGenerate code from the docs
Dev Assistant can bridge the gap between learning and doing. When you ask for help, it can generate ready-to-use code, not just explain a concept.
For the Admin API, it can provide ready-to-run GraphQL operations. Every code block includes a "Run in GraphiQL" button, so you can test the query or mutation directly from the chat UI. To use this feature, make sure you have a Shopify app running locally.
For Shopify Functions, Dev Assistant can provide a complete code scaffold. It gives you the boilerplate for your use case, so you can focus on the customization instead of looking up input and output structures.
Anchor to Use Dev Assistant in your IDEUse Dev Assistant in your IDE
Using the Shopify Dev MCP server, you can connect Dev Assistant to supported IDEs like Cursor.
This is Shopify's recommended method for AI-assisted development because it gives the assistant project context. It can reference your files, dependencies, and file structure, then tailor its answers to your app.
Use the IDE assistant to:
- Generate code that matches your project's style and dependencies.
- Scaffold Shopify Functions or Admin API calls directly in your editor.
- Debug issues with suggestions based on the files in your project.
Think of it as pair programming with an assistant that knows Shopify's docs and can read your project.
Anchor to Common workflowsCommon workflows
The assistant is most useful when you give it a specific task and enough context. These workflows are good starting points.
Generate Admin API operations
Writing GraphQL operations can be tedious. You need the right fields, filters, pagination structure, and mutation syntax.
Instead of switching between your editor and the API docs, describe the data you need in plain language.
I want to append NEW! to the title of the most recently added product in my store.Dev Assistant can generate a formatted query or mutation that handles the nested objects and pagination for you.
Scaffold Shopify Functions
Shopify Functions can handle complex logic, but getting started requires a few setup decisions. You need to choose the right Function API, understand the input and output structure, and write the initial JavaScript or Rust code before you can focus on your business logic.
Describe the logic you want to create, and Dev Assistant can generate a working Function scaffold.
Create a function to ensure shoppers can only check out when the order total is less than 500 USD.The assistant can generate a complete function file with the correct input structure and validation logic. From there, you can refine the behavior for your app.
Build Polaris interfaces
A strong app UI matters, but building pages from scratch takes time. You need to remember component names, props, and layout patterns.
Dev Assistant can generate structured Polaris code from a description of the interface you want.
Create a component for a settings page using Polaris. It should have a page title of Settings, a card containing a form with a text field for an API Key, and a primary Save button at the bottom.The assistant can generate the JSX structure so you can focus on wiring the UI to your app logic.
Generate and validate Liquid
Custom storefront work often requires Liquid syntax, theme context, objects, filters, loops, and conditional logic. A small syntax mistake can break the page.
Dev Assistant can generate Liquid snippets or validate existing Liquid code.
Create a Liquid snippet for a 4-column product grid. For each product, show its featured image, title, vendor, and price. If the product is on sale, display a Sale badge and show the compare_at_price.The assistant can generate the for loop, output the product properties, and add the conditional sale logic.
Anchor to Tips for better promptsTips for better prompts
To get better output, treat Dev Assistant like another developer on your team. Give it context, constraints, and a clear goal.
Provide the goal and the context
Instead of:
This code doesn't work.Try:
I'm trying to create a cart transform function to add a free gift, but I'm getting an error that the input format is wrong. Here is my code.Break down complex problems
Ask for the smallest useful piece first, then iterate.
Build a product discount function that applies a 10% discount to products with the sale tag.After you verify it works, ask for the next layer:
Add a metafield setting so the merchant can configure that percentage.Anchor to Get startedGet started
Install the Shopify Dev MCP Server to bring Dev Assistant into your IDE, or ask questions in the docs by clicking the Assistant button on any page in the Shopify developer docs.
Let us know in the community forums how you're using Shopify Dev Assistant, what tips you've discovered, or what questions you have.
