Magento 2 MCP Server

by boldcommerce
Verified

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Requires Node.js v14 or higher as the runtime environment for the MCP server.

  • Uses Zod for input parameter validation when defining tools for the MCP server.

Magento 2 MCP 服务器

这是一个连接到 Magento 2 REST API 的模型上下文协议 (MCP) 服务器,允许 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替换为您克隆此 repo 的路径
  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 为 SKU-xxx 的产品的信息”
  • “产品SKU-xxx属于哪些类别?”
  • “是否有与SKU-SKU-xxx相关的产品?”
  • “产品SKU-xxx的库存状况如何?”
  • “显示按价格排序的所有产品”
  • “将产品 SKU-xxx 的价格更新为 49.99 美元”
  • “将产品 ABC-123 的描述更改为防水”
  • “将产品 XYZ-456 的状态设置为‘已启用’”

客户查询

订单和收入查询

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

发展

SSL证书验证

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

添加新工具

要添加新工具,请遵循现有代码中的模式。每个工具的定义如下:

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

执照

国际学习中心

You must be authenticated.

A
security – no known vulnerabilities
F
license - not found
A
quality - confirmed to work

连接到 Magento 2 REST API 的模型上下文协议服务器,允许 Claude 和其他 MCP 客户端从 Magento 商店查询产品信息、客户数据和订单统计信息。

  1. Features
    1. Product Features
    2. Customer Features
    3. Order and Revenue Features
  2. Prerequisites
    1. Installation
      1. Usage
        1. Running the server directly
        2. Testing with the test client
        3. Using with Claude Desktop
      2. Available Tools
        1. Product Tools
        2. Customer Tools
        3. Order and Revenue Tools
      3. Example Queries for Claude
        1. Product Queries
        2. Customer Queries
        3. Order and Revenue Queries
      4. Development
        1. SSL Certificate Verification
        2. Adding New Tools
      5. License
        ID: tfobomjjwd