Shopify Graphql

A Model Context Protocol (MCP) server that provides comprehensive access to the Shopify Admin GraphQL API via cURL. This server exposes all major Shopify resources as MCP tools, allowing AI assistants like Claude to interact with your Shopify store programmatically.

🚧 Project Status: This project is currently in active development. New tools and features are being added regularly.

Created by: Students at Utah Valley University in Orem, UT

Prerequisites

• Node.js 18+
• npm or yarn
• A Shopify store with Admin API access
• Shopify Admin API access token

Installation

1. Clone or Create Project

git clone <repository-url>
cd shopify-graphql-mcp

2. Install Dependencies

npm install

3. Build the Server

npm run build

Configuration

Environment Variables

Create a .env file or set these environment variables:

SHOPIFY_ACCESS_TOKEN=shpat_xxxxx
SHOPIFY_STORE_URL=your-store.myshopify.com
SHOPIFY_STORE_API_URL=https://your-store.myshopify.com/admin/api/2025-01/graphql.json

Tool Categories (Recommended for IDE Compatibility)

This MCP server provides 150+ tools covering all Shopify operations. Some IDEs have limits on tool counts, so you can enable/disable tool categories via the ENABLED_TOOL_CATEGORIES environment variable:

Category	Description	~Tool Count	Modules
essential	Core e-commerce: products, orders, customers, inventory	~35	shop, products, orders, customers, inventory, collections, locations, draft-orders, discounts, fulfillments
commerce	Extended commerce: gift cards, returns, checkouts, B2B	~25	gift-cards, returns, checkouts, payment-terms, order-edits, companies, cash-tracking, fulfillment-constraints, delivery-customizations, delivery-option-generators, custom-fulfillment-services
marketing	Marketing: campaigns, markets, analytics, channels	~20	marketing-campaigns, markets, channels, discovery, price-rules, analytics, pixels, publications
content	Content: pages, themes, files, metaobjects	~25	pages, navigation, themes, files, metaobjects, translations, locales, legal-policies
advanced	Advanced: cart transforms, validations, scripts	~20	cart-transforms, validations, audit-events, custom-pixels, script-tags, customer-data-erasure, customer-merge, customer-payment-methods, privacy-settings, shipping, product-listings
reporting	Reports and feedback	~15	reports, resource-feedbacks, apps
automation	Inventory automation	~15	inventory-shipments, inventory-transfers, packing-slip-templates

Recommended configurations:

// Minimal - Essential only (~35 tools) - Best for most users
{
  "env": {
    "ENABLED_TOOL_CATEGORIES": "essential"
  }
}

// Standard - Essential + Commerce (~60 tools)
{
  "env": {
    "ENABLED_TOOL_CATEGORIES": "essential,commerce"
  }
}

// Marketing Focus - Essential + Marketing (~55 tools)
{
  "env": {
    "ENABLED_TOOL_CATEGORIES": "essential,marketing"
  }
}

// Full Power User (~105 tools)
{
  "env": {
    "ENABLED_TOOL_CATEGORIES": "essential,commerce,marketing,content"
  }
}

// Everything (~155 tools) - May overwhelm some IDEs
{
  "env": {
    "ENABLED_TOOL_CATEGORIES": "all"
  }
}

Default behavior: If ENABLED_TOOL_CATEGORIES is not set, all categories are enabled (backward compatible).

IDE Compatibility:

• Cursor: ~100-150 tools recommended
• Claude Desktop: ~200+ tools supported
• Zed: ~50-75 tools recommended

See TOOL_CATEGORIES.md for complete documentation.

Getting Your Access Token

Detailed OAuth Setup Instructions

1. Go to Settings > Apps > Develop Apps > Build apps in Dev Dashboard
2. Once in Dev Dashboard, click Create app and enter the app name (e.g., "Shopify GraphQL MCP"), then click Create
3. Use http://localhost:9292 for the App URL
4. Add the following Scopes under Scopes > Access:

