{"_id":"@elgentos/magento2-dev-mcp","_rev":"3-7f41a5236bda69f65e2bb8cbde9d225f","name":"@elgentos/magento2-dev-mcp","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@elgentos/magento2-dev-mcp","version":"1.0.0","keywords":["magento2","mcp","model-context-protocol","development","ai","agent","magerun","cache","modules","cli"],"author":{"name":"Elgentos","email":"info@elgentos.nl"},"license":"MIT","_id":"@elgentos/magento2-dev-mcp@1.0.0","maintainers":[{"name":"elgentos","email":"developer@elgentos.nl"}],"homepage":"https://github.com/elgentos/magento2-dev-mcp#readme","bugs":{"url":"https://github.com/elgentos/magento2-dev-mcp/issues"},"bin":{"magento2-dev-mcp":"dist/cli.js"},"dist":{"shasum":"be60a9445f6bddba6a58e8a3a3a662bd57797c7f","tarball":"https://registry.npmjs.org/@elgentos/magento2-dev-mcp/-/magento2-dev-mcp-1.0.0.tgz","fileCount":15,"integrity":"sha512-spt/SHwh378PacdRrN3VLSNzupIQQWjGyNpJbQptCz1VXueBGezFTB1qNnTDBLnkb7JhXi7MsD01nzj9hEhv4Q==","signatures":[{"sig":"MEUCIQCTegBftWd0PxqfiQvIu/koy/k4xQ9GViZDgEJMT1HXpAIgJfPv9Ngbwq8ZeJV+ha3JHlh4LIajS6eAGAFWb16R6MA=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":96919},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18.0.0"},"gitHead":"e9b17a447533ff19b5af37bfdbd6c81adc1da62b","scripts":{"dev":"tsc && node dist/index.js","test":"echo \"No tests specified\" && exit 0","build":"tsc","start":"node dist/index.js","watch":"tsc --watch","prepublishOnly":"npm run build"},"_npmUser":{"name":"elgentos","email":"developer@elgentos.nl"},"repository":{"url":"git+https://github.com/elgentos/magento2-dev-mcp.git","type":"git"},"_npmVersion":"10.5.0","description":"Magento 2 Development MCP Server for AI agents - provides cache management, module tools, and system diagnostics","directories":{},"_nodeVersion":"20.12.2","dependencies":{"zod":"^3.23.8","@modelcontextprotocol/sdk":"^1.18.2"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.0.0","@types/node":"^20.0.0"},"peerDependencies":{"n98-magerun2":"*"},"peerDependenciesMeta":{"n98-magerun2":{"optional":false}},"_npmOperationalInternal":{"tmp":"tmp/magento2-dev-mcp_1.0.0_1759084752368_0.22333519746913488","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@elgentos/magento2-dev-mcp","version":"1.0.1","keywords":["magento2","mcp","model-context-protocol","development","ai","agent","magerun","cache","modules","cli"],"author":{"name":"Elgentos","email":"info@elgentos.nl"},"license":"MIT","_id":"@elgentos/magento2-dev-mcp@1.0.1","maintainers":[{"name":"elgentos","email":"developer@elgentos.nl"}],"homepage":"https://github.com/elgentos/magento2-dev-mcp#readme","bugs":{"url":"https://github.com/elgentos/magento2-dev-mcp/issues"},"bin":{"magento2-dev-mcp":"dist/cli.js"},"dist":{"shasum":"8b2f171d0a3773ec6dbd1bf39292ba5f7d2a73e0","tarball":"https://registry.npmjs.org/@elgentos/magento2-dev-mcp/-/magento2-dev-mcp-1.0.1.tgz","fileCount":19,"integrity":"sha512-iLuPlSZCZu5IPfyN9fQKJEVI6LezqrURQyiEPsnaOn98ckeTXtUeGfRGmMhlkyPkmrv/8lRX9KM9mPuq4YOBHg==","signatures":[{"sig":"MEUCIHSeBb618KCD+QqqoxDiZBVOaPDbTP2oFN30/2brkPFRAiEA0bhn5f9JZICngVdAuUrQUcm7/KZqz0CeEyDL/j+KIhc=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":100510},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18.0.0"},"gitHead":"8b2d0dfb627a9de36fd18c5c6cede5aa54839f87","scripts":{"dev":"tsc && node dist/index.js","test":"echo \"No tests specified\" && exit 0","build":"tsc","start":"node dist/index.js","watch":"tsc --watch","prepublishOnly":"npm run build"},"_npmUser":{"name":"elgentos","email":"developer@elgentos.nl"},"repository":{"url":"git+https://github.com/elgentos/magento2-dev-mcp.git","type":"git"},"_npmVersion":"10.5.0","description":"Magento 2 Development MCP Server for AI agents - provides cache management, module tools, and system diagnostics","directories":{},"_nodeVersion":"20.12.2","dependencies":{"zod":"^3.23.8","@modelcontextprotocol/sdk":"^1.18.2"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.0.0","@types/node":"^20.0.0"},"peerDependencies":{"n98-magerun2":"*"},"peerDependenciesMeta":{"n98-magerun2":{"optional":false}},"_npmOperationalInternal":{"tmp":"tmp/magento2-dev-mcp_1.0.1_1759085824396_0.13343594730957475","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@elgentos/magento2-dev-mcp","version":"1.0.2","description":"Magento 2 Development MCP Server for AI agents - provides cache management, module tools, and system diagnostics","main":"dist/index.js","type":"module","bin":{"magento2-dev-mcp":"dist/cli.js"},"scripts":{"build":"tsc","start":"node dist/index.js","dev":"tsc && node dist/index.js","watch":"tsc --watch","prepublishOnly":"npm run build","test":"echo \"No tests specified\" && exit 0"},"keywords":["magento2","mcp","model-context-protocol","development","ai","agent","magerun","cache","modules","cli"],"author":{"name":"Elgentos","email":"info@elgentos.nl"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/elgentos/magento2-dev-mcp.git"},"homepage":"https://github.com/elgentos/magento2-dev-mcp#readme","bugs":{"url":"https://github.com/elgentos/magento2-dev-mcp/issues"},"dependencies":{"@modelcontextprotocol/sdk":"^1.18.2","zod":"^3.23.8"},"devDependencies":{"@types/node":"^20.0.0","typescript":"^5.0.0"},"engines":{"node":">=18.0.0"},"_id":"@elgentos/magento2-dev-mcp@1.0.2","gitHead":"8b2d0dfb627a9de36fd18c5c6cede5aa54839f87","types":"./dist/index.d.ts","_nodeVersion":"20.12.2","_npmVersion":"10.5.0","dist":{"integrity":"sha512-/zXkpFplK1aZGnsJhEn0YnHoZFrsynmyz44VKXznJrrhJJR9D3TYnc1kGYIVN4emztaEarFTA0n+ki8OxwzMdQ==","shasum":"9ec1ec3546a30dc8d2690b67d21044f7ddc1477e","tarball":"https://registry.npmjs.org/@elgentos/magento2-dev-mcp/-/magento2-dev-mcp-1.0.2.tgz","fileCount":15,"unpackedSize":97612,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCICXwhZyY6eD8Ag6kRc7/Vu/XsjAT0gAELdEXNCCePSFrAiEA/n2aMmAihcICoHTBNTB/zdAxdQkypQVb/X7D1L2nL7Q="}]},"_npmUser":{"name":"elgentos","email":"developer@elgentos.nl"},"directories":{},"maintainers":[{"name":"elgentos","email":"developer@elgentos.nl"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/magento2-dev-mcp_1.0.2_1759085997081_0.3521026804598566"},"_hasShrinkwrap":false}},"time":{"created":"2025-09-28T18:39:12.268Z","modified":"2025-09-28T18:59:57.471Z","1.0.0":"2025-09-28T18:39:12.548Z","1.0.1":"2025-09-28T18:57:04.583Z","1.0.2":"2025-09-28T18:59:57.267Z"},"bugs":{"url":"https://github.com/elgentos/magento2-dev-mcp/issues"},"author":{"name":"Elgentos","email":"info@elgentos.nl"},"license":"MIT","homepage":"https://github.com/elgentos/magento2-dev-mcp#readme","keywords":["magento2","mcp","model-context-protocol","development","ai","agent","magerun","cache","modules","cli"],"repository":{"type":"git","url":"git+https://github.com/elgentos/magento2-dev-mcp.git"},"description":"Magento 2 Development MCP Server for AI agents - provides cache management, module tools, and system diagnostics","maintainers":[{"name":"elgentos","email":"developer@elgentos.nl"}],"readme":"# Magento 2 Development MCP Server\n\nA Model Context Protocol (MCP) server for Magento 2 development, designed to integrate with AI agents like Claude, Cursor, Continue.dev, and Augment Code.\n\n## Installation\n\n### Using npx (Recommended)\n\nNo installation required! Use directly with npx:\n\n```bash\nnpx @elgentos/magento2-dev-mcp\n```\n\n### Local Installation\n\n```bash\nnpm install @elgentos/magento2-dev-mcp\n```\n\n## Quick Start\n\n1. **Add to your AI agent's MCP configuration:**\n\n```json\n{\n  \"mcpServers\": {\n    \"magento2-dev\": {\n      \"command\": \"npx\",\n      \"args\": [\"@elgentos/magento2-dev-mcp\"],\n      \"cwd\": \"/path/to/your/magento2/project\"\n    }\n  }\n}\n```\n\n2. **Restart your AI agent** to load the MCP server\n\n3. **Start using Magento 2 development tools** through your AI agent!\n\nSee [AI Platform Configuration Examples](examples/ai-platform-configs.md) for platform-specific setup instructions.\n\n## Features\n\n<img width=\"690\" height=\"705\" alt=\"image\" src=\"https://github.com/user-attachments/assets/491e4f5d-d145-46b7-a509-56982508199a\" />\n\n## DI & Module Tools\n\n<details>\n<summary><strong>get-di-preferences</strong> - Get Magento 2 dependency injection preferences list</summary>\n\n**Parameters:**\n- `scope` (optional): The scope to get DI preferences for\n  - Options: `global`, `adminhtml`, `frontend`, `crontab`, `webapi_rest`, `webapi_soap`, `graphql`, `doc`, `admin`\n  - Default: `global`\n\n**Available Scopes:**\n- `global` - Global scope (default)\n- `adminhtml` - Admin area\n- `frontend` - Frontend/storefront area\n- `crontab` - Cron job execution context\n- `webapi_rest` - REST API context\n- `webapi_soap` - SOAP API context\n- `graphql` - GraphQL API context\n- `doc` - Documentation context\n- `admin` - Admin context (alternative to adminhtml)\n\n</details>\n\n<details>\n<summary><strong>dev-module-list</strong> - List all Magento 2 modules and their status</summary>\n\n**Parameters:**\n- `format` (optional): Output format (`table`, `json`, `csv`) - Default: `table`\n- `enabled` (optional): Show only enabled modules\n- `disabled` (optional): Show only disabled modules\n\n</details>\n\n<details>\n<summary><strong>dev-module-observer-list</strong> - List all Magento 2 module observers</summary>\n\n**Parameters:**\n- `format` (optional): Output format (`table`, `json`, `csv`) - Default: `table`\n- `event` (optional): Filter by specific event name\n\n</details>\n\n<details>\n<summary><strong>dev-theme-list</strong> - List all available Magento 2 themes</summary>\n\n**Parameters:**\n- `format` (optional): Output format (`table`, `json`, `csv`) - Default: `table`\n\n</details>\n\n<details>\n<summary><strong>dev-module-create</strong> - Create and register a new Magento 2 module</summary>\n\n**Parameters:**\n- `vendorNamespace` (required): Namespace (your company prefix)\n- `moduleName` (required): Name of your module\n- `minimal` (optional): Create only module file\n- `addBlocks` (optional): Add blocks\n- `addHelpers` (optional): Add helpers\n- `addModels` (optional): Add models\n- `addSetup` (optional): Add SQL setup\n- `addAll` (optional): Add blocks, helpers and models\n- `enable` (optional): Enable module after creation\n- `modman` (optional): Create all files in folder with a modman file\n- `addReadme` (optional): Add a readme.md file to generated module\n- `addComposer` (optional): Add a composer.json file to generated module\n- `addStrictTypes` (optional): Add strict_types declaration to generated PHP files\n- `authorName` (optional): Author for readme.md or composer.json\n- `authorEmail` (optional): Author email for readme.md or composer.json\n- `description` (optional): Description for readme.md or composer.json\n\n**Example Usage:**\n```json\n{\n  \"name\": \"dev-module-create\",\n  \"arguments\": {\n    \"vendorNamespace\": \"MyCompany\",\n    \"moduleName\": \"CustomModule\",\n    \"addAll\": true,\n    \"enable\": true,\n    \"addReadme\": true,\n    \"addComposer\": true,\n    \"authorName\": \"John Doe\",\n    \"authorEmail\": \"john@example.com\",\n    \"description\": \"A custom Magento 2 module\"\n  }\n}\n```\n\n</details>\n\n## System Diagnostics\n\n<details>\n<summary><strong>sys-info</strong> - Get Magento 2 system information</summary>\n\n**Parameters:**\n- `format` (optional): Output format (`table`, `json`, `csv`) - Default: `table`\n\n</details>\n\n<details>\n<summary><strong>sys-check</strong> - Check Magento 2 system requirements and configuration</summary>\n\n**Parameters:** None\n\n</details>\n\n## Cache Management\n\n<details>\n<summary><strong>Cache Management Tools</strong> - Complete cache management suite</summary>\n\n**Available Tools:**\n- `cache-clean` - Clear specific or all caches\n- `cache-flush` - Flush specific or all caches\n- `cache-enable` - Enable specific cache types\n- `cache-disable` - Disable specific cache types\n- `cache-status` - Check cache status\n- `cache-view` - Inspect cache entries\n\nSee [Cache Types Reference](docs/cache-types.md) for details.\n\n</details>\n\n## Configuration Management\n\n<details>\n<summary><strong>config-show</strong> - View Magento 2 system configuration values</summary>\n\n**Parameters:**\n- `path` (optional): Configuration path to show\n- `scope` (optional): Configuration scope (default, website, store)\n- `scopeId` (optional): Scope ID (website ID or store ID)\n\n</details>\n\n<details>\n<summary><strong>config-set</strong> - Set Magento 2 system configuration values</summary>\n\n**Parameters:**\n- `path` (required): Configuration path to set\n- `value` (required): Value to set\n- `scope` (optional): Configuration scope\n- `scopeId` (optional): Scope ID\n- `encrypt` (optional): Encrypt the value\n\n</details>\n\n<details>\n<summary><strong>config-store-get / config-store-set</strong> - Store-specific configuration management tools</summary>\n\nStore-specific configuration management for getting and setting configuration values at the store level.\n\n</details>\n\n## Database Tools\n\n<details>\n<summary><strong>db-query</strong> - Execute SQL queries directly on Magento 2 database</summary>\n\n**Parameters:**\n- `query` (required): SQL query to execute\n- `format` (optional): Output format (`table`, `json`, `csv`) - Default: `table`\n\n</details>\n\n## Setup & Deployment\n\n<details>\n<summary><strong>setup-upgrade</strong> - Run Magento 2 setup upgrade to update database schema and data</summary>\n\n**Parameters:**\n- `keepGenerated` (optional): Keep generated files during upgrade\n\n</details>\n\n<details>\n<summary><strong>setup-di-compile</strong> - Compile Magento 2 dependency injection configuration</summary>\n\n**Parameters:** None\n\n</details>\n\n<details>\n<summary><strong>setup-db-status</strong> - Check database status to see if setup:upgrade is needed</summary>\n\n**Parameters:** None\n\n</details>\n\n<details>\n<summary><strong>setup-static-content-deploy</strong> - Deploy Magento 2 static content and assets</summary>\n\n**Parameters:**\n- `languages` (optional): Languages to deploy\n- `themes` (optional): Themes to deploy\n- `jobs` (optional): Number of parallel jobs\n- `force` (optional): Force deployment\n\n</details>\n\n## Store Management\n\n<details>\n<summary><strong>sys-store-list</strong> - List all Magento 2 stores, websites, and store views</summary>\n\n**Parameters:**\n- `format` (optional): Output format (`table`, `json`, `csv`) - Default: `table`\n\n</details>\n\n<details>\n<summary><strong>sys-store-config-base-url-list</strong> - List all base URLs for Magento 2 stores</summary>\n\n**Parameters:**\n- `format` (optional): Output format (`table`, `json`, `csv`) - Default: `table`\n\n</details>\n\n<details>\n<summary><strong>sys-url-list</strong> - Get all Magento 2 URLs</summary>\n\n**Parameters:**\n- `format` (optional): Output format (`table`, `json`, `csv`) - Default: `table`\n- `storeId` (optional): Store ID to filter URLs\n\n</details>\n\n<details>\n<summary><strong>sys-website-list</strong> - List all Magento 2 websites</summary>\n\n**Parameters:**\n- `format` (optional): Output format (`table`, `json`, `csv`) - Default: `table`\n\n</details>\n\n## Cron Management\n\n<details>\n<summary><strong>sys-cron-list</strong> - List all Magento 2 cron jobs and their configuration</summary>\n\n**Parameters:**\n- `format` (optional): Output format (`table`, `json`, `csv`) - Default: `table`\n\n</details>\n\n<details>\n<summary><strong>sys-cron-run</strong> - Run Magento 2 cron jobs</summary>\n\n**Parameters:**\n- `job` (optional): Specific cron job to run\n- `group` (optional): Cron group to run\n\n</details>\n\n## Requirements\n\n- Node.js 18.x or higher (required by MCP SDK)\n- n98-magerun2 installed and accessible via PATH\n- Valid Magento 2 installation in the working directory\n- AI agent that supports MCP (Model Context Protocol)\n\n## Publishing to npm\n\nTo publish this package to npm:\n\n1. **Build the project:**\n   ```bash\n   npm run build\n   ```\n\n2. **Login to npm:**\n   ```bash\n   npm login\n   ```\n\n3. **Publish:**\n   ```bash\n   npm publish --access public\n   ```\n\n## Development\n\n1. **Clone and install dependencies:**\n   ```bash\n   git clone https://github.com/elgentos/magento2-dev-mcp.git\n   cd magento2-dev-mcp\n   npm install\n   ```\n\n2. **Build:**\n   ```bash\n   npm run build\n   ```\n\n3. **Test locally:**\n   ```bash\n   npm start\n   ```\n\n## Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Add tests if applicable\n5. Submit a pull request\n\n## License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n","readmeFilename":"README.md"}