🛒 WooCommerce MCP Server | Python Edition

# 🛒 WooCommerce MCP 服务器 | Python 版

> *一个简单高效的解决方案，用于将 WooCommerce 商店与模型上下文协议连接*

![Version](https://img.shields.io/badge/version-1.0.0-blue)
![Python](https://img.shields.io/badge/python-3.9%2B-yellow)
![License](https://img.shields.io/badge/license-MIT-green)

[🇺🇸 English Version](#english-version) | <b>🇮🇱 Hebrew Version</b>

## 📌 这是什么？

一个用于 WooCommerce 集成的模型上下文协议 (MCP) 服务器，与 WordPress REST API 兼容。该库提供了全面的工具来管理产品、订单、客户、运输、税收、折扣和商店配置的各个方面。

## 🚀 快速安装

```bash
# 步骤 1：克隆存储库
git clone https://github.com/yourusername/woocommerce-mcp-server.git
cd woocommerce-mcp-server

# 步骤 2：安装依赖项
pip install -r requirements.txt

# 步骤 3：配置环境变量（见下文）

☁️ 在 Railway 上部署

该服务器已准备好在 Railway 平台上立即部署：

# 步骤 1：将存储库克隆到您的 GitHub 帐户

# 步骤 2：登录 Railway 并使用您的 GitHub 帐户连接
# https://railway.app/

# 步骤 3：单击“New Project”并选择“Deploy from GitHub repo”

# 步骤 4：选择克隆的存储库

# 步骤 5：配置以下环境变量：
# - WORDPRESS_SITE_URL
# - WOOCOMMERCE_CONSUMER_KEY
# - WOOCOMMERCE_CONSUMER_SECRET
# - WORDPRESS_USERNAME (可选)
# - WORDPRESS_PASSWORD (可选)
# - MCP_HOST=0.0.0.0
# - MCP_PORT=8000

# 步骤 6：等待构建和部署完成

在 Railway 上部署的优势：

• 🔄 从 GitHub 自动部署
• 🔒 自动 SSL
• 📊 内置监控和日志记录
• 🔍 railway.app 上的免费子域名
• ⚡ 基于需求的自动缩放

⚙️ 配置

在项目根目录中创建一个 .env 文件，其中包含您的凭据：

WORDPRESS_SITE_URL=https://your-wordpress-site.com
WOOCOMMERCE_CONSUMER_KEY=your-woocommerce-consumer-key
WOOCOMMERCE_CONSUMER_SECRET=your-woocommerce-consumer-secret
WORDPRESS_USERNAME=your-wordpress-username
WORDPRESS_PASSWORD=your-wordpress-password

环境变量

变量	描述	是否必需
WORDPRESS_SITE_URL	您的 WordPress 站点 URL（WooCommerce 是一个 WordPress 插件）	✅
WOOCOMMERCE_CONSUMER_KEY	WooCommerce REST API 消费者密钥	✅
WOOCOMMERCE_CONSUMER_SECRET	WooCommerce REST API 消费者密钥	✅
WORDPRESS_USERNAME	具有适当权限的 WordPress 用户名	⚠️ *
WORDPRESS_PASSWORD	用于身份验证的 WordPress 密码	⚠️ *

* 仅 WordPress API 方法需要

🔐 身份验证选项

WooCommerce 身份验证

WooCommerce API 访问需要您可以在 WordPress 仪表板中的 WooCommerce → 设置 → 高级 → REST API 下生成的消费者密钥。

WordPress 身份验证

对于 WordPress 特定的方法（如管理帖子），您需要提供：

• 用于基本身份验证的用户名/密码凭据
• 必须在您的站点上启用 WordPress REST API

🔄 API 方法

该服务器支持 WordPress 和 WooCommerce API 方法。以下是按类别分组的可用方法列表：

WordPress 内容管理

这些方法需要 WordPress 用户名/密码凭据，并且独立于 WooCommerce API。

方法	描述
create_post	创建一个新的 WordPress 帖子
get_posts	检索 WordPress 帖子
update_post	更新现有的 WordPress 帖子
get_post_meta	获取帖子元数据
update_post_meta	更新帖子元数据
create_post_meta	创建帖子元数据
delete_post_meta	删除帖子元数据

WooCommerce 产品

方法	描述
get_products	检索产品列表
get_product	按 ID 获取单个产品
create_product	创建一个新产品
update_product	更新现有产品
delete_product	删除产品
get_product_meta	获取产品元数据
create_product_meta	创建/更新产品元数据
update_product_meta	更新产品元数据（创建的别名）
delete_product_meta	删除产品元数据

产品类别

方法	描述
get_product_categories	检索产品类别
get_product_category	获取单个产品类别
create_product_category	创建一个新的产品类别
update_product_category	更新产品类别
delete_product_category	删除产品类别

产品标签

方法	描述
get_product_tags	检索产品标签
get_product_tag	获取单个产品标签
create_product_tag	创建一个新的产品标签
update_product_tag	更新产品标签
delete_product_tag	删除产品标签

产品属性

方法	描述
get_product_attributes	检索产品属性
get_product_attribute	获取单个产品属性
create_product_attribute	创建一个新的产品属性
update_product_attribute	更新产品属性
delete_product_attribute	删除产品属性
get_attribute_terms	检索属性术语
get_attribute_term	获取单个属性术语
create_attribute_term	创建一个新的属性术语
update_attribute_term	更新属性术语
delete_attribute_term	删除属性术语

产品变体

方法	描述
get_product_variations	检索产品变体
get_product_variation	获取单个产品变体
create_product_variation	创建一个新的产品变体
update_product_variation	更新产品变体
delete_product_variation	删除产品变体
batch_update_product_variations	批量更新产品变体

产品评论

方法	描述
get_product_reviews	检索产品评论
get_product_review	获取单个产品评论
create_product_review	创建一个新的产品评论
update_product_review	更新产品评论
delete_product_review	删除产品评论

WooCommerce 订单

方法	描述
get_orders	检索订单列表
get_order	按 ID 获取单个订单
create_order	创建一个新的订单
update_order	更新现有订单
delete_order	删除订单
get_order_meta	获取订单元数据
create_order_meta	创建/更新订单元数据
update_order_meta	更新订单元数据（创建的别名）
delete_order_meta	删除订单元数据

订单备注

方法	描述
get_order_notes	检索订单备注
get_order_note	获取单个订单备注
create_order_note	创建一个新的订单备注
delete_order_note	删除订单备注

订单退款

方法	描述
get_order_refunds	检索订单退款
get_order_refund	获取单个订单退款
create_order_refund	创建一个新的订单退款
update_order_refund	更新订单退款
delete_order_refund	删除订单退款

WooCommerce 客户

方法	描述
get_customers	检索客户列表
get_customer	按 ID 获取单个客户
create_customer	创建一个新的客户
update_customer	更新现有客户
delete_customer	删除客户
get_customer_meta	获取客户元数据
create_customer_meta	创建/更新客户元数据
update_customer_meta	更新客户元数据（创建的别名）
delete_customer_meta	删除客户元数据

运输

方法	描述
get_shipping_zones	检索运输区域
get_shipping_zone	获取单个运输区域
create_shipping_zone	创建一个新的运输区域
update_shipping_zone	更新运输区域
delete_shipping_zone	删除运输区域
get_shipping_methods	检索运输方式
get_zone_shipping_methods	获取区域的运输方式
get_zone_shipping_method	获取区域的特定运输方式
create_zone_shipping_method	为区域创建新的运输方式
update_zone_shipping_method	更新区域的运输方式
delete_zone_shipping_method	从区域删除运输方式
get_shipping_zone_locations	获取运输区域的位置
update_shipping_zone_locations	更新运输区域的位置

税收

方法	描述
get_tax_classes	检索税类
create_tax_class	创建一个新的税类
delete_tax_class	删除税类
get_tax_rates	检索税率
get_tax_rate	获取单个税率
create_tax_rate	创建一个新的税率
update_tax_rate	更新税率
delete_tax_rate	删除税率
batch_update_tax_rates	批量更新税率

折扣/优惠券

方法	描述
get_coupons	检索优惠券
get_coupon	获取单个优惠券
create_coupon	创建一个新的优惠券
update_coupon	更新优惠券
delete_coupon	删除优惠券
batch_update_coupons	批量更新优惠券

支付网关

方法	描述
get_payment_gateways	检索支付网关
get_payment_gateway	获取单个支付网关
update_payment_gateway	更新支付网关

报告

方法	描述
get_sales_report	检索销售报告
get_products_report	检索产品报告
get_customers_report	检索客户报告
get_stock_report	检索库存报告

设置

方法	描述
get_settings	检索所有设置
get_setting_option	检索特定设置选项
update_setting_option	更新设置选项
batch_update_settings	批量更新设置

系统状态

方法	描述
get_system_status	检索系统状态
get_system_status_tools	检索系统状态工具
execute_system_status_tool	运行系统状态工具

数据

方法	描述
get_countries	检索国家/地区数据
get_country_states	检索国家/地区的州/省
get_currencies	检索货币数据
get_currency	获取特定货币的详细信息
get_current_currency	获取当前货币

💻 使用示例

初始化 MCP 服务器

import os
from dotenv import load_dotenv
from woocommerce_mcp import initialize

# 从 .env 加载环境变量
load_dotenv()

# 初始化 MCP 服务器
mcp = initialize()

# 运行服务器
async def main():
    mcp.run()

if __name__ == "__main__":
    import asyncio
    asyncio.run(main())

获取产品的示例

import asyncio
from woocommerce_mcp.products import get_products

async def list_products():
    # 获取最新产品
    products = await get_products({
        "per_page": 20, 
        "page": 1,
        "status": "publish"
    })
    
    for product in products:
        print(f"产品：{product['name']}，价格：{product['price']}")

# 运行函数
asyncio.run(list_products())

创建产品的示例

import asyncio
from woocommerce_mcp.products import create_product

async def add_new_product():
    product_data = {
        "name": "高级 T 恤",
        "type": "simple",
        "regular_price": "29.99",
        "description": "舒适的棉质 T 恤，有多种尺寸可供选择。",
        "short_description": "优质 T 恤。",
        "categories": [
            {
                "id": 19
            }
        ],
        "images": [
            {
                "src": "http://example.com/wp-content/uploads/2022/06/t-shirt.jpg"
            }
        ]
    }
    
    result = await create_product(product_data)
    print(f"创建了新产品，ID 为：{result['id']}")

# 运行函数
asyncio.run(add_new_product())

📋 函数参数

所有函数都接受其 API 操作的特定参数，以及以下可选参数：

• site_url：（如果在 env 中设置，则可选）WordPress 站点 URL
• consumer_key：（如果在 env 中设置，则可选）WooCommerce 消费者密钥
• consumer_secret：（如果在 env 中设置，则可选）WooCommerce 消费者密钥
• 对于 WordPress 方法：username 和 password（如果在 env 中设置，则可选）

🔒 安全提示

对于 WooCommerce REST API 访问，您需要生成 API 密钥。您可以在 WordPress 仪表板中的 WooCommerce → 设置 → 高级 → REST API 下创建它们。

📦 系统要求

• Python 3.9 或更高版本
• 安装了 WooCommerce 插件的 WordPress 站点
• WooCommerce REST API 密钥
• Python 包：mcp-server、httpx、python-dotenv

📄 许可证

MIT 许可证 - 有关详细信息，请参阅 LICENSE 文件