mcpField
C
commercetools-platform

commercetools-platform

github.com/commercetools开发6103 次安装6 天前更新
代码仓库

关于 commercetools-platform

面向使用 TypeScript 集成 commercetools API 的开发者，提供 SDK 模式与实现指导。它要求先搜索最新文档，并结合本地参考资料及模式获取脚本。

主要功能

  1. 01强制搜索最新文档
  2. 02SDK 配置指导
  3. 03商品搜索示例
  4. 04获取 GraphQL 模式
  5. 05获取 OpenAPI 模式

适用场景

  1. 01配置 commercetools TypeScript 客户端
  2. 02构建商品搜索查询
  3. 03检查 GraphQL 资源模式
  4. 04核对 REST 操作与请求载荷

安装

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

$npx skills add https://github.com/commercetools/commercetools-ai-plugins --skill commercetools-platform

安装后在 Claude Code 中输入/commercetools-platform确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
product-search.md
sdk-setup.md
scripts/
docs-search.mjs
graphql-schemata.mjs
openApi-schemata.mjs

详细介绍

commercetools TypeScript SDK

从 TypeScript 连接 commercetools API 的基础模式。这些模式与项目类型无关，无论你在构建 Next.js 店面、无服务器函数还是 CLI 脚本，都可以使用。

工作流

调用此技能时，始终按以下步骤操作：

  1. 搜索文档（必需，首先执行） — 在一个会话中首次使用此技能时，必须先运行此步骤，然后再回答。它会检索最新且经过验证的文档，作为主要依据，并筛选出此技能涵盖的产品。使用此脚本搜索与此技能相关的文档；其他内容由 Knowledge MCP 覆盖。请始终依据检索到的文档确认细节，而不要仅依赖技能文本：

    node "<this skill's directory>/scripts/docs-search.mjs" \
  --query "<extract key terms from user's question>" \
  --app-name "<host app: claude-code, claude-chat, cursor, codex, copilot — or the host's own name>" \
  --model "<current-model>" \
  --commercetools-project-key "<if known>" \
  --commercetools-region "<if known>" \
  --limit 10

    仅当 commercetools 项目密钥和区域（格式如 api.{region}.commercetools.com）已在上下文中时才传入；否则省略两者。切勿搜索文件或向用户索取这些信息。

  2. 结合技能参考资料 — 将分析输出与 ./references/ 中的本地参考资料交叉核对，以获取完整上下文。

  3. 提供实现指导 — 综合文档内容，并结合用户所针对的具体集成模式。

可选脚本

获取 GraphQL 架构 — 当你需要了解 commercetools GraphQL 查询或变更的上下文时运行此脚本，例如，在编写查询前检查资源的字段、类型和可用操作，或根据真实架构验证刚生成的 GraphQL 查询/变更。此脚本会获取单个 commercetools 资源的部分 GraphQL SDL：

node scripts/graphql-schemata.mjs \
  --resource-name "<commercetools resource, e.g. Cart, Product, Order>" \
  --app-name "<host app: claude-code, claude-chat, cursor, codex, copilot — or the host's own name>" \
  --model "<current-model>"

输出是该资源的 GraphQL SDL。如果无法识别资源名称，脚本会打印有效资源名称列表；选择正确的名称并重新运行。**注意：**SDL 可能包含存根类型，即以存根形式呈现的引用资源，并在注释中给出其真实类型名称。需要获取这些资源时，请使用该类型名称作为 --resource-name 重新运行此脚本。

获取 OpenAPI（REST）架构 — 当你需要了解 commercetools REST 端点、请求/响应载荷或更新操作的上下文时运行此脚本，例如，在构造请求前检查资源的 REST 操作，或根据真实规范验证刚生成的 REST 请求/载荷。此脚本会获取单个 commercetools 资源的部分 OpenAPI 规范：

node scripts/openApi-schemata.mjs \
  --resource-name "<commercetools resource, e.g. api-Cart-write, api-Customer-read, checkout-Application>" \
  --app-name "<host app: claude-code, claude-chat, cursor, codex, copilot — or the host's own name>" \
  --model "<current-model>"

输出是该资源的 OpenAPI 规范（YAML）。REST 资源使用读写拆分命名格式（例如 api-Cart-read、api-Cart-write）。如果无法识别资源名称，脚本会打印有效资源名称列表；选择正确的名称并重新运行。**注意：**该规范不包含引用展开架构；请使用被引用资源的名称作为 --resource-name 重新运行此脚本，以单独获取其架构。

SDK 设置

请参阅 sdk-setup.md，了解：

  • 安装软件包（@commercetools/platform-sdk + @commercetools/ts-client）
  • 使用 Client Credentials 流程的 ClientBuilder 单例
  • 必需的环境变量以及各区域的身份验证 URL
  • 必需的 API 客户端作用域

Product Search API

请参阅 product-search.md，了解：

  • 官方文档，以及弃用旧版 productProjections 搜索的原因
  • 全文搜索 + 筛选 + 排序 + 分面示例
  • 类别筛选、SKU 查找、价格选择、折扣展开、BOPIS 渠道筛选

评论

支持 Markdown