Magento 2 MCP Server

Magento 2 MCP 服务

这是一个模型上下文协议（MCP）服务，可连接到 Magento 2 REST API，让 Claude 和其他 MCP 客户端查询 Magento 商店中的产品信息。

功能

产品功能

• 按 SKU 或 ID 查询产品信息
• 使用各种条件搜索产品
• 获取产品类别
• 获取相关产品
• 获取产品库存信息
• 获取产品属性
• 通过指定属性代码和值更新产品属性
• 支持筛选和排序的高级产品搜索

客户功能

• 按电子邮件地址获取客户订购的所有产品

订单和收入功能

• 获取指定日期范围内的订单数量
• 获取指定日期范围内的收入
• 获取指定日期范围内按国家/地区筛选的收入
• 获取产品销售统计数据，包括售出数量和畅销产品
• 支持“today”“yesterday”“last week”“this month”“YTD”等相对日期表达式
• 支持使用国家/地区代码和名称进行筛选

前提条件

• Node.js（v14 或更高版本）
• 可访问 REST API 的 Magento 2 实例
• Magento 2 实例的 API 令牌

安装

1. 克隆此仓库
2. 安装依赖项：

npm install

用法

直接运行服务

node mcp-server.js

使用测试客户端进行测试

node test-mcp-server.js

与 Claude Desktop 配合使用

1. 使用 which node 检查 node 的路径
2. 前往开发者设置并点击“Edit config”。这将打开一个 JSON 文件。
3. 在 mcpServers 中添加以下代码片段：

    "magento2": {
      "command": "/path/to/your/node",
      "args": ["/path/to/mcp-server.js"],
      "env": {
        "MAGENTO_BASE_URL": "https://YOUR_DOMAIN/rest/V1",
        "MAGENTO_API_TOKEN": "your-api-token"
      }
    }

3. 将 /path/to/your/node 替换为你在第 1 步中检查到的路径
4. 将 /path/to/mcp-server.js 替换为你克隆此仓库的路径
5. 你可以在 Magento 管理后台的 System > Integrations 中获取 API 令牌
6. 重启 Claude Desktop。
7. 现在，你应该可以向 Claude 询问 Magento 商店中的产品相关问题。

可用工具

该服务提供以下工具：

产品工具

• get_product_by_sku：按 SKU 获取产品的详细信息
• search_products：使用 Magento 搜索条件搜索产品
• get_product_categories：按 SKU 获取指定产品的类别
• get_related_products：按 SKU 获取与指定产品相关的产品
• get_product_stock：按 SKU 获取产品库存信息
• get_product_attributes：按 SKU 获取产品的所有属性
• get_product_by_id：按 ID 获取产品的详细信息
• advanced_product_search：使用高级筛选选项搜索产品
• update_product_attribute：按 SKU 更新产品的指定属性

客户工具

• get_customer_ordered_products_by_email：按电子邮件地址获取客户订购的所有产品

订单和收入工具

• get_order_count：获取指定日期范围内的订单数量
• get_revenue：获取指定日期范围内的总收入
• get_revenue_by_country：获取指定日期范围内按国家/地区筛选的收入
• get_product_sales：获取指定日期范围内的产品售出数量统计数据

Claude 查询示例

MCP 服务连接到 Claude Desktop 后，你可以询问：

产品查询

• “有哪些衬衫类产品？”
• “介绍一下 SKU 为 SKU-xxx 的产品。”
• “SKU-xxx 产品属于哪些类别？”
• “SKU-SKU-xxx 有相关产品吗？”
• “SKU-xxx 产品的库存状态是什么？”
• “按价格排序显示所有产品。”
• “将 SKU-xxx 产品的价格更新为 $49.99。”
• “将 ABC-123 产品的描述改为防水。”
• “将 XYZ-456 产品的状态设为 ‘enabled’。”

客户查询

• “客户 [email protected] 订购了哪些产品？”
• “显示电子邮件地址为 [email protected] 的客户的订单历史和产品。”

订单和收入查询

• “我们今天有多少笔订单？”
• “上周的订单数量是多少？”
• “我们昨天的收入是多少？”
• “我们上个月的总收入是多少？”
• “今年迄今为止，我们在荷兰的收入是多少？”
• “我们上周在德国的收入是多少？”
• “比较一下我们本月在美国和加拿大的收入”
• “我们本月已完成订单的平均订单金额是多少？”
• “我们上个月卖出了多少件商品？”
• “今年哪些商品最畅销？”
• “每笔订单平均包含多少件商品？”
• “上个季度我们在德国卖出了多少件产品 XYZ-123？”
• “本月哪些产品在美国创造的收入最高？”

开发

SSL 证书验证

出于开发目的，服务器已配置为跳过 SSL 证书验证。在生产环境中，应使用有效的 SSL 证书，并从 callMagentoApi 函数中移除 httpsAgent 配置。

添加新工具

要添加新工具，请遵循现有代码中的模式。每个工具都包含：

1. 唯一名称
2. 描述
3. 使用 Zod 验证的输入参数
4. 用于处理请求并返回响应的异步处理函数

许可证

ISC