🚀 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 文件或查阅相关技术文档。