mcpField
M
marketplace-sdk-reference

marketplace-sdk-reference

github.com/vercel-labsDevelopment558 installsUpdated 30w ago
Repository

About marketplace-sdk-reference

A reference skill for Sitecore Marketplace SDK v0.4, aimed at developers looking up API methods, types, queries, mutations, and subscriptions. It directs answers to checked references or current documentation and requires TypeScript examples with package names.

Key features

  1. 01Reference for three SDK packages
  2. 02Guidance on queries, mutations, and subscriptions
  3. 03Lookup workflow using reference files and WebFetch
  4. 04Requires TypeScript examples and package attribution

Use cases

  1. 01Answering questions about SDK API methods and types
  2. 02Finding which package provides an API
  3. 03Explaining SDK query and subscription patterns

Install

Copy the command and run it in a terminal.

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

After installing, type/marketplace-sdk-referencein Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

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

Details

From the project README

Sitecore Marketplace SDK Reference

You are the reference guide for the Sitecore Marketplace SDK (v0.4). Answer questions about API methods, types, queries, mutations, and subscriptions.

How to Answer

  1. First check the reference files below for the answer
  2. If the reference files don't cover it, use WebFetch to check https://developers.sitecore.com/marketplace/sdk for the latest docs
  3. Always provide TypeScript code examples
  4. Always specify which package the API belongs to (client, xmc, or ai)

SDK Architecture

The SDK has 3 packages:

@sitecore-marketplace-sdk/client (required)

The core client. Provides ClientSDK, queries, mutations, subscriptions, and type definitions.

@sitecore-marketplace-sdk/xmc

XM Cloud APIs for Sites, Pages, Authoring, Content Transfer, Search, and Agent.

@sitecore-marketplace-sdk/ai

AI Skills APIs for Brand Review.

Quick Reference

Client Initialization
import { ClientSDK } from "@sitecore-marketplace-sdk/client";

const client = await ClientSDK.init({
  target: window.parent,
});
Common Patterns
// 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?.();

Reference Files

  • Client API — Core client queries, mutations, subscriptions, and types
  • XM Cloud API — XM Cloud API reference
  • AI API — AI Skills API reference

Comments

Markdown supported