Magento 2 Development

FreeNot checked

Integrates with Magento 2 through n98-magerun2 to provide cache management, module operations, configuration control, database querying, and deployment tools fo

by elgentos

GitHub Embed

About

Integrates with Magento 2 through n98-magerun2 to provide cache management, module operations, configuration control, database querying, and deployment tools for streamlined e-commerce development workflows.

README

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

npx -y @elgentos/magento2-dev-mcp

Quick Start

Add to your AI agent's MCP configuration:

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

Restart your AI agent to load the MCP server
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:

Environment	Detection	Command prefix
Warden	`WARDEN_ENV_TYPE` in `.env`	`warden shell -c '...'`
DDEV	`.ddev/` directory	`ddev exec ...`
docker-magento	`bin/clinotty` file	`bin/clinotty ...`
docker-compose	`docker-compose.yml` or `compose.yaml`	`docker compose exec -T <service> ...`

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

Variable	Description	Default
`MAGERUN2_COMMAND`	Override the magerun2 binary name or path	`magerun2`

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:

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

Features

DI & Module Tools

get-di-preferences - Get Magento 2 dependency injection preferences list

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)

dev-module-list - List all Magento 2 modules and their status

Parameters:

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

dev-module-observer-list - List all Magento 2 module observers

Parameters:

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

dev-theme-list - List all available Magento 2 themes

Parameters:

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

dev-module-create - Create and register a new Magento 2 module

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:

{
  "name": "dev-module-create",
  "arguments": {
    "vendorNamespace": "MyCompany",
    "moduleName": "CustomModule",
    "addAll": true,
    "enable": true,
    "addReadme": true,
    "addComposer": true,
    "authorName": "John Doe",
    "authorEmail": "[email protected]",
    "description": "A custom Magento 2 module"
  }
}

dev-plugin-list - Get plugin (interceptor) list for a class

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:

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

Example — scan all methods of a class:

{
  "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

sys-info - Get Magento 2 system information

Parameters:

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

sys-check - Check Magento 2 system requirements and configuration

Parameters: None

Cache Management

Cache Management Tools - Complete cache management suite

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

config-show - View Magento 2 system configuration values

Parameters:

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

config-set - Set Magento 2 system configuration values

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

config-store-get / config-store-set - Store-specific configuration management tools

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

Database Tools

db-query - Execute SQL queries directly on Magento 2 database

Parameters:

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

Setup & Deployment

setup-upgrade - Run Magento 2 setup upgrade to update database schema and data

Parameters:

keepGenerated (optional): Keep generated files during upgrade

setup-di-compile - Compile Magento 2 dependency injection configuration

Parameters: None

setup-db-status - Check database status to see if setup:upgrade is needed

Parameters: None

setup-static-content-deploy - Deploy Magento 2 static content and assets

Parameters:

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

Store Management

sys-store-list - List all Magento 2 stores, websites, and store views

Parameters:

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

sys-store-config-base-url-list - List all base URLs for Magento 2 stores

Parameters:

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

sys-url-list - Get all Magento 2 URLs

Parameters:

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

sys-website-list - List all Magento 2 websites

Parameters:

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

Cron Management

sys-cron-list - List all Magento 2 cron jobs and their configuration

Parameters:

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

sys-cron-run - Run Magento 2 cron jobs

Parameters:

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

License

MIT License - see LICENSE file for details.

from github.com/elgentos/magento2-dev-mcp

Install Magento 2 Development in Claude Desktop, Claude Code & Cursor

Recommended · one command, every IDE

unyly install magento-2-development

Installs into Claude Desktop, Claude Code, Cursor & VS Code — handles npx, uvx and build-from-source repos for you.

First time? Get the CLI: curl -fsSL https://unyly.org/install | sh

Or configure manually

Run in your terminal:

claude mcp add magento-2-development -- npx -y @elgentos/magento2-dev-mcp

Step-by-step: how to install Magento 2 Development

Install Magento 2 Development in Claude Desktop Install Magento 2 Development in Claude Code Install Magento 2 Development in Cursor Install Magento 2 Development in VS Code

FAQ

Is Magento 2 Development MCP free?

Yes, Magento 2 Development MCP is free — one-click install via Unyly at no cost.

Does Magento 2 Development need an API key?

No, Magento 2 Development runs without API keys or environment variables.

Is Magento 2 Development hosted or self-hosted?

Self-hosted: the server runs locally on your machine via the install command above.

How do I install Magento 2 Development in Claude Desktop, Claude Code or Cursor?

Open Magento 2 Development on unyly.org, pick your client tab (Claude Desktop, Claude Code, Cursor) and press Install — the config is generated automatically, no JSON editing.

Related MCPs

wenb1n-dev/SmartDB_MCP

A universal database MCP server supporting simultaneous connections to multiple databases. It provides tools for database operations, health analysis, SQL optim

by wenb1n-dev

Postgres Server

This server enables interaction with PostgreSQL databases through the Model Context Protocol, optimized for the AWS Bedrock AgentCore Runtime. It provides tools

by madhurprash

Postgres

Query your database in natural language

by Anthropic

PostgreSQL

Read-only database access with schema inspection.

by modelcontextprotocol

Compare Magento 2 Development with

Magento 2 Developmentvswenb1n-dev/SmartDB_MCP Magento 2 DevelopmentvsPostgres Server Magento 2 DevelopmentvsPostgres Magento 2 DevelopmentvsPostgreSQL

Not sure what to pick?

Find your stack in 60 seconds

Author?

Embed badge for your README

Browse similar

All data MCPs

Command Palette

Magento 2 Development

About

README

Installation

Using npx

Quick Start

Docker Environment Support

Environment Variables

Features

DI & Module Tools

System Diagnostics

Cache Management

Configuration Management

Database Tools

Setup & Deployment

Store Management

Cron Management

License

Install Magento 2 Development in Claude Desktop, Claude Code & Cursor

Step-by-step: how to install Magento 2 Development

FAQ

Is Magento 2 Development MCP free?

Does Magento 2 Development need an API key?

Is Magento 2 Development hosted or self-hosted?

How do I install Magento 2 Development in Claude Desktop, Claude Code or Cursor?

Related MCPs

wenb1n-dev/SmartDB_MCP

Postgres Server

Postgres

PostgreSQL

Compare Magento 2 Development with