Magento 2 MCP Server

Magento 2 MCP 服务

Magento 2 的模型上下文协议（MCP）服务实现，可通过标准化接口让 AI 助手与您的 Magento 商店交互。

功能

• 与 Magento 2 集成 REST API
• 安全处理身份验证
• 提供常见 Magento 操作的资源和工具处理程序
• 使用 TypeScript 实现，确保类型安全
• 基于官方 MCP SDK 构建

先决条件

• Node.js（v18 或更高版本）
• npm（v8 或更高版本）
• 可访问 REST API 的 Magento 2 实例
• Magento 管理员 API 访问令牌

安装

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
• 模式内省
• 资源列表和读取
• 执行常见 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