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.

Installation

Using npx (Recommended)

No installation required! Use directly with npx:

npx @elgentos/magento2-dev-mcp

Local Installation

npm install @elgentos/magento2-dev-mcp

Quick Start

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

{
  "mcpServers": {
    "magento2-dev": {
      "command": "npx",
      "args": ["@elgentos/magento2-dev-mcp"],
      "cwd": "/path/to/your/magento2/project"
    }
  }
}

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.

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:

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

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

Requirements

• Node.js 18.x or higher (required by MCP SDK)
• n98-magerun2 installed and accessible via PATH
• Valid Magento 2 installation in the working directory
• AI agent that supports MCP (Model Context Protocol)

Publishing to npm

To publish this package to npm:

1. Build the project:

   npm run build

2. Login to npm:

   npm login

3. Publish:

   npm publish --access public

Development

1. Clone and install dependencies:

   git clone https://github.com/elgentos/magento2-dev-mcp.git
   cd magento2-dev-mcp
   npm install

2. Build:

   npm run build

3. Test locally:

   npm start

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

License

MIT License - see LICENSE file for details.