Agento MCP-Magento 2的AI驱动开发工具
使用AI驱动的工具改变您的Magento开发工作流程! 🚀
Agento MCP将模型上下文协议(MCP)的强大功能引入Magento 2,实现了与Cursor IDE、Claude和其他AI助手的无缝AI集成。执行SQL查询、管理缓存和访问100多个magerun命令——所有这些都可以通过IDE中的自然语言完成。
为什么选择Agento MCP?
- ⚡ 更快的发展:终端和IDE之间不再进行上下文切换
- 🤖 AI驱动:Magento操作的自然语言命令
- 🔧 全面的:访问SQL、缓存、magerun等
- 🎯 开发者友好:由Magento开发者为Magento开发者打造
- 📦 简易安装:适用于任何Magento 2.4+安装
- ✅ 零配置:安装后开箱即用
特性
- MCP服务器集成:支持Cursor IDE和其他AI工具的完整模型上下文协议
- SQL查询执行:直接通过AI聊天或命令行运行SQL查询
- 缓存管理:使用简单的自然语言命令清除Magento缓存
- n98-magerun2集成:通过AI访问100多个magerun命令
- Redis支持:直接通过MCP工具刷新Redis缓存
- 多种输出格式:查询结果的JSON、CSV和表格式
- 自然语言接口:使用简明英语查询管理员用户、订单、产品等
安装
选项1:通过Composer安装(推荐)
composer require genaker/agento-mcp
php bin/magento module:enable Agento_Core
php bin/magento setup:upgrade
php bin/magento cache:clean选项2:手动安装
- 克隆或下载此存储库到
app/code/Agento/Core - 启用模块:
php bin/magento module:enable Agento_Core
php bin/magento setup:upgrade
php bin/magento cache:clean步骤3:安装n98-magerun2(可选但推荐)
Agento与n98-magerun2集成,以获得其他Magento CLI工具。要安装:
cd /var/www/html/magento
curl -sS -o bin/n98-magerun2.phar https://files.magerun.net/n98-magerun2.phar
chmod +x bin/n98-magerun2.phar验证安装:
php bin/n98-magerun2.phar --version有关更多信息,请访问:https://github.com/netz98/n98-magerun2
步骤4:验证安装
检查命令是否可用:
php bin/magento list | grep agento您应该看到:
agento:query-执行SQL查询agento:cache:clear-清除缓存agento:mcp-启动MCP服务器agento:magerun:install-安装n98-magerun2agento:cursor:install-安装Cursor MCP服务器配置
您应该看到:
agento:cache:clear-清除Magento缓存agento:query-执行SQL查询agento:quick-清除缓存并运行查询agento:mcp-启动MCP服务器
用法
执行SQL查询
php bin/magento agento:query --query "SELECT * FROM admin_user LIMIT 5"具有不同的输出格式:
# Table format (default)
php bin/magento agento:query --query "SELECT * FROM admin_user LIMIT 5" --format table
# JSON format
php bin/magento agento:query --query "SELECT * FROM admin_user LIMIT 5" --format json
# CSV format
php bin/magento agento:query --query "SELECT * FROM admin_user LIMIT 5" --format csv使用不同的数据库连接:
php bin/magento agento:query --query "SELECT * FROM admin_user" --connection indexer清除缓存
# Clear all cache
php bin/magento agento:cache:clear
# Clear specific cache type
php bin/magento agento:cache:clear --type config光标集成(MCP服务器)
快速安装(推荐)
运行自动安装程序:
php bin/magento agento:cursor:install此命令将:
- 检测您的Magento安装路径
- 生成MCP服务器配置
- 尝试自动将其添加到游标设置中(如果找到游标配置)
- 将配置保存到
cursor-mcp-config.json用于手动安装
手动安装
如果自动安装不起作用,请按照以下步骤操作:
- 打开光标设置
- 引导到 特性 → 模型上下文协议
- 添加具有以下配置的新MCP服务器:
对于游标设置(JSON):
{
"mcpServers": {
"agento": {
"command": "php",
"args": [
"/var/www/html/magento/bin/magento",
"agento:mcp"
],
"cwd": "/var/www/html/magento"
}
}
}备注:调整路径(/var/www/html/magento)以匹配您的Magento安装目录。
步骤2:验证MCP服务器连接
- 添加MCP配置后重新启动Cursor
- MCP服务器应自动连接
- 您可以通过检查Cursor的MCP服务器状态进行验证
步骤3:测试MCP服务器
您可以手动测试MCP服务器:
# Start the MCP server (for testing)
php bin/magento agento:mcp服务器将在stdin/stdout上监听JSON-RPC 2.0协议消息。
可用的MCP工具
连接后,AI助手可以使用以下工具:
- execute_sql -对Magento数据库执行SQL查询
- 参数: - query (必填):要执行的SQL查询 - connection (可选):数据库连接名称(默认值:“default”)
- clear_cache -清除Magento缓存
- 参数: - type (可选):要清除的缓存类型(如果未指定,则清除所有缓存)
- 奇妙 -执行n98-magerun2命令(Magento的瑞士军刀)
- 参数: - command (必需):完整的magerun命令(例如,“db:query”、“cache:clean”、“sys:info”、“admin:user:list”) - arguments (可选):命令参数作为键值对 - options (可选):命令选项作为键值对 - 示例: - {"command": "sys:info"} -获取系统信息 - {"command": "db:query", "arguments": {"query": "SELECT * FROM admin_user LIMIT 5"}} -运行数据库查询 - {"command": "cache:clean", "options": {"type": "config"}} -清理特定缓存类型 - {"command": "admin:user:list"} -列出管理员用户
- magerun_db 数据库 -数据库操作(查询、转储、导入、信息、控制台、创建、删除、状态、变量)
- 参数: - command (必填):查询、转储、导入、信息、控制台、创建、删除、状态、变量之一 - arguments (可选):命令特定参数
- magerun_cache -缓存操作(清理、刷新、启用、禁用、列表、状态、查看、报告)
- 参数: - command (必填):其中之一:清除、刷新、启用、禁用、列表、状态、视图、报告 - arguments (可选):命令特定参数(例如。, {"type": "config"} 清洁)
- Magerun管理员 -管理员用户管理(列表、创建、更改密码、删除、激活、停用、解锁)
- 参数: - command (必填):其中之一:用户:列表,用户:创建,用户:更改密码,用户:删除,用户:激活,用户:停用,用户:解锁,令牌:创建 - arguments (可选):命令特定参数
- magerun_sys -系统信息(信息、检查、存储:列表、网站:列表、url:列表、cron:列表、cron:运行)
- 参数: - command (必填):以下选项之一:信息、检查、存储:列表、网站:列表、url:列表、cron:列表、cron:运行、维护 - arguments (可选):命令特定参数
- magerun-config -配置管理(store:get、store:set、env:set、搜索、显示)
- 参数: - command (必需):其中之一:store:get,store:set,env:set,搜索,显示,show:url,show:默认url,show:store url - arguments (可选):命令特定参数(例如。, {"path": "web/unsecure/base_url"} 对于商店:get)
- 马格伦_客户 -客户管理(列表、创建、信息、删除、更改密码、添加地址)
- 参数: - command (必填):列表、创建、信息、删除、更改密码、添加地址、令牌之一:创建 - arguments (可选):命令特定参数
- 磁力索引器 -索引器操作(重新索引、重置、状态、设置模式、显示模式、信息)
- 参数: - command (必填):其中之一:重新索引、重置、状态、设置模式、显示模式、信息、设置状态 - arguments (可选):命令特定参数
- magerun_模块 -模块管理(启用、禁用、状态、卸载)
- 参数: - command (必填):启用、禁用、状态、卸载之一 - arguments (可选):命令特定参数(例如。, {"module": "Magento_Catalog"})
- magerun_setute -安装操作(升级、安装、db:status、di:compile、静态内容:部署)
- 参数: - command (必需):其中之一:升级、安装、db:status、di:compile、静态内容:部署、备份、回滚、卸载 - arguments (可选):命令特定参数
备注:有关所有可用magerun命令的完整列表,请访问:https://github.com/netz98/n98-magerun2/tree/develop/docs/docs/command-docs
测试安装
测试1:验证命令是否可用
php bin/magento list | grep agento预期产量:
agento:cache:clear Clear Magento cache
agento:mcp Start Agento MCP server for AI integration
agento:query Execute SQL query against Magento database
agento:quick Clear cache and execute SQL query in one command测试2:测试SQL查询命令
php bin/magento agento:query --query "SELECT VERSION() as mysql_version"预期产量:
+-------------------------+
| mysql_version |
+-------------------------+
| 8.0.42-0ubuntu0.24.04.2 |
+-------------------------+
Rows returned: 1 | Execution time: X.XXms测试3:测试缓存清除命令
php bin/magento agento:cache:clear预期:应显示正在清除的缓存类型。
测试4:测试快速命令
php bin/magento agento:quick --query "SELECT COUNT(*) as total FROM admin_user"预期:应显示:
- “正在清除缓存…”消息
- "✓ 所有缓存已清除“或”✓ 已清除缓存类型:X“
- “正在执行查询…”消息
- 表格式的查询结果
- 行数和执行时间
测试5:测试MCP服务器(手动)
创建测试文件 test_mcp.json:
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/list"
}然后测试:
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | php bin/magento agento:mcp预期:应使用可用工具返回JSON响应。
故障排除
未找到命令
如果命令不可用:
php bin/magento module:enable Agento_Core
php bin/magento setup:upgrade
php bin/magento cache:cleanMCP服务器未连接
- 验证路径
bin/magento光标设置正确 - 确保PHP在您的系统PATH中
- 检查Cursor的MCP服务器日志是否有错误
- 使用上述测试手动测试MCP服务器
数据库连接错误
确保您的 app/etc/env.php 具有正确的数据库凭据:
'db' => [
'connection' => [
'default' => [
'host' => '127.0.0.1',
'dbname' => 'magento',
'username' => 'magento',
'password' => 'magento'
]
]
]示例
示例1:获取所有管理员用户
php bin/magento agento:query --query "SELECT user_id, username, email, is_active FROM admin_user"示例2:按状态获取产品计数
php bin/magento agento:query --query "SELECT status, COUNT(*) as count FROM catalog_product_entity GROUP BY status"示例4:将数据导出为JSON
php bin/magento agento:query --query "SELECT * FROM admin_user LIMIT 5" --format json > users.json示例5:使用n98-magerun2命令
您也可以直接使用n98-magerun2命令:
# Get system information
php bin/n98-magerun2.phar sys:info
# Run database query
php bin/n98-magerun2.phar db:query "SELECT * FROM admin_user LIMIT 5"
# List admin users
php bin/n98-magerun2.phar admin:user:list
# Clean cache
php bin/n98-magerun2.phar cache:clean
# Get store list
php bin/n98-magerun2.phar sys:store:list备注:这些命令也可通过MCP服务器用于Cursor中的AI助手。
需求
- Magento 2.4.x 版本
- PHP 7.4或更高版本
- MySQL/MariaDB数据库
许可证
本模块按原样提供,用于开发目的。
测试
独立测试可以将命令作为独立进程运行(模拟Cursor/MCP如何调用它们):
# Run all tests
php app/code/Agento/Core/tests/run-standalone-tests.php看 tests/README.md 了解更多详情。
非常适合
- Magento开发者 使用Cursor IDE或其他AI编码助手
- 开发团队 希望简化工作流程
- 开发者 探索人工智能辅助编码
- 任何管理Magento商店的人 谁想要更快地访问数据和操作
真实世界的例子
设置后,您可以在Cursor中使用自然语言命令:
- “显示所有活动管理员用户”
- “最后的命令是什么?”
- “清除配置缓存”
- “我们有多少客户?”
- “列出所有Magento商店”
- “获得最多订单的客户”
AI将自动使用适当的MCP工具来执行这些请求!
支持
有关问题或疑问,请查看:
贡献
欢迎投稿!请随时提交拉取请求。
许可证
MIT许可证-有关详细信息,请参阅许可证文件
内置于❤️ 为Magento社区。
