Shopify MCP Server Main

🚀 Shopify MCP サーバー

このドキュメントでは、Shopify の MCP（モデルコンテキストプロトコル）サーバーの使用方法と開発方法について詳しく説明します。MCP は、異なるサービスやシステムを接続するためのプロトコルで、Shopify ストアとのやり取りを簡単に行うことができます。

🚀 クイックスタート

Shopify アプリの作成

1. Shopify Partners サイトにログインし、開発者アカウントを登録します。
2. コンソールで新しいアプリを作成し、必要なアプリ情報（名前、説明など）を入力します。
3. アプリのコールバック URL と権限範囲を設定します。

MCP サーバーコードのクローン

Git コマンドを使用してこのリポジトリをクローンします。

git clone https://github.com/your-username/shopify-mcp-server.git

依存関係のインストール

プロジェクトディレクトリに移動した後、必要な依存パッケージをインストールします。

npm install

環境変数の設定

.env ファイルを作成し、以下の内容を追加します。

SHOPIFY_API_KEY=your_api_key
SHOPIFY_API_SECRET=your_api_secret
PORT=3000

サーバーの起動

以下のコマンドを実行して MCP サーバーを起動します。

node index.js

デフォルトでは、サーバーは http://localhost:3000 で実行されます。

✨ 主な機能

核心機能

• 商品管理：商品データの読み取りと書き込みをサポートします。
• 顧客管理：顧客のプロファイル情報を操作できます。
• 注文処理：注文の CRUD（作成、読み取り、更新、削除）操作を提供します。
• お気に入り管理：顧客がお気に入りに登録した商品を管理します。
• webhook 統合：Shopify の webhook イベントの購読または購読解除ができます。

ツールリスト

以下は、サーバーが提供する主要な機能モジュールとその詳細説明です。

1. 商品取得 (get-products)：

   • 入力パラメータ：searchTitle（検索する商品タイトル）、limit（返される商品数の制限）。
   • 出力結果：商品 ID、タイトル、説明、価格などの情報を含みます。

2. 商品作成 (create-product)：

   • 入力パラメータには、title（商品タイトル）、description（商品説明）、price（商品価格）などが含まれます。
   • 新しく作成された商品 ID を返します。

3. 商品更新 (update-product)：

   • 商品 ID と変更するフィールド（newTitle や newDescription など）を提供する必要があります。

4. 商品削除 (delete-product)：

   • 入力パラメータ：productId（削除する商品の一意の識別子）。
   • 削除が成功したことを示す確認メッセージを返します。

5. 顧客取得 (get-customers)：

   • email で顧客データをフィルタリングすることができ、デフォルトではすべての顧客の基本情報を返します。

6. 顧客作成 (create-customer)：

   • 入力パラメータには、email、firstName、lastName などが含まれます。
   • 新しい顧客の一意の識別子を返します。

7. 顧客更新 (update-customer)：

   • 顧客 ID と変更するフィールド（newEmail や newFirstName など）を提供する必要があります。

8. 顧客削除 (delete-customer)：

   • 入力パラメータ：customerId（削除する顧客の一意の識別子）。
   • 削除が成功したことを示す確認メッセージを返します。

9. 注文取得 (get-orders)：

   • 時間範囲やその他のフィルタ条件で注文データを絞り込むことができます。

10. 注文作成 (create-order)：

    • 顧客 ID と商品情報などのパラメータを提供する必要があります。
    • 新しく生成された注文番号を返します。

11. 注文更新 (update-order)：

    • 入力パラメータには、orderId（変更する注文の一意の識別子）、newStatus（新しい注文ステータス）などが含まれます。

12. 注文削除 (delete-order)：

    • 入力パラメータ：orderId。
    • 削除が成功したことを示す確認メッセージを返します。

13. お気に入り取得 (get-collections)：

    • 名前やその他のフィルタ条件でお気に入りデータを絞り込むことができます。

14. お気に入り作成 (create-collection)：

    • お気に入りの名前とその他の関連情報を提供する必要があります。
    • 新しく作成されたお気に入り ID を返します。

15. お気に入り更新 (update-collection)：

    • 入力パラメータには、collectionId（変更するお気に入りの一意の識別子）、newName（新しいお気に入り名）などが含まれます。

16. お気に入り削除 (delete-collection)：

    • 入力パラメータ：collectionId。
    • 削除が成功したことを示す確認メッセージを返します。

17. webhook 購読 (subscribe-webhook)：

    • ターゲット URL と購読するイベントタイプ（注文作成、商品更新など）を提供する必要があります。
    • 購読が成功したことを示す確認メッセージを返します。

18. webhook 購読解除 (unsubscribe-webhook)：

    • 入力パラメータには、subscriptionId（解除する購読の一意の識別子）が含まれます。
    • 解除が成功したことを示す確認メッセージを返します。

💻 使用例

基本的な使用法

const request = require('request');

// 商品リストを取得
request.get('http://localhost:3000/api/products', { json: true }, (err, res, body) => {
  if (!err && res.statusCode === 200) {
    console.log(body.data);
  }
});

// 新しい顧客を作成
const options = {
  method: 'POST',
  url: 'http://localhost:3000/api/customers',
  json: {
    email: 'test@example.com',
    firstName: 'John',
    lastName: 'Doe'
  }
};

request(options, (error, response, body) => {
  if (!error && response.statusCode === 201) {
    console.log('Customer created successfully!');
  }
});

高度な使用法

カスタムイベント処理

サーバーのコアモジュールを拡張することで、カスタムのビジネスロジックを追加することができます。例えば：

• 注文が作成された後、自動的にメールで顧客に通知する。
• 商品在庫が不足した場合にアラートメカニズムをトリガーする。

バッチ操作

効率を上げるために、サーバーはバッチ操作機能をサポートしています。

// 商品を一括取得
server.post('/api/products/batch', (req, res) => {
  const { products } = req.body;
  // 処理ロジック
});

// 顧客を一括削除
server.delete('/api/customers/batch', (req, res) => {
  const { customerIds } = req.body;
  // 処理ロジック
});

🔧 技術詳細

データベースの選択

サーバーはデフォルトで MongoDB を使用していますが、設定により他のストレージシステムもサポートしています。

セキュリティメカニズム

• 認証：すべての API エンドポイントには有効な認証トークンを提供する必要があります。
• レート制限：乱用を防止するため、サーバーにはレート制限機能が組み込まれています。
• リクエスト暗号化：機密操作は HTTPS を通じて暗号化された通信が必要です。

イベント駆動アーキテクチャ

Node.js の非同期イベント処理モデルに基づいて、サーバーは大量の同時リクエストを効率的に処理することができます。

🤝 貢献ガイド

このプロジェクトに興味がある場合は、開発チームに参加することを歓迎します。以下の手順でコードを貢献することができます。

1. このリポジトリを Fork します。
2. 新しいブランチを作成して変更を加えます。
3. 変更をコミットしてプッシュします。
4. メインリポジトリに Pull Request を送信します。 コミットがコード規約に従っていることを確認し、詳細なドキュメントを提供してください。

📄 ライセンス

このプロジェクトは MIT ライセンスの下で提供されています。詳細な条項は LICENSE ファイルを参照してください。