Shopify MCP Server Cci

🚀 Shopify MCP Server

A Model Context Protocol (MCP) server for integrating Shopify operations with LLM agents. This server provides a set of tools for handling Shopify orders, including order fulfillment, adding tracking information, archiving, and retrieving orders.

🚀 Quick Start

The Shopify MCP Server is designed to seamlessly integrate Shopify operations with LLM agents. It offers a comprehensive set of tools to manage Shopify orders efficiently.

✨ Features

• Request order fulfillment.
• Add order tracking information.
• Archive orders.
• Get detailed information for a specific order.
• List all active orders.

📦 Installation

Prerequisites

• Node.js 18 or higher.
• A Shopify store with API access.

Installation Steps

1. Clone the repository:

   git clone https://github.com/yourusername/shopify-mcp-server.git
   cd shopify-mcp-server
   

2. Install dependencies:

   npm install
   

3. Create a .env file based on .env.example and add your Shopify API credentials:

   SHOPIFY_API_KEY=your_api_key
   SHOPIFY_API_SECRET=your_api_secret
   SHOPIFY_SCOPES=write_orders,read_orders
   SHOPIFY_SHOP=your-shop.myshopify.com
   SHOPIFY_ACCESS_TOKEN=your_access_token
   

Building and Running

1. Build the project:

   npm run build
   

2. Start the server:

   npm start
   

3. Develop with auto-rebuild:

   npm run dev
   

💻 Usage Examples

Basic Usage

This server implements the Model Context Protocol (MCP) and exposes the following tools:

• get-order-details: Get detailed information for a specific order (accepts order numbers in friendly number format, e.g., "#1001").
• get-active-orders: Get a list of all active orders.
• request-fulfillment: Request order fulfillment, optionally add tracking information (accepts friendly order numbers).
• add-tracking: Add tracking information to a fulfilled order.
• archive-order: Archive an order (accepts friendly order numbers).

Advanced Usage

Using Friendly Order Numbers

All tools that require an order ID now support friendly order numbers:

• #1001 - Order number with a hash prefix.
• 1001 - Order number without a hash prefix.
• Full Shopify ID (e.g., gid://shopify/Order/12345) - Still supported. The system will automatically find the correct Shopify ID when you provide a friendly format order number.

Updating Tracking Information

To update the tracking information for an order, follow these steps:

1. First, use the get-order-details tool to get the order details (e.g., using order number "#1001").
2. From the response, find the fulfillment ID in the "fulfillment" section.
3. Use the add-tracking tool and provide the fulfillment ID and tracking information:

   {
     "fulfillmentId": "gid://shopify/Fulfillment/123456789",
     "trackingNumber": "1Z999AA10123456789",
     "trackingCompany": "UPS",
     "trackingUrl": "https://www.ups.com/track?tracknum=1Z999AA10123456789",
     "notifyCustomer": true
   }
   

🔧 Technical Details

API Version Management

This server uses Shopify's LATEST_API_VERSION constant (currently 2025 - 01) to ensure compatibility with the latest API features. This protects the application against future changes, but may occasionally require architectural adjustments when Shopify makes significant changes to its API.

PII Handling

To support all Shopify stores, this server avoids handling any personally identifiable information (PII). All user interactions are conducted through anonymized or脱敏 data, and no user credentials are stored or passed.

📄 License

[Insert license information here]

Contributors

• [List contributors here]

Links

[Add relevant links here, such as documentation, examples, etc.]