关于 storeport
storeport 为 Shopify 开发者提供文档检索、GraphQL 模式查询和代码块校验,并支持命令行与 MCP 服务。它无需令牌或 API 密钥,直接使用 Shopify 的公开开发者服务。
主要功能
- 01学习 Shopify API
- 02搜索并获取开发文档
- 03查询 Admin GraphQL 模式
- 04回答开发问题
- 05校验 GraphQL 与组件代码块
适用场景
- 01查找 checkout extensibility 文档
- 02了解特定 Shopify API
- 03查询 Product 类型字段
- 04提交前检查代码块
MCP 相关
以 stdio MCP 服务形式提供工具,供 MCP 客户端调用 Shopify API 学习、文档搜索、模式查询、问答和代码校验功能。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
7收录的工具列表 · 更新于 1 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api | string | 是 | 要学习的 Shopify API 接口名称(例如,用于返回引导式学习上下文的 API)。 |
| conversationId | string | 否 | 可选的对话标识符,用于继续现有学习对话。 |
详细介绍
storeport
storeport 是一款用于 Shopify 开发的小型辅助工具。Shopify 的 开发者资源十分广泛,包含许多 API、大型 GraphQL 架构和大量 文档。因此,storeport 将日常开发任务汇集到一处:在引导式上下文中 开始了解 API,搜索文档,并在片段不够用时获取完整页面,在 Admin GraphQL 架构中查询类型和字段,向开发者助手直接提问,并在 GraphQL 和 组件代码块上线前进行检查。一个二进制文件同时提供 命令行界面和 stdio MCP 服务。
无需 Shopify 商店令牌,也无需 API 密钥。上游是 Shopify 的
公共开发者服务,storeport 不会发送授权标头。基础 URL 默认为
https://shopify.dev,也可以通过
SHOPIFY_DEV_BASE_URL 环境变量覆盖。
安装
npx @reneturcios/storeport search "metafields"
也可以运行容器镜像:
docker run -i ghcr.io/cloudcorprecords/storeport
容器默认启动 MCP 服务(见下文)。传入 CLI 参数即可将其用作 CLI。
CLI
storeport learn admin-graphql
storeport learn functions --conversation-id conv-1
storeport search "checkout extensibility"
storeport search webhooks --max 5
storeport docs https://shopify.dev/docs/apps/build/checkout
storeport docs /docs/api/admin-graphql
storeport introspect Product
storeport introspect Order --api-version 2025-10
storeport ask "How do I store extra product data?"
storeport validate-graphql '{ shop { name } }'
storeport validate-components '<s-page heading="Hi"></s-page>'
storeport --version
每条命令都会输出上游 JSON 负载。退出代码:成功时为 0,
调用失败(包括上游 API 错误)时为 1,用法错误时为 2。空查询、提示词、内容和 URL
会在发出请求前被拒绝。
MCP 服务
一个二进制文件提供两种用法。mcp 子命令会启动 stdio MCP
服务:
npx -y @reneturcios/storeport mcp
MCP 客户端配置:
{
"mcpServers": {
"storeport": {
"command": "npx",
"args": ["-y", "@reneturcios/storeport", "mcp"]
}
}
}
无需 env 块:该服务不需要密钥。
工具
| 工具 | 输入 | 返回内容 |
|---|---|---|
learn_shopify_api | api(必填),conversationId(可选) | 指定 API 的引导式学习上下文。 |
search_docs_chunks | query(必填),maxNumResults(可选) | 最相关的文档片段。 |
fetch_full_docs | url(必填) | 一个文档页面的全文;绝对 URL 会按原样获取,路径则会与基础 URL 拼接。 |
introspect_graphql_schema | query(必填),apiVersion(可选) | 与词条匹配的 Admin GraphQL 类型和字段。 |
prompt_shopify_dev_assistant | prompt(必填),conversationId(可选) | 开发者助手的回答。 |
validate_graphql_codeblocks | content(必填),apiVersion(可选) | 每个 GraphQL 代码块的验证结果。 |
validate_component_codeblocks | content(必填) | Shopify 组件代码块的验证结果。 |
所有调用都会发往配置的基础 URL 下的 Shopify 开发者服务(默认
为 https://shopify.dev)。此版本涵盖文档化开发者资源的核心子集:不包含 Liquid/主题代码块
验证、其他框架的组件验证,以及文档更新/反馈工具。
开发
npm install
npm run build # tsc -> dist/
npm test # node test runner over test/*.test.ts, no network (fake fetch fixtures)
npm run dev # run the CLI from source via tsx
许可证
MIT——请参阅 LICENSE。
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。