mcpField
B
b2c-scapi-schemas

b2c-scapi-schemas

github.com/salesforcecommercecloud开发57106 次安装今天更新
代码仓库

关于 b2c-scapi-schemas

b2c-scapi-schemas 是一项用于浏览 Salesforce B2C Commerce SCAPI 标准及租户专属 OpenAPI 契约的技能。它帮助开发者通过 MCP 工具或 b2c 命令行发现操作和字段，包括自定义 API 与属性。

主要功能

  1. 01搜索 Admin 和 Shopper 契约
  2. 02列出租户实时架构与自定义 API
  3. 03查看操作输入和字段
  4. 04展开自定义属性定义
  5. 05检查自定义 API 注册状态

适用场景

  1. 01查找 SCAPI 方法和路径
  2. 02检查租户专属契约字段
  3. 03查看自定义 API 注册状态
  4. 04准备 Admin 或 Shopper API 调用

MCP 相关

有可用的 B2C MCP 时，该技能使用 scapi_search 发现 Admin 和 Shopper 契约，并通过 scapi_schemas_list 查询实时架构和自定义 API。访问租户专属实时架构需要 sfcc.scapi-schemas；scapi_execute 支持调用符合条件的 Admin 和访客 Shopper API。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/salesforcecommercecloud/b2c-developer-tooling --skill b2c-scapi-schemas

安装后在 Claude Code 中输入/b2c-scapi-schemas确认已加载。

附带文件evals/trigger-evals.jsonreferences/CLI-EXAMPLES.md

详细介绍

B2C SCAPI 架构技能

浏览标准或租户专属的 SCAPI OpenAPI 契约。

工具选择

如果可以使用 B2C MCP，Admin 和 Shopper 契约优先使用 scapi_search。 首先通过资源或 skills_read 读取 skill://mcp/b2c-mcp-scapi/SKILL.md；传入 skillRead: true。先查找方法、路径和 operationId，再查找选定的输入和 字段。默认情况下，搜索离线打包的标准契约；schemas: "live" 则搜索租户的契约（自定义属性、自定义 API、较新的 API），并使其可供 scapi_execute 调用。

对于在线架构、自定义属性和自定义 API，请使用 scapi_schemas_list。 查询租户字段时，提供 API 系列、名称和版本，并设置 includeSchemas: true。 默认会展开自定义属性；expandAll: true 可保留完整定义。 对于大型架构，请按照 MCP SCAPI 技能中的说明，通过代码模式获取和筛选。 使用 scapi_custom_apis_get_status 查询注册状态。访问在线架构需要 sfcc.scapi-schemas。执行操作时优先使用专用任务工具；否则， scapi_execute 支持使用已配置的身份验证和作用域进行 Admin 和访客 Shopper JSON 调用。对于自定义 Admin 端点，每个程序在调用前都要通过 scapi.request 获取在线契约；请遵循 MCP SCAPI 技能。不支持已注册 Shopper 和二进制执行。请使用文档工具查询语义 和限制，避免重复发现契约。

对于 CLI 操作，请使用 b2c scapi schemas list 和 b2c scapi schemas get <family> <name> <version>；两者都使用在线访问，失败时会回退到 打包的标准契约（并在 --json 中显示警告和 source: "bundled"）。 Schemas API 仅在请求时返回操作摘要、描述和示例： --expand-paths/--expand-schemas 获取文本内容，--expand-all 获取所有内容，而 --include summaries,descriptions,... 可直接选择内容部分。 CLI get 默认展开自定义属性；--no-expand-custom-properties 则请求标准契约。MCP 也默认展开；设置 expandCustomProperties: false 可禁用。 已知的自定义字段可通过标准 Admin 代码模式请求发送，无需读取架构或离线刷新。 config_inspect 是与 MCP 等效的脱敏版 b2c setup inspect。 筛选、选择性展开、自定义属性和文件输出示例请参阅 CLI 示例。CLI 没有对应的代码模式功能。

提示： 如果未全局安装 b2c，请改用 npx @salesforce/b2c-cli（例如，npx @salesforce/b2c-cli scapi schemas list）。

配置

tenantId、shortCode、clientId 和 clientSecret 等值会从 dw.json、SFCC_* 环境变量、当前实例或配置插件解析。以下示例展示了最精简的用法；仅在需要覆盖已配置的值时才添加标志——通常无需传入 --client-id/--client-secret/--tenant-id/--short-code。如果缺少必需值，CLI 会输出明确的错误，指出对应的标志、环境变量和配置键。

运行 b2c setup inspect 可查看解析后的配置，以及每个值的来源（可使用 --json 进行脚本处理；默认情况下，密钥会保持脱敏）。有关优先级规则和故障排除，请参阅 b2c-cli:b2c-config 技能。

租户 ID 与组织 ID

租户 ID 用于标识进行 SCAPI 调用的 B2C Commerce 实例。它不同于组织 ID：

  • 租户 ID：zzxy_prd（dw.json 中的 tenantId 值，或通过 --tenant-id 覆盖）
  • 组织 ID：f_ecom_zzxy_prd（用于 SCAPI URL，带有 f_ecom_ 前缀）
根据主机名推导租户 ID

对于沙盒实例，将主机名中的连字符替换为下划线，以此推导租户 ID：

主机名租户 ID
zzpq-013.dx.commercecloud.salesforce.comzzpq_013
zzxy-001.dx.commercecloud.salesforce.comzzxy_001
abcd-dev.dx.commercecloud.salesforce.comabcd_dev

对于生产实例，请使用你的 realm 和实例标识符（例如，zzxy_prd）。

评论

支持 Markdown