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 检查你的 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"
      }
    }

1. 将 /path/to/your/node 替换为步骤 1 中检查的路径
2. 将 /path/to/mcp-server.js 替换为你克隆此仓库的路径
3. 你可以从 Magento 管理中的系统 > 集成中获取 API 令牌
4. 重新启动 Claude Desktop。
5. 现在你应该能够向 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-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