addReadme
(optional): Add a readme.md file to generated module
How to use it
addReadme is exposed by the Magento2 Dev MCP MCP server. Add the server to your MCP client (Claude Desktop, Cursor, Windsurf and others), and the addReadme tool becomes available to the model automatically. See the full listing for setup details and every tool this server provides.
Install Magento2 Dev MCP
npx -y @elgentos/magento2-dev-mcpOther tools in Magento2 Dev MCP (32)
(optional): Add blocks, helpers and models
(optional): Add blocks
(optional): Add a composer.json file to generated module
(optional): Add helpers
(optional): Add models
(optional): Add SQL setup
(optional): Add stricttypes declaration to generated PHP files
Admin context (alternative to adminhtml)
Admin area
(optional): Author email for readme.md or composer.json
(optional): Author for readme.md or composer.json
(required): Fully qualified PHP class or interface name
Cron job execution context
(optional): Description for readme.md or composer.json
(optional): Show only disabled modules
Documentation context
(optional): Enable module after creation
(optional): Show only enabled modules
(optional): Filter by specific event name
(optional): Output format (table, json, csv) - Default: table
Frontend/storefront area
Global scope (default)
GraphQL API context
(optional): Method name to inspect. Omit to scan all public methods.
(optional): Create only module file
(optional): Create all files in folder with a modman file
(required): Name of your module
(required): SQL query to execute
(optional): The scope to get DI preferences for
(required): Namespace (your company prefix)
REST API context
SOAP API context