mcpField
S
shopify-research

shopify-research

github.com/crawlora-orgその他141 回インストール今日更新
リポジトリ

shopify-research について

shopify-researchは、Crawloraの正規化JSON APIで公開Shopifyストアを調査するスキルです。任意のストアドメインに対応し、商品、ページ、サイトマップ、検索、推薦を調べられるほか、14ブランド向けの専用エンドポイントも備えています。

主な機能

  1. 01商品とコレクションの閲覧
  2. 02商品とページの詳細取得
  3. 03サイトマップからURLを列挙
  4. 04予測検索候補の取得
  5. 05関連商品の推薦取得
  6. 0614ブランド専用エンドポイント

活用シーン

  1. 01ストアの商品とバリエーションの監査
  2. 02全ストアの商品URLの収集
  3. 03ストアの検索候補の確認
  4. 04商品間のクロスセル推薦の分析

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/crawlora-org/crawlora-skills --skill shopify-research

インストール後、Claude Code で/shopify-researchを入力して読み込まれたか確認します。

同梱ファイルreference/endpoints.mdscripts/crawlora.sh

詳細

Shopify ストアの調査

独立系の Shopify 対応ストアフロントの商品、コレクション、ページ、サイトマップ、予測検索、商品レコメンデーションを、HTML スクレイピングなしで Crawlora API から正規化された JSON として検索・クロールできます。ドメインを指定すれば、あらゆる Shopify ストアに対応します（Shop.app は対象外です。詳しくは別の shop-app-research スキルをご覧ください）。また、独自の事前設定済みエンドポイントがあり、url が不要な14のブランドストアにも対応しています。Allbirds、Brooklinen、Cole Haan、Everlane、Fashion Nova、Gymshark、J.Crew、Kylie Cosmetics、Oh Polly、Quince、Rothy's、SKIMS、Steve Madden、The Body Shop が対象です。

ツールの範囲とデータフロー

任意で使えるシェルヘルパーは、このスキルが実行を求める唯一のコマンドです。ドキュメントに記載された許可リスト内の Crawlora ルートにのみ GET リクエストを送信します。実行時には CRAWLORA_API_KEY を読み取り、HTTPS 経由で api.crawlora.net に x-api-key ヘッダーとして送信します。Shopify ストアフロントにキーを送信することはありません。一時的に TMPDIR 内にモード600の curl 設定ファイルを作成し、コマンドの終了時に削除します。他の環境変数の確認、ファイルの列挙、ソフトウェアのインストール、昇格された権限での実行は行いません。ストアフロントの URL は通常のクエリ値として渡されます。ヘルパーの送信先ホストは固定されています。Crawlora API リクエストを行う場合にのみ実行してください。リクエストが成功するとクレジットを消費することがあります。

このスキルを使う場面

  • 「この Shopify ストアの商品／コレクションを一覧表示して。」
  • 「この Shopify ストアの /pages/about ページには何が書かれていますか？」
  • 「この Shopify ストアのサイトマップをクロールして、すべての商品 URL を取得して。」
  • 「この Shopify ストアの検索で『running shoes』と入力すると何が候補に表示されますか？」
  • 「Shopify はこの商品と一緒にどの商品をおすすめしていますか？」
  • Shopify 対応サイトのカタログ監査、競合商品の品揃え調査、またはストア全体のクロール。

セットアップ（初回のみ）

  • https://crawlora.net で無料の Crawlora API キーを取得します（月2,000クレジット、カード不要）。
  • ヘルパーを実行する前に、環境変数に CRAWLORA_API_KEY を設定します。
  • ヘルパーは環境変数から CRAWLORA_API_KEY を読み取り、https://api.crawlora.net/api/v1 にリクエストを送信します。キーがない、または無効な場合は 401 が返されます。

仕組み

