Magento 2 MCP 服务器

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

功能

产品功能

• 根据 SKU 或 ID 查询产品信息
• 使用各种标准搜索产品
• 获取产品类别
• 获取相关产品
• 获取产品库存信息
• 获取产品属性
• 通过指定属性代码和值更新产品属性
• 具有筛选和排序功能的高级产品搜索

客户功能

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

订单和收入功能

• 获取特定日期范围内的订单数量
• 获取特定日期范围内的收入
• 获取特定日期范围内按国家过滤的收入
• 获取产品销售统计信息，包括售出数量和最畅销产品
• 支持相对日期表达式如“今天”、“昨天”、“上周”、“本月”、“年初至今”
• 支持使用国家代码和国家名称进行国家过滤

预备条件

• 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 检查你的路径节点
2. 前往开发者设置并点击“编辑配置”。这将打开一个 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 管理中的系统 > 集成获取 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-xxx 这个产品的信息。”
• “SKU-xxx 属于哪些类别？”
• “SKU-xxx 有哪些相关产品？”
• “SKU-xxx 的库存状态是什么？”
• “按价格排序显示所有产品。”
• “将 SKU-xxx 的价格更新为 $49.99。”
• “将产品 ABC-123 的描述改为防水。”
• “将产品 XYZ-456 的状态设为‘启用’。”

客户查询

• “john.doe@example.com 客户订购了哪些产品？”
• “展示具有电子邮件 jane.smith@example.com 的客户的订单历史和产品。”

订单和收入查询

• “我们今天有多少订单？”
• “上周我们的订单数是多少？”
• “我们昨天产生了多少收入？”
• “上个月我们的总收入是多少？”
• “今年到目前为止我们在荷兰产生了多少收入？”
• “我们上周在德国的收入是多少？”
• “比较我们本月在美国和加拿大的收入。”
• “我们本月已完成订单的平均订单价值是多少？”
• “我们上个月卖出了多少产品？”
• “我们今年的最畅销产品是什么？”
• “每订单的平均产品数量是多少？”
• “我们在上个季度在德国卖出了多少单位的 XYZ-123 产品？”
• “我们这个月在美国产生的收入最多的商品是什么？”

开发

SSL 证书验证

为了开发目的，服务器被配置为绕过 SSL 证书验证。在生产环境中，你应该使用正确的 SSL 证书，并从 callMagentoApi 函数中移除 httpsAgent 配置。

添加新工具

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

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

许可证

ISC