icon for mcp server

Magento 2 Development

STDIO

MCP server for Magento 2 development with AI agents integration

Magento 2 Development MCP Server

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

image

Installation

Using npx

npx -y @elgentos/magento2-dev-mcp

Quick Start

  1. Add to your AI agent's MCP configuration:
{
  "mcpServers": {
    "magento2-dev": {
      "command": "npx",
      "args": ["-y", "@elgentos/magento2-dev-mcp"]
    }
  }
}

  1. Restart your AI agent to load the MCP server

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

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

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

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.

Be the First to Experience MCP Now