article
README
🚀 Shopify MCP 服务器
Shopify MCP 服务器是一款基于 Model Context Protocol (MCP) 的工具,可与 Shopify 商店进行交互。它提供了一系列 GraphQL API 接口,能帮助开发者轻松管理商品、客户、订单等数据。
🚀 快速开始
Shopify 访问令牌
若要使用本服务器,需按以下步骤创建自定义应用并获取访问令牌:
- 登录 Shopify 管理界面。
- 进入 设置 > 应用和销售渠道。
- 点击 开发应用(可能需先启用开发者预览)。
- 创建新应用,可命名为“Shopify MCP 服务器”或其他便于记忆的名称。
- 配置 Admin API 权限范围:
- 读取和写入商品 (
read_products,write_products) - 读取和写入客户 (
read_customers,write_customers) - 读取和写入订单 (
read_orders,write_orders)
- 读取和写入商品 (
- 安装应用并获取 Admin API 访问令牌。
⚠️ 重要提示
请妥善保管访问令牌,避免泄露或误传至版本控制系统。
✨ 主要特性
- 强大的 GraphQL 支持:可通过 GraphQL 请求直接操作 Shopify 数据。
- 灵活的 MCP 协议:借助 MCP 的上下文模型协议实现高效的数据交互。
- 多场景支持:适用于商品管理、客户关系维护、订单处理等多种业务场景。
📦 安装指南
项目结构
- 克隆仓库:
git clone https://github.com/your-username/shopify-mcp-server.git
cd shopify-mcp-server
- 安装依赖:
npm install
- 创建
.env文件:
SHOPIFY_ACCESS_TOKEN=<你的访问令牌>
MYSHOPIFY_DOMAIN=<your-store>.myshopify.com
- 启动开发服务器:
npm start
依赖项
graphql:GraphQL 客户端库。axios:HTTP 请求库。dotenv:环境变量加载工具。
💻 使用示例
基础用法
在 Claude Desktop 中使用本服务器:
- 创建或编辑
claude_desktop_config.json文件。 - 添加以下配置:
{
"mcpServers": {
"shopify": {
"command": "npx",
"args": ["-y", "shopify-mcp-server"],
"env": {
"SHOPIFY_ACCESS_TOKEN": "<你的访问令牌>",
"MYSHOPIFY_DOMAIN": "<your-store>.myshopify.com"
}
}
}
}
- 启动服务器并开始使用相关工具。
📚 详细文档
工具列表
以下是服务器提供的主要工具:
商品管理
get-products:获取指定条件下的商品信息。create-product:创建新的商品。update-product:更新现有商品的详细信息。delete-product:删除指定商品。
客户管理
get-customers:列出所有客户信息。create-customer:添加新客户。update-customer:修改客户资料。delete-customer:移除指定客户。
订单处理
get-orders:获取订单列表。create-order:生成新的订单。update-order:更新订单状态或信息。cancel-order:取消未完成的订单。
其他功能
get-collections:获取商品集合信息。manage-webhook:订阅、查找或取消 webhook 事件。get-shop:获取商店的基本信息。get-shop-details:获取商店的详细配置,包括可用配送国家等。
📄 许可证
本项目采用 MIT 许可证,详情请见 LICENSE 文件。
🔗 相关链接
👥 社区与支持
- GitHub 仓库:https://github.com/your-username/shopify-mcp-server
- 问题反馈:欢迎在 Issues 中提交 bug 或提出功能需求。
- 文档贡献:欢迎为项目文档贡献力量。
Scan to contact