🚀 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 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"
});
🔧 技术细节
开发流程
- 克隆仓库
- 安装依赖项：
npm install - 启动开发服务器：
npm run dev - 进行您的更改
- 运行测试：
npm test - 构建生产版本：
npm run build
安全注意事项
- 永远不要提交您的 Magento 管理员令牌
- 使用环境变量存储敏感信息
- 保持 Node.js 和 npm 版本最新
- 定期更新依赖项
📄 许可证
本项目采用 MIT 许可证。