sys-cron-list
View all Magento 2 cron jobs and their configuration settings to monitor scheduled tasks and optimize system performance.
Instructions
List all Magento 2 cron jobs and their configuration
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | Output format | table |
Implementation Reference
- src/index.ts:1301-1325 (handler)The handler function that executes the 'magerun2 sys:cron:list' command with the specified format, processes the result (including JSON parsing if needed), handles errors, and returns formatted content for MCP.async ({ format = "table" }) => { const command = `magerun2 sys:cron:list --format=${format}`; const result = await executeMagerun2Command(command, format === "json"); if (!result.success) { return { content: [{ type: "text", text: result.error }], isError: true }; } const responseText = format === "json" ? `Cron job list (${format} format):\n\n${JSON.stringify(result.data, null, 2)}` : `Cron job list (${format} format):\n\n${result.data}`; return { content: [{ type: "text", text: responseText }] }; }
- src/index.ts:1295-1299 (schema)The Zod input schema defining the optional 'format' parameter for output format (table, json, csv) with default 'table'.inputSchema: { format: z.enum(["table", "json", "csv"]) .default("table") .describe("Output format") }
- src/index.ts:1290-1327 (registration)The server.registerTool call that registers the 'sys-cron-list' tool, specifying its title, description, input schema, and handler function.server.registerTool( "sys-cron-list", { title: "Cron List", description: "List all Magento 2 cron jobs and their configuration", inputSchema: { format: z.enum(["table", "json", "csv"]) .default("table") .describe("Output format") } }, async ({ format = "table" }) => { const command = `magerun2 sys:cron:list --format=${format}`; const result = await executeMagerun2Command(command, format === "json"); if (!result.success) { return { content: [{ type: "text", text: result.error }], isError: true }; } const responseText = format === "json" ? `Cron job list (${format} format):\n\n${JSON.stringify(result.data, null, 2)}` : `Cron job list (${format} format):\n\n${result.data}`; return { content: [{ type: "text", text: responseText }] }; } );
- src/index.ts:28-88 (helper)Shared helper utility function used by the handler (and other tools) to execute magerun2 commands safely with consistent error handling, timeouts, and optional JSON parsing.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 }; } }