Magento 2 Development MCP Server

Instructions

Implementation Reference

• src/index.ts:312-332 (handler)

  The handler function that implements the core logic of the 'cache-status' tool. It runs the 'magerun2 cache:status' command via the executeMagerun2Command helper, handles success/error cases, and returns formatted text content with the cache status.

  async () => {
    const command = `magerun2 cache:status`;
    const result = await executeMagerun2Command(command);
  
    if (!result.success) {
      return {
        content: [{
          type: "text",
          text: result.error
        }],
        isError: result.isError
      };
    }
  
    return {
      content: [{
        type: "text",
        text: `Cache status:\n\n${result.data}`
      }]
    };
  }

• src/index.ts:305-333 (registration)

  The registration of the 'cache-status' tool with the MCP server, specifying the tool name, title, description, empty input schema, and inline handler function.

  server.registerTool(
    "cache-status",
    {
      title: "Cache Status",
      description: "Check the status of Magento 2 cache types",
      inputSchema: {}
    },
    async () => {
      const command = `magerun2 cache:status`;
      const result = await executeMagerun2Command(command);
  
      if (!result.success) {
        return {
          content: [{
            type: "text",
            text: result.error
          }],
          isError: result.isError
        };
      }
  
      return {
        content: [{
          type: "text",
          text: `Cache status:\n\n${result.data}`
        }]
      };
    }
  );

• src/index.ts:28-88 (helper)

  Shared helper utility function that executes magerun2 CLI commands safely, handles timeouts, stderr, JSON parsing, and provides user-friendly error messages for missing magerun2 or non-Magento directories. Used by 'cache-status' and all other tools.

  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
      };
    }
  }