使用说明

项目简介

Magento 2 MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在将 Magento 2 电商平台的功能以标准化的方式暴露给 AI 助手等 MCP 客户端。它允许 AI 助手安全、可控地访问 Magento 2 的数据和执行特定操作，从而实现更智能的电商应用集成。

主要功能点

Magento 2 REST API 桥梁: 作为 MCP 服务器，核心功能是连接 MCP 客户端和 Magento 2 REST API。
资源管理: 提供 Magento REST API Schema 资源，允许 AI 助手了解 Magento API 的结构。
工具执行: 支持 'magento_rest_api' 工具，允许 AI 助手调用 Magento 2 的 REST API 接口，执行各种操作（如查询订单、商品信息等）。
基于 MCP SDK: 使用官方 MCP SDK 构建，确保符合 MCP 协议标准。
Stdio 传输: 通过标准输入输出 (Stdio) 与 MCP 客户端通信。

安装步骤

安装 Node.js 和 npm: 确保你的环境中已安装 Node.js (v18 或更高版本) 和 npm (v8 或更高版本)。

安装 Magento 2 MCP Server: 在你的项目目录中，运行以下 npm 命令安装该服务器：

npm install vasileuski/magento2-mcp-server

服务器配置

为了让 MCP 客户端（如 Cursor）连接到 Magento 2 MCP Server，你需要在客户端的配置中添加工具 (tools) 信息。以下是一个典型的 JSON 配置示例，你需要根据你的 Magento 2 实例信息进行调整：

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

配置参数说明:

'tools': 配置工具列表。
- 'name': 工具的唯一名称，客户端使用此名称来引用该工具，可以自定义，例如 'mcp_magento_rest_api'。
- 'command': 启动 MCP 服务器的可执行命令，这里填写 'magento'，它会调用安装的 'magento2-mcp-server' 包提供的可执行文件。
- 'args': 传递给 'command' 的参数数组。
  - 'https://your-magento-store.com': 你的 Magento 2 商店的 URL 地址，请替换为你的实际地址。
  - 'your-admin-api-token': Magento 2 管理员 API 访问令牌，用于服务器鉴权，请替换为你的实际令牌。 请务必妥善保管 API 令牌，避免泄露。

注意: MCP 客户端会根据你提供的 'command' 和 'args' 启动 Magento 2 MCP Server 进程，并与之建立连接。

基本使用方法

启动 MCP 服务器 (由 MCP 客户端自动完成): 当 MCP 客户端需要使用 Magento 2 功能时，会根据配置自动启动 'magento' 命令，并传入你在 'args' 中配置的 Magento URL 和 API 令牌。
通过 MCP 客户端调用工具: 在 MCP 客户端中，你可以调用名为 'magento_rest_api' 的工具来与 Magento 2 REST API 交互。你需要提供以下参数：
- 'path': 要调用的 REST API 路径，以 '/rest' 开头。
- '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"
});
```
服务器会将请求转发到 Magento 2 REST API，并将响应返回给 MCP 客户端。

安全提示: 请务必注意保护你的 Magento 2 管理员 API 令牌安全，避免硬编码在代码或配置文件中，推荐使用环境变量等更安全的方式管理敏感信息。

关键词