Woocommerce MCP Server Rdn

🚀 WooCommerce MCP Server

A Model Context Protocol (MCP) server for integrating WooCommerce with Claude and other AI assistants.

🚀 Quick Start

This server provides tools that enable AI assistants to interact with WooCommerce stores, allowing them to:

• Retrieve recent orders with optional filtering.
• Obtain detailed information for a specific order ID.

✨ Features

• Order Retrieval: AI assistants can get recent orders and detailed information of specific orders from WooCommerce stores.
• Customizable Configuration: Allows users to configure WooCommerce and MCP server settings according to their needs.
• Integration with Claude: Can be integrated with Claude desktop for seamless interaction.
• Custom Server Building: Enables users to build their own custom MCP servers.

📦 Installation

To use this MCP server, you need the following:

1. Node.js: Make sure Node.js is installed (version 14 or higher is recommended).
2. npm: Verify that npm is installed.
3. WooCommerce REST API Access: You need administrator access to your WooCommerce store to obtain API tokens.

Follow these steps to install the MCP server:

1. Clone this repository:

   git clone [Repository URL]
   cd woocommerce-mcp-server
   

2. Install dependencies:

   npm install
   

3. Start the server:

   npm start
   

📚 Documentation

Configuration

WooCommerce Configuration

Add the following configuration to the config.js file:

const wooCommerceConfig = {
    URL: 'YOUR_WOOCOMMERCE_SITE_URL',
    CONSUMER_KEY: 'YOUR_API_KEY',
    CONSUMER_SECRET: 'YOUR_API_SECRET'
};

MCP Server Configuration

In the server.js file, load the WooCommerce configuration and initialize the MCP server:

const wooCommerce = require('woocommerce')(config);
const mcpServer = new McpServer(wooCommerce);
mcpServer.start();

Running the Server

After starting the server, you can access the MCP services at the following endpoints:

• Get Recent Orders: GET /api/orders
• Get Specific Order: GET /api/orders/{orderId}

Integration with Claude Desktop

To use this MCP server in Claude Desktop, follow these steps:

1. Download and install Claude Desktop.
2. Add the details of the MCP server to the config.json file:

   {
       "servers": [
           {
               "name": "WooCommerce MCP Server",
               "host": "localhost",
               "port": "3000"
           }
       ]
   }
   

3. Start Claude Desktop and integrate it with your WooCommerce store.

Available Tools

💻 Usage Examples

Basic Usage

// Get recent orders
server.tool(
    'getRecentOrders',
    {
        count: z.number().int().positive().describe('Number of orders to retrieve (maximum 10)')
    },
    async ({count}) => {
        const orders = await wooCommerce.orders.getAll({
            per_page: count,
            page: 1
        });
        
        return {
            content: [
                {
                    type: 'text',
                    text: JSON.stringify(orders.data, null, 2)
                }
            ]
        };
    }
);

// Get a specific order
server.tool(
    'getOrderById',
    {
        orderId: z.string().describe('ID of the order to retrieve')
    },
    async ({orderId}) => {
        const order = await wooCommerce.orders.getOrder(orderId);
        
        return {
            content: [
                {
                    type: 'text',
                    text: JSON.stringify(order.data, null, 2)
                }
            ]
        };
    }
);

Building a Custom MCP Server

Step 1 - Initialize the Project

Create a new Node.js project and install the required dependencies:

mkdir my-mcp-server
cd my-mcp-server
npm init
npm install @modelcontextprotocol/sdk

Edit the package.json file to support ES modules:

{
    "type": "module",
    "scripts": {
        "start": "node index.js"
    }
}

Step 2 - Define Tools

Define MCP tools in the index.js file:

const { McpServer } = require('@modelcontextprotocol/sdk');

// Create an MCP server instance
const server = new McpServer();

// Register a tool: Get string length
server.tool(
    'getStrLength',
    {
        input: z.string().describe('The string to calculate the length of')
    },
    async ({input}) => {
        return {
            content: [
                {
                    type: 'text',
                    text: `${input.length} string length`
                }
            ]
        };
    }
);

// Start the server
server.start();

Step 3 - Test Locally

Run the following command to test the MCP server:

npm start

📄 License

MIT License

Resources

• Model Context Protocol Documentation
• MCP JavaScript SDK
• WooCommerce REST API Documentation