config-show
View Magento 2 system configuration values to inspect settings across different scopes like default, website, or store levels for development and troubleshooting.
Instructions
View Magento 2 system configuration values
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | Configuration path to show (optional, shows all if not specified) | |
| scope | No | Configuration scope (default, website, store) | |
| scopeId | No | Scope ID (website ID or store ID) |
Implementation Reference
- src/index.ts:740-773 (handler)Handler function for the 'config-show' tool. Constructs the magerun2 config:show command based on input parameters (path, scope, scopeId) and executes it using the shared executeMagerun2Command helper, returning formatted results or error.async ({ path, scope, scopeId }) => { let command = `magerun2 config:show`; if (path) { command += ` "${path}"`; } if (scope) { command += ` --scope="${scope}"`; } if (scopeId) { command += ` --scope-id="${scopeId}"`; } const result = await executeMagerun2Command(command); if (!result.success) { return { content: [{ type: "text", text: result.error }], isError: true }; } return { content: [{ type: "text", text: `Configuration values:\n\n${result.data}` }] }; }
- src/index.ts:725-739 (schema)Input schema for the 'config-show' tool defining optional parameters: path (config path), scope (e.g., default/website/store), and scopeId (specific ID), validated with Zod.{ title: "Config Show", description: "View Magento 2 system configuration values", inputSchema: { path: z.string() .optional() .describe("Configuration path to show (optional, shows all if not specified)"), scope: z.string() .optional() .describe("Configuration scope (default, website, store)"), scopeId: z.string() .optional() .describe("Scope ID (website ID or store ID)") } },
- src/index.ts:723-774 (registration)Registration of the 'config-show' tool on the MCP server, specifying the tool name, schema, and handler function.server.registerTool( "config-show", { title: "Config Show", description: "View Magento 2 system configuration values", inputSchema: { path: z.string() .optional() .describe("Configuration path to show (optional, shows all if not specified)"), scope: z.string() .optional() .describe("Configuration scope (default, website, store)"), scopeId: z.string() .optional() .describe("Scope ID (website ID or store ID)") } }, async ({ path, scope, scopeId }) => { let command = `magerun2 config:show`; if (path) { command += ` "${path}"`; } if (scope) { command += ` --scope="${scope}"`; } if (scopeId) { command += ` --scope-id="${scopeId}"`; } const result = await executeMagerun2Command(command); if (!result.success) { return { content: [{ type: "text", text: result.error }], isError: true }; } return { content: [{ type: "text", text: `Configuration values:\n\n${result.data}` }] }; } );
- src/index.ts:28-88 (helper)Shared helper utility used by 'config-show' (and other tools) to safely execute magerun2 commands, handle timeouts, parse JSON output, and provide Magento-specific error messages (e.g., not in Magento dir, magerun2 missing).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 }; } }