BigCommerce MCP服务器
用于BigCommerce REST API集成的综合模型上下文协议（MCP）服务器。该服务器为AI助手提供了通过三个强大工具与BigCommerce商店交互的能力：
- 🛍️ 产品管理：获取所有具有高级过滤功能的产品
- 👥 客户管理：使用全面的搜索选项检索和筛选客户
- 📦 订单管理：使用客户产品关系功能访问订单
✨ 特性
- ✅ 具有内置工具发现功能的MCP兼容服务器
- ✅ 增强了所有端点的过滤功能
- ✅ 通过订单历史关联客户产品
- ✅ 全面的错误处理和验证
- ✅ Docker支持生产部署
- ✅ 与Claude Desktop、Cline和其他MCP客户端兼容
🚦 入门指南
⚙️ 先决条件
- （包含在Node中）
- 具有API证书的BigCommerce商店
📥 安装和设置
1.克隆并安装依赖项
git clone https://github.com/isaacgounton/bigcommerce-api-mcp.git
cd bigcommerce-api-mcp
npm install2.配置您的BigCommerce凭据
创建一个 .env 项目根目录中的文件：
BIGCOMMERCE_STORE_HASH=your_store_hash_here
BIGCOMMERCE_API_KEY=your_api_key_here如何获取您的BigCommerce凭据：
- 转到您的BigCommerce管理面板
- 引导到 高级设置 > API账户
- 创建具有以下作用域的新API帐户：
- 产品：只读或修改 - 订单：只读或修改 - 客户：只读或修改
- 复制 存储哈希 和 访问令牌 到你的
.env文件
🔧 可用工具
get_all_products
- 从BigCommerce商店检索产品
- 参数：
store_Hash（必填）
get_all_customers
- 使用高级选项搜索和筛选客户
- 参数：
store_Hash（必填） - 可选过滤器：
email,name,company,phone,customer_group_id,limit,page,date_created,date_modified
get_all_orders
- 使用客户产品关系数据访问订单
- 参数：
store_Hash（必填） - 可选过滤器：
customer_id,email,status_id,min_id,max_id,limit,page - ✨ 特殊特征：筛选条件
customer_id查看与特定客户关联的所有产品
🔗 客户端集成
💬 克劳德桌面
步骤1：获取节点和mcpServer.js的绝对路径：
which node
# Example output: /usr/bin/node
realpath mcpServer.js
# Example output: /home/user/bigcommerce-api-mcp/mcpServer.js步骤2：打开克劳德桌面→ 设置 → 开发者 → 编辑配置 并添加：
{
"mcpServers": {
"bigcommerce": {
"command": "/usr/bin/node",
"args": ["/absolute/path/to/your/mcpServer.js"],
"env": {
"BIGCOMMERCE_STORE_HASH": "your_store_hash_here",
"BIGCOMMERCE_API_KEY": "your_api_key_here"
}
}
}
}步骤3：重新启动克劳德桌面。在MCP部分的“bigcommerce”旁边寻找一个绿色圆圈。
� Cline（VS代码扩展）
步骤1：在VS代码中安装Cline扩展
步骤2：打开VS代码设置并搜索“临床MCP”
步骤3：添加您的MCP服务器配置：
{
"cline.mcp.servers": {
"bigcommerce": {
"command": "node",
"args": ["/absolute/path/to/mcpServer.js"],
"env": {
"BIGCOMMERCE_STORE_HASH": "your_store_hash_here",
"BIGCOMMERCE_API_KEY": "your_api_key_here"
}
}
}
}🤖 其他MCP客户端
对于任何兼容MCP的客户端，请使用以下连接详细信息：
- 命令:
node - 参数:
["/path/to/mcpServer.js"] - 环境变量:
- BIGCOMMERCE_STORE_HASH - BIGCOMMERCE_API_KEY
🐳 Docker部署
快速开始
1.构建Docker镜像：
docker build -t bigcommerce-mcp .2.使用环境变量运行：
docker run -i --rm \
-e BIGCOMMERCE_STORE_HASH=your_store_hash \
-e BIGCOMMERCE_API_KEY=your_api_key \
bigcommerce-mcpClaude桌面与Docker
更新您的Claude Desktop配置以使用Docker：
{
"mcpServers": {
"bigcommerce": {
"command": "docker",
"args": [
"run", "-i", "--rm",
"-e", "BIGCOMMERCE_STORE_HASH=your_store_hash",
"-e", "BIGCOMMERCE_API_KEY=your_api_key",
"bigcommerce-mcp"
]
}
}
}Docker作曲（制作）
创建一个 docker-compose.yml:
version: '3.8'
services:
bigcommerce-mcp:
build: .
environment:
- BIGCOMMERCE_STORE_HASH=${BIGCOMMERCE_STORE_HASH}
- BIGCOMMERCE_API_KEY=${BIGCOMMERCE_API_KEY}
restart: unless-stopped然后运行：
docker-compose up -d🧪 测试
局部测试
在本地测试服务器以确保其正常工作：
# Test tool discovery
echo '{"jsonrpc":"2.0","method":"tools/list","params":{},"id":1}' | node mcpServer.js
# Test a tool call
echo '{"jsonrpc":"2.0","method":"tools/call","params":{"name":"get_all_products","arguments":{"store_Hash":"your_store_hash"}},"id":2}' | node mcpServer.js邮递员集成（可选）
您还可以使用Postman Desktop进行测试：
- 下载 邮差桌面
- 创建类型为的新MCP请求
STDIO - 将命令设置为：
node /absolute/path/to/mcpServer.js - 在连接到AI客户端之前测试您的工具
🛠️ 高级用法
服务器模式
标准stdio模式（默认）：
node mcpServer.js服务器发送事件的HTTP模式：
node mcpServer.js --sse流式HTTP模式：
node mcpServer.js --streamable-http环境变量
所有BigCommerce凭据都可以通过环境变量提供：
export BIGCOMMERCE_STORE_HASH="your_store_hash"
export BIGCOMMERCE_API_KEY="your_api_key"
node mcpServer.js🔍 工具示例
查找与客户关联的产品
// Use get_all_orders with customer_id filter
{
"name": "get_all_orders",
"arguments": {
"store_Hash": "your_store_hash",
"customer_id": "3"
}
}通过电子邮件搜索客户
// Use get_all_customers with email filter
{
"name": "get_all_customers",
"arguments": {
"store_Hash": "your_store_hash",
"email": "customer@example.com"
}
}🤝 贡献
欢迎投稿！请随时提交拉取请求。
📄 许可证
该项目根据MIT许可证获得许可。
🆘 支持和问题
- 🐛 问题:
- 💬 讨论:
- 📖 MCP文件: 模型上下文协议
- 🏪 BigCommerce API文档: BigCommerce API参考
🚀 接下来是什么？
此MCP服务器为BigCommerce集成提供了坚实的基础。可能的增强功能包括：
- 其他BigCommerce API端点（类别、品牌等）
- Webhook支持实时更新
- 高级过滤和搜索功能
- 多店铺支持
- 产品修改工具（创建/更新/删除）
______________________________________________________________________
内置于❤️ 对于MCP社区