mirror of
https://github.com/Shopify/Shopify-AI-Toolkit.git
synced 2026-09-18 09:41:58 +08:00
Initial plugin structure for Shopify AI Toolkit
Sets up multi-plugin monorepo layout with plugins/shopify-plugin as the first plugin, supporting Claude Code, Cursor, and Gemini CLI. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Durga
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"name": "shopify-plugin",
|
||||
"owner": {
|
||||
"name": "Shopify"
|
||||
},
|
||||
"metadata": {
|
||||
"description": "Shopify developer tools for Claude Code"
|
||||
},
|
||||
"plugins": [
|
||||
{
|
||||
"name": "shopify-plugin",
|
||||
"source": "./plugins/shopify-plugin",
|
||||
"description": "Search Shopify docs, generate and validate GraphQL, Liquid, and UI extension code",
|
||||
"version": "1.0.0",
|
||||
"author": { "name": "Shopify" },
|
||||
"license": "MIT",
|
||||
"homepage": "https://github.com/shopify-playground/Shopify-AI-Toolkit",
|
||||
"keywords": ["shopify", "mcp", "graphql", "liquid", "storefront", "admin-api"]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"name": "shopify-ai-toolkit",
|
||||
"owner": {
|
||||
"name": "Shopify"
|
||||
},
|
||||
"metadata": {
|
||||
"description": "Shopify AI toolkit plugins for Cursor"
|
||||
},
|
||||
"plugins": [
|
||||
{
|
||||
"name": "shopify-plugin",
|
||||
"source": "./plugins/shopify-plugin",
|
||||
"description": "Search Shopify docs, generate and validate GraphQL, Liquid, and UI extension code",
|
||||
"version": "1.0.0",
|
||||
"author": { "name": "Shopify" },
|
||||
"license": "MIT",
|
||||
"homepage": "https://shopify.dev/docs/apps/build/devmcp",
|
||||
"keywords": ["shopify", "mcp", "graphql", "liquid", "storefront", "admin-api"]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
* @shopify/dev_experience
|
||||
@@ -0,0 +1,73 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, gender identity and expression, level of experience,
|
||||
nationality, personal appearance, race, religion, or sexual identity and
|
||||
orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
- Using welcoming and inclusive language
|
||||
- Being respectful of differing viewpoints and experiences
|
||||
- Gracefully accepting constructive criticism
|
||||
- Focusing on what is best for the community
|
||||
- Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
- The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at opensource@shopify.com. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct/
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
@@ -0,0 +1,7 @@
|
||||
# Contributing
|
||||
|
||||
Thanks for your interest but we don't accept pull requests. Any pull requests will be automatically closed.
|
||||
|
||||
If you have feedback or suggestions, please share them in the [Shopify Developer Community](https://community.shopify.dev/).
|
||||
|
||||
If you are a Shopify employee, please reach out to Dev Tools: Dev Experience team at help-dev-platform.
|
||||
@@ -0,0 +1,7 @@
|
||||
# Before you create this pull request
|
||||
|
||||
Thanks for your interest but we don't accept pull requests. Any pull requests will be automatically closed.
|
||||
|
||||
If you have feedback or suggestions, please share them in the [Shopify Developer Community](https://community.shopify.dev/).
|
||||
|
||||
If you are a Shopify employee, please reach out to Dev Tools: Dev Experience team at help-dev-platform.
|
||||
@@ -0,0 +1,36 @@
|
||||
name: Close All PRs
|
||||
|
||||
on:
|
||||
pull_request_target:
|
||||
types: [opened, reopened]
|
||||
|
||||
permissions:
|
||||
pull-requests: write
|
||||
|
||||
jobs:
|
||||
close-pr:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Close PR and comment
|
||||
uses: actions/github-script@v7
|
||||
with:
|
||||
script: |
|
||||
const prNumber = context.payload.pull_request.number;
|
||||
|
||||
// Add comment to PR
|
||||
await github.rest.issues.createComment({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: prNumber,
|
||||
body: `Thanks for your interest but we don't accept pull requests. Any pull requests will be automatically closed.\n\nIf you have feedback or suggestions, please share them in the [Shopify Developer Community](https://community.shopify.dev/).\n\nIf you are a Shopify employee, please reach out to Dev Tools: Dev Experience team at help-dev-platform.`
|
||||
});
|
||||
|
||||
// Close the PR
|
||||
await github.rest.pulls.update({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
pull_number: prNumber,
|
||||
state: 'closed'
|
||||
});
|
||||
|
||||
console.log(`Closed PR #${prNumber}`);
|
||||
@@ -0,0 +1,9 @@
|
||||
MIT License
|
||||
|
||||
Copyright 2025-present, Shopify Inc.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
@@ -0,0 +1,7 @@
|
||||
# Shopify AI Toolkit
|
||||
|
||||
This repository hosts AI coding agent plugins.
|
||||
|
||||
## Plugins
|
||||
|
||||
- [shopify-plugin](plugins/shopify-plugin/) — Shopify developer tools for Claude Code, Cursor, Gemini CLI, and Codex
|
||||
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"name": "shopify-mcp",
|
||||
"version": "1.0.0",
|
||||
"mcpServers": {
|
||||
"shopify-mcp": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "@shopify/dev-mcp@latest"],
|
||||
"env": {
|
||||
"POLARIS_UNIFIED": "true",
|
||||
"LIQUID": "true"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"name": "shopify-plugin",
|
||||
"version": "1.0.0",
|
||||
"private": true,
|
||||
"description": "AI agent plugin manifests for the Shopify Dev MCP server",
|
||||
"author": "Shopify",
|
||||
"license": "MIT",
|
||||
"keywords": ["shopify", "mcp", "graphql", "liquid", "storefront", "admin-api", "plugin"]
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"name": "shopify-plugin",
|
||||
"description": "Shopify developer tools for Claude Code — search Shopify docs, generate and validate GraphQL, Liquid, and UI extension code",
|
||||
"version": "1.0.0",
|
||||
"author": { "name": "Shopify" },
|
||||
"license": "MIT",
|
||||
"keywords": ["shopify", "mcp", "graphql", "liquid", "storefront", "admin-api"]
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"name": "shopify-plugin",
|
||||
"description": "Shopify developer tools for Cursor — search Shopify docs, generate and validate GraphQL, Liquid, and UI extension code",
|
||||
"version": "1.0.0",
|
||||
"author": { "name": "Shopify" },
|
||||
"logo": "assets/shopify_glyph.svg",
|
||||
"homepage": "https://shopify.dev/docs/apps/build/devmcp",
|
||||
"repository": "https://github.com/shopify-playground/Shopify-AI-Toolkit",
|
||||
"license": "MIT",
|
||||
"keywords": ["shopify", "mcp", "graphql", "liquid", "storefront", "admin-api"]
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"mcpServers": {
|
||||
"shopify-mcp": {
|
||||
"type": "stdio",
|
||||
"command": "npx",
|
||||
"args": ["-y", "@shopify/dev-mcp@latest"]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
MIT License
|
||||
|
||||
Copyright 2025-present, Shopify Inc.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
@@ -0,0 +1,83 @@
|
||||
# Shopify Dev MCP - AI Agent Plugin
|
||||
|
||||
This plugin connects AI coding agents to the Shopify Dev MCP server, giving them access to Shopify's dev docs, API schemas, and development guidance. Ask questions and build on top of Shopify APIs without leaving your editor or terminal.
|
||||
|
||||
**What you get:**
|
||||
|
||||
- Search Shopify docs and API schemas on the fly
|
||||
- Generate code for GraphQL Admin API, Storefront API, Functions, Liquid, and more
|
||||
- Validate components, GraphQL, and theme files to ensure they're free of hallucinations
|
||||
- Build Shopify apps faster with context-aware assistance
|
||||
|
||||
## Requirements
|
||||
|
||||
* Node.js 18+ with npm/npx available
|
||||
* One of the supported agents below
|
||||
|
||||
> **First-run note:** On first use, npx will download the `@shopify/dev-mcp` package and its dependencies (~3 MB). This takes a few seconds and only happens once per machine.
|
||||
|
||||
## Installation
|
||||
|
||||
### GitHub Copilot (VS Code)
|
||||
|
||||
Open the Command Palette (`Cmd+Shift+P`) and run:
|
||||
|
||||
```
|
||||
Chat: Install Plugin From Source
|
||||
```
|
||||
|
||||
Enter the repository URL: `https://github.com/Shopify/shopify-plugins`
|
||||
|
||||
Or use the Copilot CLI:
|
||||
|
||||
```bash
|
||||
copilot plugin install Shopify/shopify-plugins
|
||||
```
|
||||
|
||||
### Gemini CLI
|
||||
|
||||
```bash
|
||||
gemini extensions install https://github.com/Shopify/shopify-plugins
|
||||
```
|
||||
|
||||
### Claude Code
|
||||
|
||||
```bash
|
||||
/plugin marketplace add Shopify/shopify-plugins
|
||||
/plugin install shopify-plugin@shopify-plugin
|
||||
```
|
||||
|
||||
### Cursor
|
||||
|
||||
Install via **Dashboard → Settings → Plugins → Team Marketplaces → Import** and paste:
|
||||
|
||||
```
|
||||
https://github.com/Shopify/shopify-plugins
|
||||
```
|
||||
|
||||
Or browse for it on [cursor.directory](https://cursor.directory).
|
||||
|
||||
We also recommend [installing the Shopify CLI](https://shopify.dev/docs/api/shopify-cli#installation) to make it easier to build and test your app.
|
||||
|
||||
## Usage
|
||||
|
||||
Once installed, you can ask questions and give tasks like:
|
||||
|
||||
- "Create a validation Function requiring minimum 5 items in cart before checkout."
|
||||
- "How do I create a product using the Admin API?"
|
||||
- "Show me an example of a webhook subscription."
|
||||
- "What fields are available on the Order object?"
|
||||
|
||||
The MCP server automatically searches Shopify's documentation to provide accurate responses.
|
||||
|
||||
## Resources
|
||||
|
||||
- [Shopify Dev MCP documentation](https://shopify.dev/docs/apps/build/devmcp)
|
||||
- [Get started with Shopify apps](https://shopify.dev/docs/apps/getting-started)
|
||||
- [Scaffold a Shopify app](https://shopify.dev/docs/apps/build/scaffold-app)
|
||||
|
||||
## Contributing
|
||||
|
||||
Thanks for your interest but we don't accept pull requests. Any pull requests will be automatically closed.
|
||||
|
||||
If you are a Shopify employee, please open your pull request at [Shopify/dev-mcp](https://github.com/Shopify/dev-mcp).
|
||||
+26
@@ -0,0 +1,26 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Generator: Adobe Illustrator 23.0.2, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
||||
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||
viewBox="0 0 109.5 124.5" style="enable-background:new 0 0 109.5 124.5;" xml:space="preserve">
|
||||
<style type="text/css">
|
||||
.st0{fill:#95BF47;}
|
||||
.st1{fill:#5E8E3E;}
|
||||
.st2{fill:#FFFFFF;}
|
||||
</style>
|
||||
<g>
|
||||
<path class="st0" d="M95.9,23.9c-0.1-0.6-0.6-1-1.1-1c-0.5,0-9.3-0.2-9.3-0.2s-7.4-7.2-8.1-7.9c-0.7-0.7-2.2-0.5-2.7-0.3
|
||||
c0,0-1.4,0.4-3.7,1.1c-0.4-1.3-1-2.8-1.8-4.4c-2.6-5-6.5-7.7-11.1-7.7c0,0,0,0,0,0c-0.3,0-0.6,0-1,0.1c-0.1-0.2-0.3-0.3-0.4-0.5
|
||||
c-2-2.2-4.6-3.2-7.7-3.1c-6,0.2-12,4.5-16.8,12.2c-3.4,5.4-6,12.2-6.8,17.5c-6.9,2.1-11.7,3.6-11.8,3.7c-3.5,1.1-3.6,1.2-4,4.5
|
||||
c-0.3,2.5-9.5,73-9.5,73l76.4,13.2l33.1-8.2C109.5,115.8,96,24.5,95.9,23.9z M67.2,16.8c-1.8,0.5-3.8,1.2-5.9,1.8
|
||||
c0-3-0.4-7.3-1.8-10.9C64,8.6,66.2,13.7,67.2,16.8z M57.2,19.9c-4,1.2-8.4,2.6-12.8,3.9c1.2-4.7,3.6-9.4,6.4-12.5
|
||||
c1.1-1.1,2.6-2.4,4.3-3.2C56.9,11.6,57.3,16.5,57.2,19.9z M49.1,4c1.4,0,2.6,0.3,3.6,0.9C51.1,5.8,49.5,7,48,8.6
|
||||
c-3.8,4.1-6.7,10.5-7.9,16.6c-3.6,1.1-7.2,2.2-10.5,3.2C31.7,18.8,39.8,4.3,49.1,4z"/>
|
||||
<g>
|
||||
<path class="st1" d="M94.8,22.9c-0.5,0-9.3-0.2-9.3-0.2s-7.4-7.2-8.1-7.9c-0.3-0.3-0.6-0.4-1-0.5l0,109.7l33.1-8.2
|
||||
c0,0-13.5-91.3-13.6-92C95.8,23.3,95.3,22.9,94.8,22.9z"/>
|
||||
<path class="st2" d="M58,39.9l-3.8,14.4c0,0-4.3-2-9.4-1.6c-7.5,0.5-7.5,5.2-7.5,6.4c0.4,6.4,17.3,7.8,18.3,22.9
|
||||
c0.7,11.9-6.3,20-16.4,20.6c-12.2,0.8-18.9-6.4-18.9-6.4l2.6-11c0,0,6.7,5.1,12.1,4.7c3.5-0.2,4.8-3.1,4.7-5.1
|
||||
c-0.5-8.4-14.3-7.9-15.2-21.7c-0.7-11.6,6.9-23.4,23.7-24.4C54.7,38.2,58,39.9,58,39.9z"/>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.7 KiB |
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"mcpServers": {
|
||||
"shopify-mcp": {
|
||||
"type": "stdio",
|
||||
"command": "npx",
|
||||
"args": ["-y", "@shopify/dev-mcp@latest"]
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user