JinDaGe - Woo-mcp-server MCP Details

article

README

🚀 [使用指南]

本项目提供了与 WooCommerce 进行交互的功能，通过代码示例展示了如何初始化服务器、获取和创建产品等操作，能帮助开发者快速集成 WooCommerce 相关功能。

🚀 快速开始

本项目提供了一系列与 WooCommerce 交互的功能，以下将详细介绍如何安装和使用。

📦 安装指南

初始化 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: {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": "Premium T-Shirt",
        "type": "simple",
        "regular_price": "29.99",
        "description": "舒适的棉质 T 恤，多种尺码可选。",
        "short_description": " premium quality t-shirt.",
        "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 | (可选，如果在环境中设置过) WordPress 站点 URL | | consumer_key | (可选，如果在环境中设置过) WooCommerce 消费者密钥 | | consumer_secret | (可选，如果在环境中设置过) WooCommerce 消费者秘密 | | username 和 password | 对于 WordPress 方法: (可选，如果在环境中设置过) |

🔒 安全注意

⚠️ 重要提示

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

📦 系统要求

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

📄 许可证

本项目采用 MIT License，详细信息请查看 LICENSE 文件。

Woo-mcp-server