Magento2 MCP Server

🚀 Magento 2 MCP 服務器

這是一個為 Magento 2 實現的 Model Context Protocol (MCP) 服務器，藉助標準化接口，能讓 AI 助手與您的 Magento 商店進行交互，為您的業務帶來更高效的管理體驗。

✨ 主要特性

• 與 Magento 2 的 REST API 集成，實現數據交互。
• 具備安全的身份驗證處理，保障信息安全。
• 擁有常見 Magento 操作的資源和工具處理器，提升操作效率。
• 使用 TypeScript 實現類型安全，增強代碼穩定性。
• 基於官方 MCP SDK 開發，確保功能的規範性。

🚀 快速開始

在使用 Magento 2 MCP 服務器前，需要滿足以下先決條件：

• Node.js (v18 或更高版本)
• npm (v8 或更高版本)
• 具有 REST API 訪問權限的 Magento 2 實例
• Magento 管理員 API 令牌

📦 安裝指南

使用以下命令安裝 Magento 2 MCP 服務器：

npm install vasileuski/magento2-mcp-server

💻 使用示例

基礎用法

啟動服務器

使用以下命令啟動服務器：

magento <magento_url> <admin_api_token>

示例：

magento https://your-magento-store.com eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...

與 MCP 客戶端集成

要將此服務器與您的 MCP 客戶端（如 Cursor）一起使用，請在客戶端設置中添加以下配置：

{
  "tools": [
    {
      "name": "mcp_magento_magento_rest_api",
      "command": "magento https://your-magento-store.com your-admin-api-token"
    }
  ]
}

這將啟用以下功能：

• 對您的 Magento 實例的 REST API 訪問
• 模式 introspection（introspection）
• 資源列表和讀取
• 常見 Magento 操作的工具執行

高級用法

magento_rest_api

向您的 Magento 實例發出 REST API 請求。 參數：

• path: API 端點路徑
• method: HTTP 方法（GET, POST, PUT, DELETE）
• body: 請求正文（JSON 字符串）
• query: 查詢參數

在 MCP 客戶端中的示例用法：

const response = await mcp.magento_rest_api({
  path: "rest/V1/orders",
  method: "GET",
  body: "",
  query: "searchCriteria[pageSize]=3&searchCriteria[currentPage]=1"
});

🔧 技術細節

開發流程

1. 克隆倉庫
2. 安裝依賴項：npm install
3. 啟動開發服務器：npm run dev
4. 進行您的更改
5. 運行測試：npm test
6. 構建生產版本：npm run build

安全注意事項

• 永遠不要提交您的 Magento 管理員令牌
• 使用環境變量存儲敏感信息
• 保持 Node.js 和 npm 版本最新
• 定期更新依賴項

📄 許可證

本項目採用 MIT 許可證。