关于 marketplace-sdk-reference
面向开发者的 Sitecore Marketplace SDK v0.4 参考技能，涵盖 API 方法、类型、查询、变更和订阅。它要求先查阅参考文件，必要时查看最新文档，并在回答中提供 TypeScript 示例及所属包名。
主要功能
- 01涵盖三个 SDK 包的参考
- 02查询、变更与订阅说明
- 03通过参考文件和 WebFetch 查找
- 04要求提供 TypeScript 示例及包名
适用场景
- 01解答 SDK API 方法和类型问题
- 02确认 API 所属的包
- 03说明 SDK 查询与订阅模式
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/marketplace-sdk-reference确认已加载。
包含的文件
除 SKILL.md 外，安装时一起下载的参考资料和脚本。
references/ai-api.mdclient-api.mdxmc-api.md详细介绍
Sitecore Marketplace SDK 参考指南
本指南是 Sitecore Marketplace SDK（v0.4）的参考指南。可解答有关 API 方法、类型、查询、突变和订阅的问题。
如何回答
- 首先查阅下方的参考文件
- 如果参考文件未涵盖相关内容，请使用 WebFetch 查看 https://developers.sitecore.com/marketplace/sdk 上的最新文档
- 始终提供 TypeScript 代码示例
- 始终注明 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?.();
参考文件
- 客户端 API — 核心客户端的查询、突变、订阅和类型
- XM Cloud API — XM Cloud API 参考
- AI API — AI Skills API 参考
评论
支持 Markdown