read_all_orders,read_analytics,read_app_proxy,write_app_proxy,read_apps,read_assigned_fulfillment_orders,write_assigned_fulfillment_orders,read_audit_events,read_customer_events,read_cart_transforms,write_cart_transforms,read_all_cart_transforms,read_validations,write_validations,read_cash_tracking,write_cash_tracking,read_channels,write_channels,read_checkout_branding_settings,write_checkout_branding_settings,write_checkouts,read_checkouts,read_companies,write_companies,read_custom_fulfillment_services,write_custom_fulfillment_services,read_custom_pixels,write_custom_pixels,read_customers,write_customers,read_customer_data_erasure,write_customer_data_erasure,read_customer_payment_methods,read_customer_merge,write_customer_merge,read_delivery_customizations,write_delivery_customizations,read_price_rules,write_price_rules,read_discounts,write_discounts,read_discounts_allocator_functions,write_discounts_allocator_functions,read_discovery,write_discovery,write_draft_orders,read_draft_orders,read_files,write_files,read_fulfillment_constraint_rules,write_fulfillment_constraint_rules,read_fulfillments,write_fulfillments,read_gift_card_transactions,write_gift_card_transactions,read_gift_cards,write_gift_cards,write_inventory,read_inventory,write_inventory_shipments,read_inventory_shipments,write_inventory_shipments_received_items,read_inventory_shipments_received_items,write_inventory_transfers,read_inventory_transfers,read_legal_policies,write_legal_policies,read_delivery_option_generators,write_delivery_option_generators,read_locales,write_locales,write_locations,read_locations,read_marketing_integrated_campaigns,write_marketing_integrated_campaigns,write_marketing_events,read_marketing_events,read_markets,write_markets,read_markets_home,write_markets_home,read_merchant_managed_fulfillment_orders,write_merchant_managed_fulfillment_orders,read_metaobject_definitions,write_metaobject_definitions,read_metaobjects,write_metaobjects,read_online_store_navigation,write_online_store_navigation,read_online_store_pages,write_online_store_pages,write_order_edits,read_order_edits,read_orders,write_orders,write_packing_slip_templates,read_packing_slip_templates,write_payment_mandate,read_payment_mandate,read_payment_terms,write_payment_terms,read_payment_customizations,write_payment_customizations,read_pixels,write_pixels,read_privacy_settings,write_privacy_settings,read_product_feeds,write_product_feeds,read_product_listings,write_product_listings,read_products,write_products,read_publications,write_publications,read_purchase_options,write_purchase_options,write_reports,read_reports,read_resource_feedbacks,write_resource_feedbacks,read_returns,write_returns,read_script_tags,write_script_tags,read_shopify_payments_provider_accounts_sensitive,read_shipping,write_shipping,read_shopify_payments_accounts,read_shopify_payments_payouts,read_shopify_payments_bank_accounts,read_shopify_payments_disputes,write_shopify_payments_disputes,read_content,write_content,read_store_credit_account_transactions,write_store_credit_account_transactions,read_store_credit_accounts,write_own_subscription_contracts,read_own_subscription_contracts,write_theme_code,read_themes,write_themes,read_third_party_fulfillment_orders,write_third_party_fulfillment_orders,read_translations,write_translations,customer_read_companies,customer_write_companies,customer_write_customers,customer_read_customers,customer_read_draft_orders,customer_read_markets,customer_read_metaobjects,customer_read_orders,customer_write_orders,customer_read_quick_sale,customer_write_quick_sale,customer_read_store_credit_account_transactions,customer_read_store_credit_accounts,customer_write_own_subscription_contracts,customer_read_own_subscription_contracts,unauthenticated_write_bulk_operations,unauthenticated_read_bulk_operations,unauthenticated_read_bundles,unauthenticated_write_checkouts,unauthenticated_read_checkouts,unauthenticated_write_customers,unauthenticated_read_customers,unauthenticated_read_customer_tags,unauthenticated_read_metaobjects,unauthenticated_read_product_pickup_locations,unauthenticated_read_product_inventory,unauthenticated_read_product_listings,unauthenticated_read_product_tags,unauthenticated_read_selling_plans,unauthenticated_read_shop_pay_installments_pricing,unauthenticated_read_content

