shopify mcp server main

MCP Server for Shopify API, enabling interaction with store data through GraphQL API. This server provides tools for managing products, customers, orders, and more.

Features

• Product Management: Search and retrieve product information
• Customer Management: Load customer data and manage customer tags
• Order Management: Advanced order querying and filtering
• GraphQL Integration: Direct integration with Shopify's GraphQL Admin API
• Comprehensive Error Handling: Clear error messages for API and authentication issues

Tools

1. get-products
2. Get all products or search by title
3. Inputs:
   • searchTitle (optional string): Filter products by title
   • limit (number): Maximum number of products to return

4. Returns: Formatted product details including title, description, handle, and variants

5. get-products-by-collection

6. Get products from a specific collection
7. Inputs:
   • collectionId (string): ID of the collection to get products from
   • limit (optional number, default: 10): Maximum number of products to return

8. Returns: Formatted product details from the specified collection

9. get-products-by-ids

10. Get products by their IDs
11. Inputs:
    • productIds (array of strings): Array of product IDs to retrieve

12. Returns: Formatted product details for the specified products

13. update-product-price

14. Update product prices for its ID
15. Inputs:
    • productId (string): ID of the product to update
    • price (string): New price for the product

16. Returns: Response of the update

17. get-variants-by-ids

18. Get product variants by their IDs
19. Inputs:
    • variantIds (array of strings): Array of variant IDs to retrieve

20. Returns: Detailed variant information including product details

21. get-customers

22. Get shopify customers with pagination support
23. Inputs:
    • limit (optional number): Maximum number of customers to return
    • next (optional string): Next page cursor

24. Returns: Customer data in JSON format

25. tag-customer

26. Add tags to a customer
27. Inputs:
    • customerId (string): Customer ID to tag
    • tags (array of strings): Tags to add to the customer

28. Returns: Success or failure message

29. get-orders

30. Get orders with advanced filtering and sorting
31. Inputs:
    • first (optional number): Limit of orders to return
    • after (optional string): Next page cursor
    • query (optional string): Filter orders using query syntax
    • sortKey (optional enum): Field to sort by ('PROCESSED_AT', 'TOTAL_PRICE', 'ID', 'CREATED_AT', 'UPDATED_AT', 'ORDER_NUMBER')
    • reverse (optional boolean): Reverse sort order

32. Returns: Formatted order details

33. get-order

34. Get a single order by ID
35. Inputs:
    • orderId (string): ID of the order to retrieve

36. Returns: Detailed order information

37. create-discount

38. Create a basic discount code
39. Inputs:
    • title (string): Title of the discount
    • code (string): Discount code that customers will enter
    • valueType (enum): Type of discount ('percentage' or 'fixed_amount')
    • value (number): Discount value (percentage as decimal or fixed amount)
    • startsAt (string): Start date in ISO format
    • endsAt (optional string): Optional end date in ISO format
    • appliesOncePerCustomer (boolean): Whether discount can be used only once per customer

40. Returns: Created discount details

41. create-draft-order

    • Create a draft order
    • Inputs:
    • lineItems (array): Array of items with variantId and quantity
    • email (string): Customer email
    • shippingAddress (object): Shipping address details
    • note (optional string): Optional note for the order
    • Returns: Created draft order details

42. complete-draft-order

    • Complete a draft order
    • Inputs:
    • draftOrderId (string): ID of the draft order to complete
    • variantId (string): ID of the variant in the draft order
    • Returns: Completed order details

43. get-collections

    • Get all collections
    • Inputs:
    • limit (optional number, default: 10): Maximum number of collections to return
    • name (optional string): Filter collections by name
    • Returns: Collection details

44. get-shop

    • Get shop details
    • Inputs: None
    • Returns: Basic shop information

45. get-shop-details

    • Get extended shop details including shipping countries
    • Inputs: None
    • Returns: Extended shop information including shipping countries

46. manage-webhook

    • Subscribe, find, or unsubscribe webhooks
    • Inputs:
    • action (enum): Action to perform ('subscribe', 'find', 'unsubscribe')
    • callbackUrl (string): Webhook callback URL
    • topic (enum): Webhook topic to subscribe to
    • webhookId (optional string): Webhook ID (required for unsubscribe)
    • Returns: Webhook details or success message

Setup

Shopify Access Token

To use this MCP server, you'll need to create a custom app in your Shopify store:

1. From your Shopify admin, go to Settings > Apps and sales channels
2. Click Develop apps (you may need to enable developer preview first)
3. Click Create an app
4. Set a name for your app (e.g., "Shopify MCP Server")
5. Click Configure Admin API scopes
6. Select the following scopes:
7. read_products, write_products
8. read_customers, write_customers
9. read_orders, write_orders
10. Click Save
11. Click Install app
12. Click Install to give the app access to your store data
13. After installation, you'll see your Admin API access token
14. Copy this token - you'll need it for configuration

Note: Store your access token securely. It provides access to your store data and should never be shared or committed to version control. More details on how to create a Shopify app can be found here.

Usage with Claude Desktop

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "shopify": {
      "command": "npx",
      "args": ["-y", "shopify-mcp-server"],
      "env": {
        "SHOPIFY_ACCESS_TOKEN": "<YOUR_ACCESS_TOKEN>",
        "MYSHOPIFY_DOMAIN": "<YOUR_SHOP>.myshopify.com"
      }
    }
  }
}

Development

1. Clone the repository
2. Install dependencies:

   npm install

3. Create a .env file:

   SHOPIFY_ACCESS_TOKEN=your_access_token
   MYSHOPIFY_DOMAIN=your-store.myshopify.com

4. Build the project:

   npm run build

5. Run tests:

   npm test

Dependencies

• @modelcontextprotocol/sdk - MCP protocol implementation
• graphql-request - GraphQL client for Shopify API
• zod - Runtime type validation

Contributing

Contributions are welcome! Please read our Contributing Guidelines first.

License

MIT

Community

• MCP GitHub Discussions
• Report Issues

Built with ❤️ using the Model Context Protocol