微信扫一扫article
README
🚀 Magento 2开发MCP服务器
这是一个专为Magento 2开发设计的模型上下文协议（MCP）服务器，可与Claude、Cursor、Continue.dev和Augment Code等AI代理集成，助力开发者更高效地进行Magento 2开发工作。
🚀 快速开始
- 添加到AI代理的MCP配置中：
{
"mcpServers": {
"magento2-dev": {
"command": "npx",
"args": ["-y", "@elgentos/magento2-dev-mcp"]
}
}
}
- 重启AI代理 以加载MCP服务器。
- 通过AI代理开始使用Magento 2开发工具！
有关特定平台的设置说明，请参阅 AI平台配置示例。
✨ 主要特性
依赖注入与模块工具
get-di-preferences - 获取Magento 2依赖注入偏好列表
参数：
scope（可选）：获取DI偏好的作用域- 选项：
global、adminhtml、frontend、crontab、webapi_rest、webapi_soap、graphql、doc、admin - 默认值：
global
- 选项：
可用作用域：
global- 全局作用域（默认）adminhtml- 管理区域frontend- 前端/店面区域crontab- 定时任务执行上下文webapi_rest- REST API上下文webapi_soap- SOAP API上下文graphql- GraphQL API上下文doc- 文档上下文admin- 管理上下文（adminhtml的替代）
dev-module-list - 列出所有Magento 2模块及其状态
参数：
format（可选）：输出格式（table、json、csv） - 默认值：tableenabled（可选）：仅显示已启用的模块disabled（可选）：仅显示已禁用的模块
dev-module-observer-list - 列出所有Magento 2模块观察者
参数：
format（可选）：输出格式（table、json、csv） - 默认值：tableevent（可选）：按特定事件名称过滤
dev-theme-list - 列出所有可用的Magento 2主题
参数：
format（可选）：输出格式（table、json、csv） - 默认值：table
dev-module-create - 创建并注册一个新的Magento 2模块
参数：
vendorNamespace（必需）：命名空间（公司前缀）moduleName（必需）：模块名称minimal（可选）：仅创建模块文件addBlocks（可选）：添加块addHelpers（可选）：添加助手addModels（可选）：添加模型addSetup（可选）：添加SQL设置addAll（可选）：添加块、助手和模型enable（可选）：创建后启用模块modman（可选）：在带有modman文件的文件夹中创建所有文件addReadme（可选）：为生成的模块添加一个readme.md文件addComposer（可选）：为生成的模块添加一个composer.json文件addStrictTypes（可选）：为生成的PHP文件添加严格类型声明authorName（可选）：readme.md或composer.json的作者authorEmail（可选）：readme.md或composer.json的作者电子邮件description（可选）：readme.md或composer.json的描述
使用示例：
{
"name": "dev-module-create",
"arguments": {
"vendorNamespace": "MyCompany",
"moduleName": "CustomModule",
"addAll": true,
"enable": true,
"addReadme": true,
"addComposer": true,
"authorName": "John Doe",
"authorEmail": "john@example.com",
"description": "A custom Magento 2 module"
}
}
系统诊断
sys-info - 获取Magento 2系统信息
参数：
format（可选）：输出格式（table、json、csv） - 默认值：table
sys-check - 检查Magento 2系统要求和配置
参数：无
缓存管理
缓存管理工具 - 完整的缓存管理套件
可用工具：
cache-clean- 清除特定或所有缓存cache-flush- 刷新特定或所有缓存cache-enable- 启用特定缓存类型cache-disable- 禁用特定缓存类型cache-status- 检查缓存状态cache-view- 检查缓存条目
有关详细信息，请参阅 缓存类型参考。
配置管理
config-show - 查看Magento 2系统配置值
参数：
path（可选）：要显示的配置路径scope（可选）：配置作用域（默认、网站、商店）scopeId（可选）：作用域ID（网站ID或商店ID）
config-set - 设置Magento 2系统配置值
参数：
path（必需）：要设置的配置路径value（必需）：要设置的值scope（可选）：配置作用域scopeId（可选）：作用域IDencrypt（可选）：加密该值
config-store-get / config-store-set - 特定商店的配置管理工具
用于在商店级别获取和设置配置值的特定商店配置管理。
数据库工具
db-query - 直接在Magento 2数据库上执行SQL查询
参数：
query（必需）：要执行的SQL查询format（可选）：输出格式（table、json、csv） - 默认值：table
设置与部署
setup-upgrade - 运行Magento 2设置升级以更新数据库架构和数据
参数：
keepGenerated（可选）：升级期间保留生成的文件
setup-di-compile - 编译Magento 2依赖注入配置
参数：无
setup-db-status - 检查数据库状态以确定是否需要运行`setup:upgrade`
参数：无
setup-static-content-deploy - 部署Magento 2静态内容和资产
参数：
languages（可选）：要部署的语言themes（可选）：要部署的主题jobs（可选）：并行作业数量force（可选）：强制部署
商店管理
sys-store-list - 列出所有Magento 2商店、网站和商店视图
参数：
format（可选）：输出格式（table、json、csv） - 默认值：table
sys-store-config-base-url-list - 列出所有Magento 2商店的基础URL
参数：
format（可选）：输出格式（table、json、csv） - 默认值：table
sys-url-list - 获取所有Magento 2 URL
参数：
format（可选）：输出格式（table、json、csv） - 默认值：tablestoreId（可选）：过滤URL的商店ID
sys-website-list - 列出所有Magento 2网站
参数：
format（可选）：输出格式（table、json、csv） - 默认值：table
定时任务管理
sys-cron-list - 列出所有Magento 2定时任务及其配置
参数：
format（可选）：输出格式（table、json、csv） - 默认值：table
sys-cron-run - 运行Magento 2定时任务
参数：
job（可选）：要运行的特定定时任务group（可选）：要运行的定时任务组
📦 安装指南
使用npx
npx -y @elgentos/magento2-dev-mcp
📄 许可证
本项目采用MIT许可证，详情请参阅 LICENSE 文件。