mcpField
M
marketplace-sdk-reference

marketplace-sdk-reference

github.com/vercel-labs開発558 回インストール30 週間前に更新
リポジトリ

marketplace-sdk-reference について

Sitecore Marketplace SDK v0.4 の API メソッド、型、クエリ、ミューテーション、サブスクリプションを調べる開発者向けリファレンススキルです。まず参照ファイルを確認し、必要に応じて最新ドキュメントを調べ、パッケージ名付きの TypeScript 例を示します。

主な機能

  1. 013つの SDK パッケージのリファレンス
  2. 02クエリ、ミューテーション、購読の説明
  3. 03参照ファイルと WebFetch による調査
  4. 04TypeScript 例とパッケージ名の提示

活用シーン

  1. 01SDK の API メソッドや型に関する質問への回答
  2. 02API が属するパッケージの特定
  3. 03SDK のクエリや購読パターンの説明

インストール

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

$npx skills add https://github.com/vercel-labs/sitecore-skills --skill marketplace-sdk-reference

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

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
ai-api.md
client-api.md
xmc-api.md

詳細

Sitecore Marketplace SDK リファレンス

Sitecore Marketplace SDK（v0.4）のリファレンスガイドです。API メソッド、型、クエリ、ミューテーション、サブスクリプションに関する質問に回答します。

回答方法

  1. まず、以下のリファレンスファイルで回答を確認します
  2. リファレンスファイルに記載がない場合は、WebFetch を使用して https://developers.sitecore.com/marketplace/sdk で最新のドキュメントを確認します
  3. 常に TypeScript のコード例を提示します
  4. API がどのパッケージ（client、xmc、または ai）に属するかを必ず明記します

SDK アーキテクチャ

SDK は 3 つのパッケージで構成されています。

@sitecore-marketplace-sdk/client（必須）

コアクライアントです。ClientSDK、クエリ、ミューテーション、サブスクリプション、型定義を提供します。

  • 完全な API リファレンスについては、client-api.md を参照してください
@sitecore-marketplace-sdk/xmc

Sites、Pages、Authoring、Content Transfer、Search、Agent 向けの XM Cloud API です。

  • 完全な API リファレンスについては、xmc-api.md を参照してください
@sitecore-marketplace-sdk/ai

Brand Review 向けの AI Skills API です。

  • 完全な API リファレンスについては、ai-api.md を参照してください

クイックリファレンス

クライアントの初期化
import { ClientSDK } from "@sitecore-marketplace-sdk/client";

const client = await ClientSDK.init({
  target: window.parent,
});
よく使われるパターン
// Query — returns { data, unsubscribe? }
const { data } = await client.query("queryName", params);

// Mutation
const { data } = await client.mutate("mutationName", params);

// Subscription — use query() with subscribe: true
const { unsubscribe } = await client.query("queryName", {
  subscribe: true,
  onSuccess: (data) => console.log(data),
});
unsubscribe?.();

リファレンスファイル

  • Client API — コアクライアントのクエリ、ミューテーション、サブスクリプション、型
  • XM Cloud API — XM Cloud API リファレンス
  • AI API — AI Skills API リファレンス

コメント

Markdown 対応