symfony / ai-mate
AI development assistant CLI for Symfony projects
Requires
- php: >=8.2
- psr/container: ^1.1|^2.0
- psr/log: ^2.0|^3.0
- symfony/ai-mate-composer-plugin: ^1.0
- symfony/config: ^5.4|^6.4|^7.3|^8.0
- symfony/console: ^5.4|^6.4|^7.3|^8.0
- symfony/dependency-injection: ^5.4|^6.4|^7.3|^8.0
- symfony/dotenv: ^5.4|^6.4|^7.3|^8.0
- symfony/filesystem: ^5.4|^6.4|^7.3|^8.0
- symfony/finder: ^5.4|^6.4|^7.3|^8.0
- symfony/process: ^5.4|^6.4|^7.3|^8.0
Requires (Dev)
- ext-simplexml: *
- helgesverre/toon: ^3.2.1
- phpstan/phpstan: ^2.1
- phpstan/phpstan-phpunit: ^2.0
- phpstan/phpstan-strict-rules: ^2.0
- phpunit/phpunit: ^11.5.53
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
The Mate component provides a command-line assistant (vendor/bin/mate) that exposes
project-aware development tools to coding agents (Claude Code, Codex, Cursor, …) and
developers. Agents run the mate commands directly, so tool schemas are read on demand
via --help/tools:inspect instead of being loaded up front. This is a development tool,
not intended for production use.
Install it in your project with:
composer require --dev symfony/ai-mate vendor/bin/mate init composer dump-autoload
Point your coding agent at the CLI (see the generated mate/AGENT_INSTRUCTIONS.md):
vendor/bin/mate tools:list # list available tools vendor/bin/mate tools:inspect symfony-profiler-list # show a tool's parameters/schema vendor/bin/mate tools:call symfony-profiler-list --limit=1 vendor/bin/mate resources:read symfony-profiler://profile/<token>
Add --format=json to the tools:*, resources:read, debug:*, skills:install,
skills:list and skills:validate commands for machine-readable output.
The package ships with the symfony/ai-mate-composer-plugin, which automatically
refreshes Mate extension discovery after composer install and composer update once the
project has been initialized.
Backward Compatibility
Mate is a development tool, so its backward compatibility promise is narrower than the one of
the other components. Covered are the CLI interface (commands, arguments, options), the
definition of tools and resources (name, parameters, input schema), the user-facing
customization (mate/config.php, mate/extensions.php, extra.ai-mate) and the extension
points (#[MateTool], #[MateResource], #[MateResourceTemplate]). Not covered are the
content of tool responses, agent instructions, skills and everything marked @internal.
See the documentation.
Installation
composer require --dev symfony/ai-mate
This repository is a READ-ONLY sub-tree split. See https://github.com/symfony/ai to create issues or submit pull requests.