Woocommerce MCP Server

🚀 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

1. Clone this repository to your local development environment:

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

2. Install dependencies using Node.js:

   npm install
   

3. 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

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

📚 Documentation Expansion

For more detailed information, please refer to the project's README file or relevant technical documentation.