# @curless/shopify-storefront 中文文档

规范地址：https://npmcn.com/package/%40curless/shopify-storefront/

版本：0\.76\.0
npm 元数据更新时间：2026-11-11T02:55:52.464Z
中文译文更新时间：2026-11-11T04:59:44.881Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40curless/shopify-storefront
原文对照：https://npmcn.com/package/%40curless/shopify-storefront/?lang=original
项目主页：https://mcp.curless.ai/doc/sdks/
源码仓库：https://gitlab.com/curless-group1/agentbank

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2.6 MB，210 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：6 个
- 首次发布：2026-08-24T02:00:43.865Z
- 最新版本发布：2026-11-11T02:55:52.276Z
- 近 30 天下载量：7139（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：130（近 12 个月 130 个）

## 中文简介

一个由配置文件驱动的 Shopify storefront MCP连接器. 身份,工具名,词汇和店铺接线都出自一款"StorefrontConfig",因此第二个商家是JSON文件,而不是3400行的分叉.

## 安装

```sh
npm install @curless/shopify-storefront
```

也可以使用：`pnpm add @curless/shopify-storefront`、`yarn add @curless/shopify-storefront`、`bun add @curless/shopify-storefront`

## README

# @ curless/ shopify- storefront (中文(简体) )

A 类 **商店作为 MCP 连接器** 人工智能助理(Claude、ChatGPT和 任何其他MCP主机). 买家浏览目录、选择选项、建造推车 并传递链接到 **商家自己买的** - 钱和 命令留在商场里 成果构成 [MCP 应用程序](https://github.com/modelcontextprotocol/ext-apps) 纸牌.

一个服务器,由配置文件驱动:商家名,工具名,词 他们卖什么 店铺的接线都来自 `config.json`,那么一秒钟 商人是第二个文件,不是叉子.

```bash
npm install -g @curless/shopify-storefront
STOREFRONT_CONFIG=./config.json \
STOREFRONT_SHOPIFY_CLIENT_ID=… STOREFRONT_SHOPIFY_CLIENT_SECRET=… \
curless-shopify-storefront
```

部署于22号节点. 它听着 `PORT` (默认 8090) 并期望 TLS 结束 在它前面设置的反向代理 `X-Forwarded-For`。 。 。 .

## 工具

从配置中命名 `naming.prefix` 和名词——带有前缀 `acme` 编辑 默认名词 `product`数字 :

| 工具 | 它会做什么 |
| --- | --- |
| `list_acme_products` | 目录作为名片;可选 `query`, (中文(简体) ), `maxPrice`, (中文(简体) ), `limit`。 。 。 . |
| `get_acme_product` | 一种产品:期权,价格,这些组合在库存中. |
| `add_to_acme_cart` 编号 : `view_acme_cart` 编号 : `clear_acme_cart` | 这个服务器保存的一辆车,作为记忆,每个对话。 在买方付款之前,任何物品都不能送到Shoppify. |
| `get_acme_checkout_link` | 一个变体的Shofify推车 或整个推车。 创造无相. |
| `lookup_acme_order` | 一个订单,鉴于它的订单号 **财务报告和审定财务报表** 放在邮件里. |
| `get_acme_store_policies` | 店内出版的回放,航运,隐私和名词页. |
| `check_acme_checkout_status` | 只限卡:其开出的出票是否已经支付. |

## 配置

`config.json` 拥有所有能识别商家的东西; 环境 只有秘密和机器设置.

```json
{
  "id": "acme",
  "server": { "name": "acme-shop", "title": "Acme", "websiteUrl": "https://acme.example" },
  "naming": { "prefix": "acme" },
  "shopify": { "mode": "env", "shopDomain": "acme.myshopify.com" },
  "urls": { "appUrl": "https://mcp.acme.example" },
  "legal": {
    "operatorContact": "ops@acme.example",
    "merchantContact": "support@acme.example",
    "updated": "1 October 2026"
  }
}
```

-   `shopify.mode: "env"` 服务一个商店,通过应用程序安装一次 OAuth 流量 (`/auth/install`); 符号存储于 `shopify.tokenPath` (默认) `/app/data/<id>-token.json` ——保留一卷. `"oauth-install"` 是多店的表格,店铺是安装的 应用程序和连接器 URL 是 `/s/<shop>/mcp`。 。 。 .
-   `urls.appUrl` 在 Shopify 注册的应用程序 URL ; `urls.publicUrl`,当 设置,是主机名购买者连接到的.
-   `legal.*` 填补 `/privacy`, (中文(简体) ), `/terms` 财务报告和审定财务报表 `/docs` 页面目录 审取所读. 失去的联系人不会辜负靴子,但会留下空隙.

| 环境 |  |
| --- | --- |
| `STOREFRONT_CONFIG` | 路径 `config.json` (所须. |
| `STOREFRONT_SHOPIFY_CLIENT_ID` 编号 : `_CLIENT_SECRET` | Shopify app的证书;这个秘密也签下了OAuth的回调和webhooks. |
| `STOREFRONT_SHOPIFY_ADMIN_TOKEN` | 可选:一个已存在的Admin API 令牌,跳过安装. |
| `PORT` | 默认 `8090`。 。 。 . |
| `CATALOG_REFRESH_MS` | 默认 `300000` (5分钟). 一个失败的刷新继续服务最后的好目录. |
| `OPENAI_APPS_CHALLENGE_TOKENS` | `host=token,…` ——ChatGPT Apps域名验证. |

## 终点

`POST /mcp` (和 `/`)是MCP的终点(可流HTTP,JSON响应). 与此同时: `/healthz`, (中文(简体) ), `/docs`, (中文(简体) ), `/privacy`, (中文(简体) ), `/terms`, (中文(简体) ), `/icon.png`, (中文(简体) ), `/logo.png`, (中文(简体) ), `/img` (卡片的图像代理 shopify CDN),和 设置路径 `/auth/install`, (中文(简体) ), `/auth/callback`, (中文(简体) ), `/webhooks/shopify`。 。 。 .

## 它守护着什么

-   **售出时不需要书写进入商店.** 退出为 Shopify 链接;没有卡号或支付符到达此服务器.
-   **排序查询** 需要命令号和电子邮件一起回答 a 错误的电子邮件和缺少的订单, 并暂停在5个错失后查找 15分钟之内,一个顺序号、一个电子邮件或一个谈话(50) 给一个网络地址 给整个店铺一百块.
-   **限制**: 60个请求,每个地址一分钟,1个 MB 请求机构,范围 工具参数.
-   **商人自己的文字** (说明、政策)失去控制 和隐形字符, 长度被封住, 并被围住,直到到达 助理人员.

## 许可证

麻省理工学院

## 常见问题

### @curless/shopify-storefront 是什么？

一个由配置文件驱动的 Shopify storefront MCP连接器\. 身份,工具名,词汇和店铺接线都出自一款"StorefrontConfig",因此第二个商家是JSON文件,而不是3400行的分叉\.

### 如何安装 @curless/shopify-storefront？

在项目目录运行 npm install @curless/shopify-storefront，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 curless-shopify-storefront，可以用 npx curless-shopify-storefront 直接运行。

### @curless/shopify-storefront 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/curless\_\_shopify-storefront 是否存在。

### @curless/shopify-storefront 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @curless/shopify-storefront 可以商用吗？

@curless/shopify-storefront 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @curless/shopify-storefront 的下载量有多少？

根据 npm 官方下载统计，@curless/shopify-storefront 在 2026/10/11 – 2026/11/09 这 30 天内被下载 7,139 次，日均约 238 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @curless/shopify-storefront 还在维护吗？

最新版本 0\.76\.0 发布于 2026/11/11（今天）；至今共发布 130 个版本，其中过去 12 个月发布了 130 个；首次发布于 2026/08/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。