5. Use http://localhost:9292/auth/callback for the Redirect URL
6. Click Release
7. Once released, navigate to Settings for the app
8. Using the Client ID and Secret credentials provided, open this URL in your browser:

https://admin.shopify.com/store/<STORE_ID>/oauth/authorize?client_id=<CLIENT_ID>&scope=<SCOPE>&redirect_uri=http%3A%2F%2Flocalhost:9292%2Fauth%2Fcallback&state=nonce-12345

This will return a URL like:

http://localhost:9292/auth/callback?code=<CODE>&hmac=<HMAC>&host=<HOST>&shop=<STORE_ID>.myshopify.com&state=nonce-12345&timestamp=<TIMESTAMP>

9. Copy the <CODE> value from the returned URL, then run this command in your terminal:

curl -X POST "https://<STORE_ID>.myshopify.com/admin/oauth/access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "<CLIENT_ID>",
    "client_secret": "<SECRET>",
    "code": "<CODE>"
  }'

This will return the Shopify Access Token you will use in your MCP configuration file (e.g., mcp.json).

Quick Setup (Existing App)

If you already have an app with the required scopes:

1. Log in to your Shopify Admin
2. Go to Settings > Apps and sales channels > Develop apps
3. Create a new app or use an existing one
4. Click Configure Admin API scopes
5. Select the required scopes (see Required Scopes section below)
6. Install the app to your store
7. Copy the Admin API access token

MCP Client Configuration

Add this server to your MCP client configuration (e.g., Claude Desktop, Cursor):

macOS/Linux (Recommended - Essential Tools Only):

{
  "mcpServers": {
    "shopify-graphql": {
      "command": "node",
      "args": ["/ABSOLUTE/PATH/TO/shopify-graphql-mcp/dist/index.js"],
      "env": {
        "SHOPIFY_ACCESS_TOKEN": "shpat_xxxxx",
        "SHOPIFY_STORE_URL": "your-store.myshopify.com",
        "SHOPIFY_STORE_API_URL": "https://your-store.myshopify.com/admin/api/2025-01/graphql.json",
        "ENABLED_TOOL_CATEGORIES": "essential"
      }
    }
  }
}

Windows:

{
  "mcpServers": {
    "shopify-graphql": {
      "command": "node",
      "args": ["C:\\PATH\\TO\\shopify-graphql-mcp\\dist\\index.js"],
      "env": {
        "SHOPIFY_ACCESS_TOKEN": "shpat_xxxxx",
        "SHOPIFY_STORE_URL": "your-store.myshopify.com",
        "SHOPIFY_STORE_API_URL": "https://your-store.myshopify.com/admin/api/2025-01/graphql.json",
        "ENABLED_TOOL_CATEGORIES": "essential"
      }
    }
  }
}

Available Tools

This MCP server provides 150+ tools organized into 7 categories. For a complete list of all available tools, see the TOOL_CATEGORIES.md file.

Tool Categories

Category	Description	~Tool Count
Essential	Core e-commerce: products, orders, customers, inventory	~35
Commerce	Extended commerce: gift cards, returns, checkouts, B2B	~25
Marketing	Marketing: campaigns, markets, analytics, channels	~20
Content	Content: pages, themes, files, metaobjects	~25
Advanced	Advanced: cart transforms, validations, scripts	~20
Reporting	Reports and feedback	~15
Automation	Inventory automation	~15

See TOOL_CATEGORIES.md for the complete tool reference.

Usage Examples

Get Orders

"Get the last 10 orders from my store"

Create Product

"Create a new product called 'Summer T-Shirt' with a $29.99 price"

Update Inventory

"Set the inventory for variant ID gid://shopify/ProductVariant/123 to 100 at location ID gid://shopify/Location/456"

Get Analytics

"Show me my store's total sales for last month using ShopifyQL"

Marketing Campaign

"Create a marketing event for our summer sale starting next week"

Content Management

"Create a new page called 'About Us' with our company story"

Development

Project Structure

