Woocommerce MCP Server

WooCommerce MCP Server is a middleware service for integrating WooCommerce stores with AI assistants and task management systems (such as Task Master), providing two-way data synchronization, content management, and API integration functions.

E-commerce and retail Developer tools #E-commerce integration #AI assistant #Task synchronization #API management Local .TypeScript

rating : 2.5 points

downloads : 8.6K

update time : 2025-04-28

Open Site

What is WooCommerce MCP Server?

This is a server for integrating the WooCommerce online store with AI assistants and task management systems. It allows automating product, order, and customer management processes through the unified MCP protocol.

How to use WooCommerce MCP Server?

1. Install the server on your server or via Docker 2. Configure the connection to your WooCommerce store 3. Integrate with your task management system or AI assistant

Use cases

• Automating order processing • Synchronizing data between WooCommerce and CRM • Integrating with chatbots for customer service • Sales analytics through AI assistants

Key features

Integration with WooCommerce

Full support for the WooCommerce v3 REST API for managing products, orders, and customers

Synchronization with Task Master

Two-way data synchronization between WooCommerce and the task management system

Support for MCP 1.0

Compatibility with the Model Context Protocol for integration with AI assistants

Webhook processing

Reactive data synchronization through WooCommerce webhooks

Content management

Working with articles and WordPress SEO

Advantages

Easy integration with existing WooCommerce systems

Flexibility in configuration for different business processes

Support for modern interaction protocols

Open source code with an MIT license

Limitations

Technical configuration is required for integration

Access to the WooCommerce API is necessary

Redis is required for some functions

How to use

Installation

Install the server via npm or Docker

API key configuration

Get the WooCommerce API keys and add them to the .env file

Server startup

Start the server in production mode

Integration with Task Master

Configure the connection parameters to your task management system

Usage examples

Automating order processing

When a new order is received in WooCommerce, a task is automatically created in Task Master

Product synchronization

Updating product information between WooCommerce and other systems

Frequently Asked Questions

Which versions of WooCommerce are supported?

Is Redis required for the server to work?

How to check if the server is working correctly?

Additional resources

WooCommerce REST API Documentation

Official WooCommerce API documentation

Project repository on GitHub

Source code and issue tracker

MCP 1.0 Documentation

MCP protocol specification

🚀 WooCommerce MCP Project Documentation

This project provides a comprehensive solution for integrating and managing WooCommerce services. It simplifies operations such as product management, order processing, and customer analytics.

🚀 Quick Start

📦 Installation

Clone this repository to your local development environment:

git clone https://github.com/yourusername/woocommerce-mcp.git
cd woocommerce-mcp

Install dependencies using Node.js:
```
npm install
```
Configure environment variables. Copy the .env.example file and rename it to .env:
```
cp .env.example .env
```

⚙️ Environment Variable Configuration

Fill in the following information in the .env file:

WOOCOMMERCE_URL: Specify the URL of your WooCommerce instance (e.g., https://your-store.com).
WOOCOMMERCE_KEY: Specify the developer key for the WooCommerce API.
WOOCOMMERCE_SECRET: Specify the corresponding secret key for the WooCommerce API.

▶️ Running the Project

Development Mode

npm run dev

Production Mode

npm start

🐳 Docker Deployment

Build the Image

docker build -t woocommerce-mcp-server:latest .

Run the Container

docker run -p 3000:3000 --env-file .env woocommerce-mcp-server:latest

💻 Project Structure

/woocommerce-mcp
  /docs                      # Documentation directory
  /scripts                   # Auxiliary script directory
  /src
    /tools                   # API tool directory
      products.ts            # Product-related functions
      orders.ts              # Order-related functions
      customers.ts           # Customer-related functions
      analytics.ts           # Data analysis functions
      posts.ts               # Article management functions
      seo.ts                 # SEO-related functions
    /utils                   # Utility function directory
      woocommerce.ts         # WooCommerce API client
      wordpress.ts           # WordPress API client
      seo-plugin.ts          # SEO plugin-related tools
      validation.ts          # Data validation tools
      cache.ts               # Cache processing tools
      retry.ts               # Retry mechanism tools
      webhooks.ts            # Webhook-related functions
      task-master.ts         # Integration adapter with Task Master
    /types                   # TypeScript type definition directory
      woocommerce.d.ts       # WooCommerce data type definitions
      wordpress.d.ts         # WordPress data type definitions
    index.ts                 # Entry file
  .env.example               # Environment variable example file
  Dockerfile                 # Docker image build file
  docker-compose.yml         # Docker Compose configuration file

🛠️ Development Guide

🎨 Code Style and Formatting

The project uses ESLint and Prettier to maintain a consistent code style:

# Check code style
npm run lint

# Automatically format code
npm run format

🧪 Testing

# Execute all tests
npm test

# Tests with coverage report
npm run test:coverage

🛠️ Project Tools

Docker: Used for containerized deployment.
Node.js: The project's runtime environment.
ESLint and Prettier: Code quality management tools.

🚧 Troubleshooting

🤔 Common Issues

Incorrect environment variable configuration:
- Check if the parameters in the .env file are filled in correctly.
Docker deployment failure:
- Ensure that the Docker service is running and you have sufficient permissions to run containers.