Magento 2 MCP Server

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"
      }
    }

1. 替换 /path/to/your/node 使用您在步骤1中检查的路径
2. 替换 /path/to/mcp-server.js 使用您克隆此仓库的路径
3. 您可以从Magento管理中的系统>集成获取API令牌
4. 重新启动克劳德桌面。
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证书并删除 httpsAgent 配置从 callMagentoApi 功能。

添加新工具

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

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

许可证

国际协调委员会