Abandoned - elgentos/magento2-dev-mcp

This project is abandoned since it mainly exposed magerun commands through an MCP. Magerun now offers an internal MCP server; just run magerun2 mcp:server:start - see magerun2 9.3.0 release notes.

A Model Context Protocol (MCP) server for Magento 2 development, designed to integrate with AI agents like Claude, Cursor, Continue.dev, and Augment Code.

Installation

Using npx

bashCopy code
npx -y @elgentos/magento2-dev-mcp

Quick Start

1. Add to your AI agent's MCP configuration:

jsonCopy code
{
  "mcpServers": {
    "magento2-dev": {
      "command": "npx",
      "args": ["-y", "@elgentos/magento2-dev-mcp"]
    }
  }
}

2. Restart your AI agent to load the MCP server

3. Start using Magento 2 development tools through your AI agent!

See AI Platform Configuration Examples for platform-specific setup instructions.

Docker Environment Support

The server automatically detects Docker-based Magento environments and routes magerun2 commands through the container:

For docker-compose the server tries the service names phpfpm, php-fpm, and php in order.

If Docker execution fails, the server falls back to running magerun2 locally.

Environment Variables

Use MAGERUN2_COMMAND when your system installs the binary under a different name (e.g. n98-magerun2) or when you need to specify an absolute path:

jsonCopy code
{
  "mcpServers": {
    "magento2-dev": {
      "command": "npx",
      "args": ["-y", "@elgentos/magento2-dev-mcp"],
      "env": {
        "MAGERUN2_COMMAND": "n98-magerun2"
      }
    }
  }
}

Features

DI & Module Tools

Parameters:

• scope (optional): The scope to get DI preferences for
  • Options: global, adminhtml, frontend, crontab, webapi_rest, webapi_soap, graphql, doc, admin
  • Default: global

Available Scopes:

• global - Global scope (default)
• adminhtml - Admin area
• frontend - Frontend/storefront area
• crontab - Cron job execution context
• webapi_rest - REST API context
• webapi_soap - SOAP API context
• graphql - GraphQL API context
• doc - Documentation context
• admin - Admin context (alternative to adminhtml)

Parameters:

• format (optional): Output format (table, json, csv) - Default: table
• enabled (optional): Show only enabled modules
• disabled (optional): Show only disabled modules

Parameters:

• format (optional): Output format (table, json, csv) - Default: table
• event (optional): Filter by specific event name

Parameters:

• format (optional): Output format (table, json, csv) - Default: table

Parameters:

• vendorNamespace (required): Namespace (your company prefix)
• moduleName (required): Name of your module
• minimal (optional): Create only module file
• addBlocks (optional): Add blocks
• addHelpers (optional): Add helpers
• addModels (optional): Add models
• addSetup (optional): Add SQL setup
• addAll (optional): Add blocks, helpers and models
• enable (optional): Enable module after creation
• modman (optional): Create all files in folder with a modman file
• addReadme (optional): Add a readme.md file to generated module
• addComposer (optional): Add a composer.json file to generated module
• addStrictTypes (optional): Add strict_types declaration to generated PHP files
• authorName (optional): Author for readme.md or composer.json
• authorEmail (optional): Author email for readme.md or composer.json
• description (optional): Description for readme.md or composer.json

Example Usage:

jsonCopy code
{
  "name": "dev-module-create",
  "arguments": {
    "vendorNamespace": "MyCompany",
    "moduleName": "CustomModule",
    "addAll": true,
    "enable": true,
    "addReadme": true,
    "addComposer": true,
    "authorName": "John Doe",
    "authorEmail": "john@example.com",
    "description": "A custom Magento 2 module"
  }
}

Analyzes di.xml files across all DI scopes to find plugins for a given class. Resolves the full class hierarchy (parent classes and interfaces) so inherited plugins are included. Returns the plugin list, sort order, and full execution order chain per scope.

Parameters:

• className (required): Fully qualified PHP class or interface name
• methodName (optional): Method name to inspect. Omit to scan all public methods.

Example — single method:

jsonCopy code
{
  "name": "dev-plugin-list",
  "arguments": {
    "className": "Magento\\Catalog\\Api\\ProductRepositoryInterface",
    "methodName": "save"
  }
}

Example — scan all methods of a class:

jsonCopy code
{
  "name": "dev-plugin-list",
  "arguments": {
    "className": "Magento\\Framework\\View\\LayoutInterface"
  }
}

Scopes checked: global, adminhtml, frontend, crontab, webapi_rest, webapi_soap, graphql

Docker support: Automatically detects Warden, DDEV, docker-magento, and docker-compose environments. Falls back to local PHP.

System Diagnostics

Parameters:

• format (optional): Output format (table, json, csv) - Default: table

Parameters: None

Cache Management

Available Tools:

• cache-clean - Clear specific or all caches
• cache-flush - Flush specific or all caches
• cache-enable - Enable specific cache types
• cache-disable - Disable specific cache types
• cache-status - Check cache status
• cache-view - Inspect cache entries

See Cache Types Reference for details.

Configuration Management

Parameters:

• path (optional): Configuration path to show
• scope (optional): Configuration scope (default, website, store)
• scopeId (optional): Scope ID (website ID or store ID)

Parameters:

• path (required): Configuration path to set
• value (required): Value to set
• scope (optional): Configuration scope
• scopeId (optional): Scope ID
• encrypt (optional): Encrypt the value

Store-specific configuration management for getting and setting configuration values at the store level.

Database Tools

Parameters:

• query (required): SQL query to execute
• format (optional): Output format (table, json, csv) - Default: table

Setup & Deployment

Parameters:

• keepGenerated (optional): Keep generated files during upgrade

Parameters: None

Parameters: None

Parameters:

• languages (optional): Languages to deploy
• themes (optional): Themes to deploy
• jobs (optional): Number of parallel jobs
• force (optional): Force deployment

Store Management

Parameters:

• format (optional): Output format (table, json, csv) - Default: table

Parameters:

• format (optional): Output format (table, json, csv) - Default: table

Parameters:

• format (optional): Output format (table, json, csv) - Default: table
• storeId (optional): Store ID to filter URLs

Parameters:

• format (optional): Output format (table, json, csv) - Default: table

Cron Management

Parameters:

• format (optional): Output format (table, json, csv) - Default: table

Parameters:

• job (optional): Specific cron job to run
• group (optional): Cron group to run

License

MIT License - see LICENSE file for details.