Shopify MCP Server

Shopify MCP Server

Shopify の操作を LLM エージェントと連携するための Model Context Protocol（MCP）サーバーです。このサーバーは、フルフィルメント、追跡、アーカイブ、取得など、Shopify の注文を処理するための一連のツールを提供します。

機能

• 注文のフルフィルメントをリクエストする
• 注文に追跡情報を追加する
• 注文をアーカイブする
• 特定の注文の詳細を取得する
• すべてのアクティブな注文を一覧表示する

セットアップ

前提条件

• Node.js 18 以降
• API アクセスが可能な Shopify ストア

インストール

1. リポジトリをクローンします：

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

2. 依存関係をインストールします：

   npm install
   

3. .env.example を基に .env ファイルを作成し、Shopify API の認証情報を追加します：

   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
   

ビルドと実行

1. プロジェクトをビルドします：

   npm run build
   

2. サーバーを起動します：

   npm start
   

3. 自動リビルドを有効にして開発する場合：

   npm run dev
   

LLM エージェントでの使用

このサーバーは Model Context Protocol（MCP）を実装し、以下のツールを公開します：

• get-order-details：特定の注文の詳細情報を取得します（「#1001」のようなわかりやすい注文番号に対応）
• get-active-orders：すべてのアクティブな注文の一覧を取得します
• request-fulfillment：注文をフルフィルメントします。追跡情報は任意です（わかりやすい注文番号に対応）
• add-tracking：フルフィルメント済みの注文に追跡情報を追加します
• archive-order：注文をアーカイブします（わかりやすい注文番号に対応）

わかりやすい注文番号の使用

注文 ID が必要なすべてのツールで、わかりやすい注文番号を使用できるようになりました：

• #1001 - # を先頭に付けた注文番号
• 1001 - # を先頭に付けない注文番号
• Shopify ID の完全な形式（gid://shopify/Order/12345） - 引き続き使用できます

わかりやすい注文番号を指定すると、システムが正しい Shopify ID を自動的に検索します。

追跡情報の更新

注文の追跡情報を更新するには、以下の手順に従います：

1. 注文番号（例：#1001）を指定して get-order-details を使用し、まず注文の詳細を取得します
2. 応答の「Fulfillments」セクションで、フルフィルメント ID を確認します
3. フルフィルメント ID と追跡情報を指定して add-tracking ツールを使用します：

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

技術的な詳細

API バージョン管理

このサーバーは、最新の API 機能との互換性を確保するため、Shopify の LATEST_API_VERSION 定数（現在は 2025-01）を使用します。これにより、将来にわたってアプリケーションを利用できるようになりますが、Shopify が API に破壊的変更を加えた場合、スキーマの調整が必要になることがあります。

PII の取り扱い

すべての Shopify プランのストアに対応するため、このサーバーは、上位プランでのみ利用できる個人を特定できる情報（PII）、たとえば顧客の詳細情報、メールアドレス、住所などの取得を避けています。

ライセンス

ISC