mcpField
S
shopify-setup

shopify-setup

github.com/jezweb开发1.1k1.2k 次安装3 周前更新
代码仓库

关于 shopify-setup

shopify-setup 是指导配置 Shopify CLI 身份验证和 Admin API 访问的技能,面向需要管理商店产品与内容的开发者。它涵盖创建自定义应用、保管令牌及验证 API 连接。

主要功能

  1. 01检查 Shopify CLI 并登录商店
  2. 02指导创建自定义应用和配置权限
  3. 03安全保存 Admin API 令牌
  4. 04验证 API 连接并记录商店配置

适用场景

  1. 01为商店产品管理准备 API 访问
  2. 02为其他项目保存可复用的商店配置

安装

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

$npx skills add https://github.com/jezweb/claude-skills --skill shopify-setup

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

附带文件references/api-scopes.md

详细介绍

Shopify 设置

为商店设置可用的 Shopify CLI 身份验证和 Admin API 访问权限。建立经过验证的 API 连接,以便管理产品和内容。

工作流

第 1 步:检查前置条件

确认已安装 Shopify CLI:

shopify version

如果尚未安装:

npm install -g @shopify/cli
第 2 步:通过商店进行身份验证
shopify auth login --store mystore.myshopify.com

这会打开浏览器进行 OAuth。用户必须是商店所有者,或拥有适当权限的员工。

登录后,进行验证:

shopify store info
第 3 步:创建用于 API 访问的自定义应用

自定义应用可提供稳定的 Admin API 访问令牌(而 CLI 会话令牌会过期)。

检查是否已有应用:询问用户是否已设置自定义应用。如果有,跳到第 4 步。

如果尚未创建自定义应用,请通过浏览器引导用户创建:

  1. 前往 https://{store}.myshopify.com/admin/settings/apps/development
  2. 点击 Create an app
  3. 为应用命名(例如“Claude Code Integration”)
  4. 点击 Configure Admin API scopes
  5. 启用以下权限范围(详情请参阅 references/api-scopes.md):
    • read_products、write_products
    • read_content、write_content
    • read_product_listings
    • read_inventory、write_inventory
    • read_files、write_files
  6. 点击 Save,然后点击 Install app
  7. 复制 Admin API access token(仅显示一次)

如果用户希望获得导航后台的帮助,可使用浏览器自动化工具(Chrome MCP 或 playwright-cli)。

第 4 步:保存访问令牌

安全地保存令牌。切勿将其提交到 git。

用于项目 — 创建 .dev.vars:

SHOPIFY_STORE=mystore.myshopify.com
SHOPIFY_ACCESS_TOKEN=shpat_xxxxxxxxxxxxxxxxxxxxx

确保 .dev.vars 已加入 .gitignore。

用于多个项目 — 将令牌存储在你偏好的密钥管理器中(环境变量、1Password CLI 等)。

第 5 步:验证 API 访问权限

使用简单的 GraphQL 查询测试连接:

curl -s https://{store}.myshopify.com/admin/api/2025-01/graphql.json \
  -H "Content-Type: application/json" \
  -H "X-Shopify-Access-Token: {token}" \
  -d '{"query": "{ shop { name primaryDomain { url } } }"}' | jq .

预期响应中会包含商店名称和域名。如果收到 401,说明令牌无效或已过期——请重新创建应用。

第 6 步:保存商店配置

在项目根目录中创建 shopify.config.json,供其他技能引用:

{
  "store": "mystore.myshopify.com",
  "apiVersion": "2025-01",
  "tokenSource": ".dev.vars"
}

关键模式

API 版本

始终指定明确的 API 版本(例如 2025-01)。在生产环境中使用 unstable 会导致问题,且不会发出警告。Shopify 每季度停用旧版 API。

令牌类型
令牌格式用途
Admin API 访问令牌shpat_*自定义应用——稳定且长期有效
CLI 会话令牌短期有效仅用于 Shopify CLI 命令
Storefront API 令牌shpca_*公开店面的查询

此技能设置的是 Admin API 访问令牌,这是管理产品和内容的正确选择。

速率限制

Shopify 使用漏桶速率限制器:

  • REST:突发速率为每秒 40 个请求,持续速率为每秒 2 个请求
  • GraphQL:每秒 1,000 个成本点数,每次查询最多 2,000 个点数

对于批量操作,请使用 bulkOperationRunQuery mutation,而不要循环执行。


参考文件

  • references/api-scopes.md — 管理产品和内容所需的 Admin API 权限范围

评论

支持 Markdown