README
🚀 Shopify MCP 服务器
Shopify MCP 服务器是一个基于 Model Context Protocol (MCP) 的服务器,它能将 Claude 等客户端与您的 Shopify 商店数据相连接。借助该服务器,您可以轻松检索商店中的商品和客户信息。
🚀 快速开始
先决条件
- Python 3.12 或更高版本
- 带有 API 访问权限的 Shopify 商店
- Shopify API 凭证(API 密钥、密码和访问令牌)
安装
- 克隆仓库:
git clone https://github.com/siddhantbajaj/shopify-mcp-server.git
cd shopify-mcp-server
- 创建并激活虚拟环境使用
uv:
uv venv
source .venv/bin/activate # 在 Unix/MacOS 上
# 或者
.venv\Scripts\activate # 在 Windows 上
- 安装包:
uv pip install -e .
配置
- 在根目录中创建一个
.env文件,包含您的 Shopify 凭证:
SHOPIFY_SHOP_URL="your-store.myshopify.com"
SHOPIFY_API_KEY="your_api_key"
SHOPIFY_PASSWORD="your_api_password"
SHOPIFY_ACCESS_TOKEN="your_access_token"
将占位符值替换为您的实际 Shopify API 凭证。
使用方法
- 启动 MCP 服务器:
python -m shopify_mcp_server.server
- 该服务器公开了两个工具:
get-product-list
从您的 Shopify 商店中获取商品列表。
- 可选参数:
limit(默认值为 10) - 返回的最大商品数量
get-customer-list
从您的 Shopify 商店中获取客户列表。
- 可选参数:
limit(默认值为 10) - 返回的最大客户数量
✨ 主要特性
get-product-list:从您的 Shopify 商店中获取商品列表get-customer-list:从您的 Shopify 商店中获取客户列表- 更多功能即将推出
💻 使用示例
基础用法
# 启动 MCP 服务器
python -m shopify_mcp_server.server
# 获取商品列表,默认返回 10 个商品
curl http://localhost:8000/get-product-list
# 获取客户列表,默认返回 10 个客户
curl http://localhost:8000/get-customer-list
高级用法
# 获取商品列表,指定返回 20 个商品
curl http://localhost:8000/get-product-list?limit=20
# 获取客户列表,指定返回 20 个客户
curl http://localhost:8000/get-customer-list?limit=20
🔧 技术细节
该项目使用:
- MCP (模型上下文协议) 用于构建 AI 驱动的工具
- Shopify Python API 用于 Shopify 集成
- UV 用于依赖管理
📄 许可证
该项目使用 MIT 许可证发布 - 请参阅 LICENSE 文件了解详细信息。
🤝 贡献
- 叉克隆仓库
- 创建功能分支(
git checkout -b feature/amazing-feature) - 提交您的更改(
git commit -m 'Add some amazing feature') - 推送到分支(
git push origin feature/amazing-feature) - 打开拉取请求
⚠️ 重要提示
- 永远不要将
.env文件提交到版本控制中 - 保护好您的 Shopify API 凭证
- 使用环境变量存储敏感信息
💡 使用建议
在使用该服务器时,建议您根据实际需求调整 limit 参数,以获取合适数量的商品和客户信息。同时,确保您的 Shopify API 凭证的安全性,避免信息泄露。
Scan to contact