shopify-graphql-mcp/
├── src/
│   ├── index.ts              # Server entry point
│   ├── tools/                # Tool implementations organized by category
│   │   ├── index.ts         # Tool registration and category management
│   │   ├── orders.ts
│   │   ├── products.ts
│   │   ├── customers.ts
│   │   └── ... (50+ tool modules)
│   ├── config/
│   │   └── tool-categories.ts  # Category configuration
│   ├── utils/
│   │   ├── graphql-client.ts
│   │   └── scope-mapper.ts
│   └── types/
│       └── index.ts
├── dist/                     # Compiled output
├── package.json
├── tsconfig.json
├── TOOL_CATEGORIES.md       # Detailed category documentation
└── README.md

Adding New Tools

1. Define the tool in the appropriate category file in src/tools/
2. Use the server.registerTool() pattern
3. Include Zod schema validation for inputs
4. Handle errors gracefully
5. Add the tool to the category configuration in src/config/tool-categories.ts

Example:

server.registerTool(
  "my_new_tool",
  {
    description: "Description of what this tool does",
    inputSchema: {
      param1: z.string().describe("Parameter description"),
    },
  },
  async ({ param1 }) => {
    // Implementation
  }
);

Building

npm run build

Type Checking

npm run typecheck

Troubleshooting

Environment Variables Not Found

Make sure all three environment variables are set:

• SHOPIFY_ACCESS_TOKEN
• SHOPIFY_STORE_URL
• SHOPIFY_STORE_API_URL

Tool Categories Not Working

Check the health_check tool output to see which categories are enabled:

"Run health check to see my server status"

GraphQL Errors

Check that your access token has the required scopes for the operations you're trying to perform.

cURL Not Found

Ensure cURL is installed on your system:

# macOS
brew install curl

# Ubuntu/Debian
sudo apt-get install curl

# Windows
curl is included in Windows 10+

Permission Denied (macOS/Linux)

Make sure the compiled file is executable:

chmod +x dist/index.js

Security Notes

• Never commit your SHOPIFY_ACCESS_TOKEN to version control
• Use environment variables or a secure secrets manager
• The access token provides full API access to your store - keep it secure
• Consider using separate tokens for different environments (development, staging, production)

Required Shopify Admin API Scopes

Based on the tools you enable, the following scopes may be required:

Essential Category

• read_orders, write_orders
• read_products, write_products
• read_customers, write_customers
• read_inventory, write_inventory
• read_draft_orders, write_draft_orders
• read_discounts, write_discounts
• read_locations, write_locations
• read_fulfillments, write_fulfillments

Commerce Category

• read_gift_cards, write_gift_cards
• read_returns, write_returns
• read_checkouts, write_checkouts
• read_payment_terms, write_payment_terms
• read_order_edits, write_order_edits
• read_companies, write_companies
• read_cash_tracking, write_cash_tracking

Marketing Category

• read_marketing_events, write_marketing_events
• read_markets, write_markets
• read_channels, write_channels
• read_price_rules, write_price_rules
• read_analytics
• read_pixels, write_pixels
• read_publications, write_publications

Content Category

• read_metaobject_definitions, write_metaobject_definitions
• read_metaobjects, write_metaobjects
• read_themes, write_themes
• read_files, write_files
• read_pages, write_pages
• read_translations, write_translations

Advanced Category

• read_cart_transforms, write_cart_transforms
• read_validations, write_validations
• read_audit_events
• read_customer_events
• read_privacy_settings, write_privacy_settings

Reporting Category

• read_reports, write_reports
• read_apps, write_apps

Automation Category

• read_inventory_shipments, write_inventory_shipments
• read_inventory_transfers, write_inventory_transfers

License

MIT

Contributing

Contributions are welcome! Please ensure:

• TypeScript strict mode compliance
• Zod schema validation for all tool inputs
• Error handling for all GraphQL operations
• Updated documentation for new tools
• Proper categorization in TOOL_CATEGORIES.md

Support

For issues or questions:

1. Check the troubleshooting section
2. Verify your Shopify API credentials
3. Ensure your access token has the required scopes
4. Review the Shopify Admin GraphQL API documentation
5. Check TOOL_CATEGORIES.md for tool category configuration help