各呼び出しでは、ストアフロントの url（ストアの公開ドメイン。例：https://example.myshopify.com、または https://example.com のようなカスタムドメイン）に、エンドポイント固有のパラメーターを指定します。

  1. ストアを解決する — /shopify/store は正規化されたストアフロントのメタデータを返します。バニティドメインが /products.json をブロックしている場合は、ストアの公開 *.myshopify.com ドメインにフォールバックします。
  2. カタログを閲覧する — /shopify/collections と /shopify/products（ページネーション対応、limit は最大250）でコレクションと商品を一覧表示します。/shopify/collections/{handle}/products を使うと、1つのコレクションに含まれる商品を確認できます。
  3. 詳細 — /shopify/products/{handle} で、1つの商品について完全な詳細を取得します。
  4. レコメンデーション — /shopify/products/{handle}/recommendations（intent=related|complementary）で、クロスセル／アップセル用のデータを取得します。
  5. 静的コンテンツ — /shopify/pages と /shopify/pages/{handle} で、ストアの静的ページを取得します（本文の HTML はクリーニング済みのテキストとして返されます）。
  6. サイトマップのクロール — /shopify/sitemaps で子サイトマップを一覧表示します。/shopify/sitemap/urls（type=products|collections|pages|blogs|...）で、そこから上限付きの URL エントリーを取得できます。すべての一覧エンドポイントでページネーションを行わずに、ストア全体を列挙する場合に便利です。
  7. 検索 — /shopify/search/suggest（q=、任意で types=）で、予測検索の商品、コレクション、クエリ候補を取得します。
  8. ブランド指定のストア — 同じ操作をブランドのプレフィックス付きで利用でき、url パラメーターは不要です。例：/allbirds/products、/rothys/products/{handle}、/skims/sitemap/urls。ユーザーが事前設定済みの14ブランドのいずれかを直接指定した場合は、/shopify/...?url=... の代わりにこれらを使用してください。

エンドポイント、メソッド、パラメーターの全一覧：reference/endpoints.md。

API の呼び出し

# Resolve store metadata:
scripts/crawlora.sh /shopify/store url="https://example.myshopify.com"

# List products / collections (paginated):
scripts/crawlora.sh /shopify/products url="https://example.myshopify.com" limit=100 page=1
scripts/crawlora.sh /shopify/collections url="https://example.myshopify.com"

# Crawl the sitemap for every product URL:
scripts/crawlora.sh /shopify/sitemap/urls url="https://example.myshopify.com" type=products limit=250

すべてのリクエストには scripts/crawlora.sh を使用してください。API キーがコマンドライン引数に含まれないようにできます。

エンドポイントのリファレンス

このスキルが使用する Shopify のすべてのエンドポイント（メソッド、パス、パラメーター、説明）については、reference/endpoints.md を参照してください。ブランド指定のミラー 14 件も含まれています。

使用例

  • カタログの監査： /shopify/products（page／limit でページネーション）でストアの全カタログを価格やバリエーションとともに一覧表示し、抜けや外れ値を特定します。
  • サイトマップを使った全件クロール： /shopify/sitemaps で子サイトマップを見つけてから、/shopify/sitemap/urls?type=products でページネーション付きの一覧エンドポイントをたどらずに、すべての商品 URL を列挙します。
  • 検索とレコメンデーションの調査： /shopify/search/suggest にクエリを指定して、ストアの予測検索結果を確認してから、/shopify/products/{handle}/recommendations で商品間のクロスセルリンクを把握します。

注意事項と制限

  • クレジット／成功時のみ課金： 2xx の場合のみ課金されます。無料プランでは月 2,000 クレジットを利用できます。 キーは https://crawlora.net で取得できます。
  • 公開データのみ — 公開ストアフロントのページが対象です。各ストアの利用規約を遵守してください。
  • セキュリティ： キーは CRAWLORA_API_KEY のみに保存し、ハードコード、クエリパラメーターへの指定、コミットは絶対にしないでください。
  • すべての呼び出しで url が必須です — ストアの公開ドメイン（*.myshopify.com またはカスタムドメイン）を指定してください。デフォルトのストアはありません。
  • 結果はページネーションされます — コレクション、商品、ページを順に取得するには、page（およびサポートされている場合は limit。上限は 250）を渡してください。
  • 商品、コレクション、ページの検索には数値 ID ではなく handle を指定します — まず一覧エンドポイントまたはサイトマップのクロールでハンドルを確認してください。
  • 結果が空のページはエラーではなく、空の配列を含む 200 を返します — ページネーションを終了するタイミングは配列の長さで判断してください。

コメント

Markdown 対応