管理员Magento MCP服务器
一个全面的模型上下文协议(MCP)服务器,提供AI助手和Warden+Magento 2开发环境之间的无缝集成。该服务器使AI助手能够直接与您的管理员管理的Magento项目进行交互,自动化常见的开发任务,并为复杂的工作流程提供智能协助。
特性
此MCP服务器通过提供以下功能,将您的AI助手转变为Warden+Magento 2项目的强大开发伙伴:
- 🚀 项目初始化:使用可定制的Magento 2环境创建新的Warden项目
- 🔧 环境管理:通过智能状态管理启动/停止项目和服务
- 🗄️ 数据库操作:直接在容器化数据库中执行SQL查询
- 🐘 开发工具:在正确配置的容器化环境中运行PHP脚本
- 🛠️ Magento CLI集成:在容器内无缝执行Magento命令
- 🧪 单元测试支持:运行带有自动配置检测的PHPUnit测试
- 📦 作曲家集成:使用完整的命令支持管理容器内的依赖关系
- 📊 环境监测:列出并监控正在运行的Warden环境
安装
- 克隆或下载此存储库
- 安装依赖项:
npm install- 配置您的MCP客户端(请参阅下面的配置部分)
配置
MCP客户端配置
将以下配置添加到MCP客户端设置中:
{
"mcpServers": {
"warden-magento": {
"command": "node",
"args": ["/absolute/path/to/warden-mcp-server/server.js"],
"env": {}
}
}
}重要:替换 /absolute/path/to/warden-mcp-server/server.js 使用系统上server.js文件的实际绝对路径。
适用于克劳德桌面
添加到您的 claude_desktop_config.json:
{
"mcpServers": {
"warden-magento": {
"command": "node",
"args": ["/Users/your-username/path/to/warden-mcp-server/server.js"]
}
}
}Zed编辑
添加到Zed设置中:
{
"assistant": {
"version": "2",
"provider": {
"name": "anthropic",
"model": "claude-3-5-sonnet-20241022"
}
},
"context_servers": {
"warden-magento": {
"command": "node",
"args": ["/Users/your-username/path/to/warden-mcp-server/server.js"]
}
}
}用法
配置后,您的AI助手可以自动使用这些工具来帮助完成Warden+Magento开发任务。只需描述你想完成什么,人工智能就会使用适当的工具。
可用工具
环境管理
warden_list_environments
列出所有正在运行的Warden环境及其目录和状态信息。
参数: 无
使用案例:
- 检查当前正在运行的环境
- 获取其他操作的项目路径
- 监控环境状态
______________________________________________________________________
warden_start_project
启动Warden项目环境,打开所有已配置的容器。
参数:
project_path(必填):项目目录的路径
使用案例:
- 启动开发环境
- 恢复项目工作
- 系统重启后启动服务
______________________________________________________________________
warden_stop_project
停止Warden项目环境,关闭所有项目容器。
参数:
project_path(必填):项目目录的路径
使用案例:
- 开发环境彻底关闭
- 释放系统资源
- 为系统维护做好准备
______________________________________________________________________
warden_start_svc
启动Warden系统服务(DNS、代理等共享基础设施)。
参数:
project_path(必填):项目目录的路径
使用案例:
- 初始化管理员基础设施
- 系统重新启动后启动共享服务
- 为项目启动准备环境
______________________________________________________________________
warden_stop_svc
停止管理员系统服务。
参数:
project_path(必填):项目目录的路径
使用案例:
- 彻底关闭Warden基础设施
- 解决服务冲突
- 系统维护
______________________________________________________________________
项目初始化
warden_init_project
使用完全配置的Magento 2环境初始化新的Warden项目。
参数:
project_path(必填):项目应初始化的路径project_name(必填):管理员环境名称environment_type(可选):环境类型(默认值:“magento 2”)php_version(可选):PHP版本(默认:“8.3”)mysql_distribution(可选):MySQL发行版(默认:“mariadb”)mysql_version(可选):MySQL版本(默认:“10.6”)node_version(可选):Node.js版本(默认:“20”)composer_version(可选):编辑器版本(默认值:“2”)opensearch_version(可选):OpenSearch版本(默认:“2.12”)redis_version(可选):Redis版本(默认:“7.2”)enable_redis(可选):启用Redis(默认值:true)enable_opensearch(可选):启用OpenSearch(默认值:true)enable_varnish(可选):启用清漆(默认值:true)enable_rabbitmq(可选):启用RabbitMQ(默认值:true)enable_xdebug(可选):启用Xdebug(默认值:true)
使用案例:
- 设置新的Magento 2开发环境
- 使用特定的PHP/MySQL版本创建项目
- 根据特定要求配置环境
- 使用自定义服务堆栈初始化项目
______________________________________________________________________
数据库操作
warden_db_query
直接在Warden数据库容器中执行SQL查询。
参数:
project_path(必填):项目目录的路径query(必填):要执行的SQL查询database(可选):数据库名称(默认:“magento”)
使用案例:
- 执行数据库查询以进行调试
- 检索数据进行分析
- 执行数据库维护任务
- 检查数据库架构或数据
______________________________________________________________________
PHP开发
warden_php_script
在PHP-fpm容器中运行PHP脚本,并进行适当的环境设置。
参数:
project_path(必填):项目目录的路径script_path(必填):PHP脚本相对于项目根的路径args(可选):传递给脚本的其他参数
使用案例:
- 执行自定义PHP脚本
- 运行数据迁移脚本
- 测试PHP功能
- 执行维护脚本
______________________________________________________________________
Magento命令行界面
warden_magento_cli
在php-fpm容器内执行Magento CLI命令。
参数:
project_path(必填):项目目录的路径command(必需):Magento CLI命令(不带“bin/Magento”前缀)args(可选):命令的其他参数
使用案例:
- 运行缓存操作(缓存:清除,缓存:刷新)
- 执行安装命令(setup:upgrade,setup:di:compile)
- 管理配置(配置:set,配置:show)
- 运行索引操作(索引器:reindex)
- 模块管理(模块:启用,模块:禁用)
______________________________________________________________________
测试
warden_run_unit_tests
在php-fpm容器内运行PHPUnit测试,并自动检测配置。
参数:
project_path(必填):项目目录的路径config_file(可选):PHPUnit配置文件(自动检测PHPUnit.xml.dist或PHPUnit.xml)test_path(可选):特定测试文件或目录的路径extra_args(可选):其他PHPUnit参数
使用案例:
- 对模块运行单元测试
- 执行特定的测试套件
- 使用自定义配置运行测试
- 通过自动化测试验证代码更改
______________________________________________________________________
依赖管理
warden_composer
在php-fpm容器内执行Composer命令。
参数:
project_path(必填):项目目录的路径command(必需):要执行的Composer命令
常用命令:
install-安装依赖项update-更新依赖关系require package/name-添加新的依赖关系remove package/name-删除依赖关系require-commerce-安装Adobe Commerce(如适用)dump-autoload-重新生成自动加载器
使用案例:
- 安装项目依赖项
- 向项目添加新包
- 更新现有依赖关系
- 管理自动加载
- 安装Adobe Commerce组件
______________________________________________________________________
先决条件
- 守望者:必须在您的系统上安装和配置
- 码头工人:监狱长履行职责所必需的
- Node.js:18.0.0或更高版本
- MCP客户端:兼容的MCP客户端(Claude Desktop、Zed等)
故障排除
对于此MCP服务器特有的问题,请检查:
- 运行时的服务器日志
npm start - MCP客户端记录连接问题
- Docker容器日志:
warden env logs - MCP服务器检查器:https://github.com/modelcontextprotocol/inspector
许可证
MIT许可证-有关详细信息,请参阅许可证文件
贡献
欢迎投稿!请随时提交问题和拉取请求。
