Woocommerce MCP Server

🚀 WooCommerce MCP 項目文檔

本項目是關於 WooCommerce MCP 的相關開發項目，提供了 WooCommerce 相關功能的開發支持，包括商品、訂單、客戶等功能，同時提供了完善的開發和部署方案。

🚀 快速開始

要開始使用本項目，你需要進行安裝和配置，然後運行項目。以下是具體步驟：

📦 安裝指南

安裝步驟

1. 克隆此倉庫到本地開發環境中：

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

2. 使用 Node.js 安裝依賴項：

   npm install
   

3. 配置環境變量，複製 .env.example 文件並命名為 .env：

   cp .env.example .env
   

環境變量配置

在 .env 文件中填寫以下信息：

• WOOCOMMERCE_URL: 指定 WooCommerce 實例的 URL（例如：https://your-store.com）
• WOOCOMMERCE_KEY: 指定 WooCommerce API 的開發者密鑰
• WOOCOMMERCE_SECRET: 指定 WooCommerce API 對應的密鑰

運行項目

開發模式運行

npm run dev

生產模式運行

npm start

Docker 部署

構建鏡像

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

運行容器

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

🏗️ 項目結構

/woocommerce-mcp
  /docs                      # 文檔目錄
  /scripts                   # 輔助腳本目錄
  /src
    /tools                   # API 工具目錄
      products.ts            # 商品相關功能
      orders.ts              # 訂單相關功能
      customers.ts           # 客戶相關功能
      analytics.ts           # 數據分析功能
      posts.ts               # 文章管理功能
      seo.ts                 # SEO 相關功能
    /utils                   # 工具函數目錄
      woocommerce.ts         # WooCommerce API 客戶端
      wordpress.ts           # WordPress API 客戶端
      seo-plugin.ts          # SEO 插件相關工具
      validation.ts          # 數據驗證工具
      cache.ts               # 緩存處理工具
      retry.ts               # 重試機制工具
      webhooks.ts            # Webhook 相關功能
      task-master.ts         # 與 Task Master 的集成適配器
    /types                   # TypeScript 類型定義目錄
      woocommerce.d.ts       # WooCommerce 數據類型定義
      wordpress.d.ts         # WordPress 數據類型定義
    index.ts                 # 入口文件
  .env.example               # 環境變量示例文件
  Dockerfile                 # Docker 鏡像構建文件
  docker-compose.yml         # Docker Compose 配置文件

🛠️ 開發指南

代碼風格與格式化

項目使用 ESLint 和 Prettier 維護代碼風格統一：

# 檢查代碼風格
npm run lint

# 自動格式化代碼
npm run format

測試

# 執行所有測試
npm test

# 帶覆蓋報告的測試
npm run test:coverage

🛠️ 項目工具

• Docker：用於容器化部署
• Node.js：項目運行環境
• ESLint 和 Prettier：代碼質量管理工具

⚠️ 故障排除

常見問題

1. 環境變量配置錯誤：
   • 檢查 .env 文件中的參數是否填寫正確。
2. Docker 部署失敗：
   • 確保 Docker 服務已啟動，並且有足夠的權限運行容器。

📚 詳細文檔

更多詳細信息請參考項目 README 文件或查閱相關技術文檔。