Magento2 MCP

🚀 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 許可證。