🚀 Magento 2 MCP 服务器

这是一个模型上下文协议（MCP）服务器，它连接到 Magento 2 REST API，能让 Claude 及其他 MCP 客户端查询 Magento 商店里的产品信息，为用户提供便捷的产品数据获取途径。

🚀 快速开始

本服务器可让您方便地查询 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. 检查您的 Node 路径：which node
2. 转到开发者设置并点击“编辑配置”，这将打开一个 JSON 文件。
3. 在 mcpServers 中添加以下代码片段：

    "magento2": {
      "command": "/path/to/your/node",
      "description": ""
    }

4. 将 /path/to/your/node 替换为实际的 Node.js 路径。

📚 详细文档

可用工具

• createMagentocommandTool：创建用于执行 Magento 命令的 CLI 工具。
• healthCheckMCP：对 MCP 服务器进行健康检查，确保其正常运行。
• productImportExport：实现产品的导入和导出功能。

示例查询

产品查询示例

curl -X POST http://localhost:3000/magento/product-import-export \
-H "Content-Type: application/json" \
-d '{"action": "import", "products": ["SKU123", "SKU456"]}'

订单统计示例

curl -X POST http://localhost:3000/magento/orders \
-H "Content-Type: application/json" \
-d '{"startDate": "2023-01-01", "endDate": "2023-12-31"}'

🔧 技术细节

SSL 证书验证

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

添加新工具

要添加新的工具，请按照现有代码的模式进行。每个工具都需定义为：

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

📄 许可证

本项目采用 ISC 许可证。