README

The SuluMateExtension is an AI Mate extension for the Sulu content management system. It provides Sulu-aware MCP tools and resources for AI-assisted content management workflows.

Have a look at the require section in the composer.json to find an up-to-date list of the requirements of the extension.

🚀  Installation and Documentation

Execute the following composer command to add the extension to the dependencies of your project:

composer require --dev sulu/sulu-mate-extension

Afterwards, initialize the Mate environment and discover the extension:

vendor/bin/mate init
vendor/bin/mate discover

Extension discovery is handled automatically after Composer install and update. Run vendor/bin/mate discover when you want to refresh discovery state and regenerate agent instruction artifacts manually.

🔧  Available Tools

See INSTRUCTIONS.md for a full description of the available MCP tools.

💡  Key Concepts

AI Mate Extension

The SuluMateExtension integrates with the Symfony AI Mate ecosystem. It uses the Model Context Protocol (MCP) to expose Sulu-specific tools and resources to AI assistants, enabling them to interact with the Sulu CMS in a structured and framework-aware way.

Development

composer install
composer test
composer lint
composer fix

Useful Mate commands while developing:

vendor/bin/mate debug:capabilities
vendor/bin/mate debug:extensions
vendor/bin/mate mcp:tools:list

❤️  Support and Contributions

The Sulu content management system is a community-driven open source project backed by various partner companies. We are committed to a fully transparent development process and highly appreciate any contributions.

In case you have questions, we are happy to welcome you in our official Slack channel. If you found a bug or miss a specific feature, feel free to file a new issue with a respective title and description on the sulu/sulu-mate-extension repository.

📘  License

The Sulu content management system is released under the under terms of the MIT License.