Woo MCP Server

🚀 [Usage Guide]

This guide provides a comprehensive overview of how to use the MCP server, including installation, usage examples, function parameters, security considerations, system requirements, and licensing information.

🚀 Quick Start

Initializing the MCP Server

import os
from dotenv import load_dotenv
from woocommerce_mcp import initialize

# Load environment variables from .env file
load_dotenv()

# Initialize the MCP server
mcp = initialize()

# Run the server
async def main():
    mcp.run()

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

💻 Usage Examples

Basic Usage

import asyncio
from woocommerce_mcp.products import get_products

async def list_products():
    # Get the latest products
    products = await get_products({
        "per_page": 20, 
        "page": 1,
        "status": "publish"
    })
    
    for product in products:
        print(f"Product: {product['name']}, Price: {product['price']}")

# Run the function
asyncio.run(list_products())

Advanced Usage

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": "Comfortable cotton T-shirt available in multiple sizes.",
        "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"New product created with ID: {result['id']}")

# Run the function
asyncio.run(add_new_product())

📚 Documentation

Function Parameters

All functions accept their specific API action parameters, as well as the following optional parameters:

• site_url: (Optional, if set in the environment) WordPress site URL
• consumer_key: (Optional, if set in the environment) WooCommerce consumer key
• consumer_secret: (Optional, if set in the environment) WooCommerce consumer secret
• For WordPress methods: username and password (Optional, if set in the environment)

Security Note

To access the WooCommerce REST API, you need to generate API keys. You can create them under WooCommerce → Settings → Advanced → REST API in the WordPress dashboard.

System Requirements

• Python 3.9 or higher
• A WordPress site with the WooCommerce plugin installed
• WooCommerce REST API keys
• Python packages: mcp-server, httpx, python-dotenv

📄 License

This project is licensed under the MIT License. For more details, please refer to the LICENSE file.