Magento 2 Development MCP Server

Instructions

Implementation Reference

• src/index.ts:696-716 (handler)

  The handler function that executes the 'magerun2 sys:check' command using the executeMagerun2Command helper, processes the result, handles errors, and returns formatted text content.
  const command = `magerun2 sys:check`; const result = await executeMagerun2Command(command); if (!result.success) { return { content: [{ type: "text", text: result.error }], isError: true }; } return { content: [{ type: "text", text: `System check results:\n\n${result.data}` }] }; } );
• src/index.ts:690-694 (schema)

  Input/output schema for the sys-check tool: title, description, and empty inputSchema indicating no parameters are required.
  { title: "System Check", description: "Check Magento 2 system requirements and configuration", inputSchema: {} },
• src/index.ts:689-717 (registration)

  Registration of the sys-check tool with McpServer using server.registerTool, including name, schema, and handler function.
  "sys-check", { title: "System Check", description: "Check Magento 2 system requirements and configuration", inputSchema: {} }, async () => { const command = `magerun2 sys:check`; const result = await executeMagerun2Command(command); if (!result.success) { return { content: [{ type: "text", text: result.error }], isError: true }; } return { content: [{ type: "text", text: `System check results:\n\n${result.data}` }] }; } );
• src/index.ts:27-88 (helper)

  Shared utility function used by sys-check (and other tools) to safely execute magerun2 commands, handle timeouts, parse JSON output, and provide Magento-specific error messages.
  */ async function executeMagerun2Command(command: string, parseJson: boolean = false): Promise<{ success: true; data: any; rawOutput: string; } | { success: false; error: string; isError: true; }> { try { const { stdout, stderr } = await execAsync(command, { cwd: process.cwd(), timeout: 30000 // 30 second timeout }); if (stderr && stderr.trim()) { console.error("magerun2 stderr:", stderr); } if (parseJson) { try { return { success: true, data: JSON.parse(stdout), rawOutput: stdout }; } catch (parseError) { return { success: false, error: `Error parsing magerun2 JSON output: ${parseError}\n\nRaw output:\n${stdout}`, isError: true }; } } return { success: true, data: stdout.trim(), rawOutput: stdout }; } catch (error) { const errorMessage = error instanceof Error ? error.message : String(error); // Check if magerun2 is not found if (errorMessage.includes("command not found") || errorMessage.includes("not recognized")) { return { success: false, error: "Error: magerun2 command not found. Please ensure n98-magerun2 is installed and available in your PATH.\n\nInstallation instructions: https://github.com/netz98/n98-magerun2", isError: true }; } // Check if not in Magento directory if (errorMessage.includes("not a Magento installation") || errorMessage.includes("app/etc/env.php")) { return { success: false, error: "Error: Current directory does not appear to be a Magento 2 installation. Please run this command from your Magento 2 root directory.", isError: true }; } return { success: false, error: `Error executing magerun2 command: ${errorMessage}`, isError: true }; } }