setup-db-status
Check if Magento 2 database requires setup:upgrade by verifying current database status and identifying pending schema or data updates.
Instructions
Check Magento 2 database status to see if setup:upgrade is needed
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:1061-1089 (registration)Registration of the 'setup-db-status' MCP tool, including title, description, empty input schema, and inline handler function that runs 'magerun2 setup:db:status' command via the executeMagerun2Command helper.server.registerTool( "setup-db-status", { title: "Setup DB Status", description: "Check Magento 2 database status to see if setup:upgrade is needed", inputSchema: {} }, async () => { const command = `magerun2 setup:db:status`; const result = await executeMagerun2Command(command); if (!result.success) { return { content: [{ type: "text", text: result.error }], isError: true }; } return { content: [{ type: "text", text: `Database status:\n\n${result.data}` }] }; } );
- src/index.ts:1068-1088 (handler)The core handler function for 'setup-db-status' tool. Executes the magerun2 command, handles errors, and returns formatted text content with database status.async () => { const command = `magerun2 setup:db:status`; const result = await executeMagerun2Command(command); if (!result.success) { return { content: [{ type: "text", text: result.error }], isError: true }; } return { content: [{ type: "text", text: `Database status:\n\n${result.data}` }] }; }
- src/index.ts:28-88 (helper)Shared helper function used by 'setup-db-status' (and other tools) to execute magerun2 CLI commands with timeout, JSON parsing support, and Magento-specific error handling.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 }; } }