Shopify MCP Server Cci

🚀 Shopify MCP サーバー

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. まず、get-order-details ツールを使用して注文の詳細情報を取得します（例：注文番号 "#1001" を使用）
2. レスポンスから、「履行」セクションで履行IDを見つけます
3. add-tracking ツールを使用し、履行IDと追跡情報を提供します：

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

🔧 技術詳細

API バージョン管理

このサーバーは、Shopifyの LATEST_API_VERSION 定数（現在は2025-01）を使用して、最新のAPI機能との互換性を確保しています。これにより、アプリケーションは将来の変更に対して耐性を持つことができますが、ShopifyがAPIに重大な変更を加えた場合、アーキテクチャの調整が必要になることがあります。

PII 処理

すべてのShopifyストアをサポートするために、このサーバーは個人識別情報 (PII) を処理しません。すべてのユーザーインタラクションは、匿名化または脱感作されたデータを通じて行われ、ユーザーの認証情報は保存または送信されません。

📄 ライセンス

[ここにライセンス情報を挿入]

貢献者

• [ここに貢献者をリストする]

リンク

[ここにドキュメント、サンプルなどの関連リンクを追加]