PHPackages symfony/ai-demo - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. symfony/ai-demo ActiveProject[Framework](/categories/framework) symfony/ai-demo =============== Symfony AI Demo Application v0.12.0(4w ago)44429MITPHPPHP >=8.4 Since Dec 24Pushed 1mo agoCompare [ Source](https://github.com/symfony/ai-demo)[ Packagist](https://packagist.org/packages/symfony/ai-demo)[ Fund](https://symfony.com/sponsor)[ GitHub Sponsors](https://github.com/fabpot)[ RSS](/packages/symfony-ai-demo/feed)WikiDiscussions main Synced 1w ago READMEChangelog (10)Dependencies (212)Versions (14)Used By (0) Symfony AI - Demo Application ============================= [](#symfony-ai---demo-application) Symfony application demoing Symfony AI components. Examples -------- [](#examples) [![demo.png](demo.png)](demo.png) Requirements ------------ [](#requirements) What you need to run this demo: - Internet Connection - Terminal & Browser - [Git](https://git-scm.com/) & [GitHub Account](https://github.com) - [Docker](https://www.docker.com/) with [Docker Compose Plugin](https://docs.docker.com/compose/) - Your Favorite IDE or Editor - An [OpenAI API Key](https://platform.openai.com/docs/api-reference/create-and-export-an-api-key) Technology ---------- [](#technology) This small demo sits on top of following technologies: - [PHP >= 8.4](https://www.php.net/releases/8.4/en.php) - [Symfony 8.0 incl. Twig, Asset Mapper & UX](https://symfony.com/) - [Bootstrap 5](https://getbootstrap.com/docs/5.0/getting-started/introduction/) - [OpenAI's GPT & Embeddings](https://platform.openai.com/docs/overview) - [PostgreSQL with pgvector](https://github.com/pgvector/pgvector) - [FrankenPHP](https://frankenphp.dev/) Setup ----- [](#setup) The setup is split into three parts, the Symfony application, the OpenAI configuration, and initializing PostgreSQL. ### 1. Symfony App [](#1-symfony-app) Checkout the repository, start the docker environment and install dependencies: ``` git clone git@github.com:symfony/ai-demo.git cd ai-demo composer install docker compose up -d symfony serve -d ``` Now you should be able to open in your browser, and the chatbot UI should be available for you to start chatting. Note You might have to bypass the security warning of your browser with regard to self-signed certificates. ### 2. OpenAI Configuration [](#2-openai-configuration) For using GPT and embedding models from OpenAI, you need to configure an OpenAI API key as environment variable. This requires you to have an OpenAI account, create a valid API key and set it as `OPENAI_API_KEY` in `.env.local` file. ``` echo "OPENAI_API_KEY='sk-...'" > .env.local ``` Verify the success of this step by running the following command: ``` symfony console debug:dotenv ``` You should be able to see the `OPENAI_API_KEY` in the list of environment variables. ### 3. PostgreSQL Vector Store Initialization [](#3-postgresql-vector-store-initialization) [PostgreSQL with pgvector](https://github.com/pgvector/pgvector) is used to store embeddings of the chatbot's context. To initialize the vector store, you need to run the following command: ``` symfony console ai:store:setup ai.store.postgres.symfony_blog symfony console ai:store:index blog -vv ``` Now you should be able to retrieve documents from the store: ``` symfony console ai:store:retrieve blog "Week of Symfony" ``` **Don't forget to set up the project in your favorite IDE or editor.** Testing ------- [](#testing) ``` vendor/bin/phpunit # unit and integration tests vendor/bin/phpunit --testsuite e2e # end-to-end tests in a real browser ``` ### End-to-End Tests [](#end-to-end-tests) The `e2e` suite uses [Symfony Panther](https://github.com/symfony/panther) to click through all ten use cases and assert the Symfony AI panel of the profiler for the very request the click triggered. Every test calls an AI platform for real, which costs money and takes time - the suite is therefore excluded from the default one, and meant to be run locally. Next to the setup above, it needs: - **Chrome or Chromium** with a matching `chromedriver`, which `vendor/bin/bdi detect drivers`downloads into `drivers/`. If only a Snap or Flatpak Chromium is installed, point Panther at it with `PANTHER_CHROME_BINARY` in `.env.test.local`. - **API keys** in `.env.local`, or exported in your environment - a test is skipped when the key of its use case is missing: `OPENAI_API_KEY` for eight of them, `HUGGINGFACE_API_KEY` for the image cropping, `MISTRAL_API_KEY` for the document OCR. - **ffmpeg** (optional) to convert the audio fixture for the fake microphone of the speech use case. The blog store does not need to be indexed beforehand: `StoreTest` drives the indexing pipeline through the console commands, and `BlogTest` sets the store up and indexes it when it is empty. Both skip themselves when the database is not running. Panther boots the application in the **dev** environment, because the profiler - and with it the Symfony AI panel - only collects data with `kernel.debug` enabled. The web server therefore reads the real API keys from `.env.local` itself. Chrome fakes camera and microphone, so the video and speech use cases run without a human in front of the screen. ``` vendor/bin/phpunit --testsuite e2e --filter BlogTest # a single use case PANTHER_NO_HEADLESS=1 vendor/bin/phpunit --testsuite e2e # watch the browser ``` Screenshots of failing tests are written to `var/error-screenshots/`. Functionality ------------- [](#functionality) - The chatbot application is a simple and small Symfony 8.0 application. - The UI is coupled to a [Twig LiveComponent](https://symfony.com/bundles/ux-live-component/current/index.html), that integrates different `Chat` implementations on top of the user's session. - You can reset the chat context by hitting the `Reset` button in the top right corner. - You find three different usage scenarios in the upper navbar. ### MCP [](#mcp) Demo MCP server exposing a `current-time` tool and a **Movies** MCP App — an interactive HTML UI (`#[AsMcpApp]`) that renders the movie collection as a searchable grid in hosts supporting [MCP Apps](https://github.com/modelcontextprotocol/ext-apps). To add the server, add the following configuration to your MCP Client's settings, e.g. your IDE: ``` { "servers": { "symfony": { "command": "php", "args": [ "/your/full/path/to/bin/console", "mcp:server" ] } } } ``` #### Testing the MCP Server [](#testing-the-mcp-server) You can test the MCP server by running the following command to start the MCP client: ``` symfony console mcp:server ``` **With plain JSON RPC requests** Then, you can initialize the MCP session with the following JSON RPC request: ``` { "jsonrpc": "2.0", "id": 1, "method": "initialize", "params": { "protocolVersion": "2024-11-05", "capabilities": {}, "clientInfo": { "name": "demo-client", "version": "dev" } } } ``` And, to request the list of available tools: ``` { "jsonrpc": "2.0", "id": 2, "method": "tools/list" } ``` **With MCP Inspector** For testing, you can also use the [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector): ``` npx @modelcontextprotocol/inspector php bin/console mcp:server ``` Which opens a web UI to interactively test the MCP server. AI Mate - MCP Development Assistant ----------------------------------- [](#ai-mate---mcp-development-assistant) [Symfony AI Mate](https://github.com/symfony/ai-mate) is an MCP (Model Context Protocol) server that provides AI assistants with Symfony-specific development capabilities. ### Installation & Setup [](#installation--setup) **This demo is already configured!** For new projects you can set up AI Mate as follows: ``` # Install AI Mate composer require --dev symfony/ai-mate # Initialize configuration vendor/bin/mate init # Discover available tools vendor/bin/mate discover ``` ### MCP Client Configuration [](#mcp-client-configuration) The `mcp.json` file in the project root enables automatic MCP client detection: ``` { "mcpServers": { "symfony-ai-mate": { "command": "./vendor/bin/mate", "args": ["serve", "--force-keep-alive"] } } } ``` For other projects, add AI Mate to your MCP client settings (e.g., `~/.claude/mcp.json`, IDE settings, etc.). ### Custom Capability Example [](#custom-capability-example) This demo includes a **`symfony-ai-features`** tool (see `mate/src/SymfonyAiFeaturesTool.php`) that analyzes the project's AI configuration and reports all available platforms, agents, tools, stores, and packages. **Try it in your MCP-enabled chat:** > "Which Symfony AI features are available in this demo?" > > "What AI agents are configured in this project?" > > "Show me all the Symfony AI tools and their configuration" > > "What is the current PHP version used in this project?" > > "Is the php extension intl installed?" The AI assistant will use the `symfony-ai-features` and other MCP tool to provide detailed information about project internals. ### Creating Custom Tools [](#creating-custom-tools) Create tools in `mate/src/` and register them in `mate/config.php`. See the [AI Mate documentation](https://symfony.com/doc/current/ai/components/mate.html) for detailed guides. ### Testing [](#testing-1) ``` # Test with MCP Inspector npx @modelcontextprotocol/inspector ./vendor/bin/mate serve ``` ### Health Score 47 — FairBetter than 93% of packages Maintenance91 Actively maintained with recent releases Popularity22 Limited adoption so far Community20 Small or concentrated contributor base Maturity50 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~17 days Recently: every ~23 days Total 13 Last Release 29d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/47313?v=4)[Fabien Potencier](/maintainers/fabpot)[@fabpot](https://github.com/fabpot) --- Top Contributors [![chr-hertel](https://avatars.githubusercontent.com/u/2852185?v=4)](https://github.com/chr-hertel "chr-hertel (85 commits)")[![OskarStark](https://avatars.githubusercontent.com/u/995707?v=4)](https://github.com/OskarStark "OskarStark (63 commits)")[![wachterjohannes](https://avatars.githubusercontent.com/u/1464615?v=4)](https://github.com/wachterjohannes "wachterjohannes (12 commits)")[![fabpot](https://avatars.githubusercontent.com/u/47313?v=4)](https://github.com/fabpot "fabpot (9 commits)")[![valtzu](https://avatars.githubusercontent.com/u/652734?v=4)](https://github.com/valtzu "valtzu (5 commits)")[![tacman](https://avatars.githubusercontent.com/u/619585?v=4)](https://github.com/tacman "tacman (2 commits)")[![tom-hart-sky-uk](https://avatars.githubusercontent.com/u/219799917?v=4)](https://github.com/tom-hart-sky-uk "tom-hart-sky-uk (2 commits)")[![camilleislasse](https://avatars.githubusercontent.com/u/34024380?v=4)](https://github.com/camilleislasse "camilleislasse (2 commits)")[![welcoMattic](https://avatars.githubusercontent.com/u/773875?v=4)](https://github.com/welcoMattic "welcoMattic (1 commits)")[![Amoifr](https://avatars.githubusercontent.com/u/31698966?v=4)](https://github.com/Amoifr "Amoifr (1 commits)")[![xavierleune](https://avatars.githubusercontent.com/u/2320425?v=4)](https://github.com/xavierleune "xavierleune (1 commits)")[![bigdevlarry](https://avatars.githubusercontent.com/u/29729601?v=4)](https://github.com/bigdevlarry "bigdevlarry (1 commits)")[![claude](https://avatars.githubusercontent.com/u/81847?v=4)](https://github.com/claude "claude (1 commits)")[![Guikingone](https://avatars.githubusercontent.com/u/13744329?v=4)](https://github.com/Guikingone "Guikingone (1 commits)")[![ngrie](https://avatars.githubusercontent.com/u/42877936?v=4)](https://github.com/ngrie "ngrie (1 commits)")[![Nyholm](https://avatars.githubusercontent.com/u/1275206?v=4)](https://github.com/Nyholm "Nyholm (1 commits)")[![santysisi](https://avatars.githubusercontent.com/u/107224084?v=4)](https://github.com/santysisi "santysisi (1 commits)")[![smnandre](https://avatars.githubusercontent.com/u/1359581?v=4)](https://github.com/smnandre "smnandre (1 commits)") --- Tags aillmsymfonysymfony-ai ### Code Quality TestsPHPUnit Static AnalysisPHPStan Type Coverage Yes ### Embed Badge ![Health badge](/badges/symfony-ai-demo/health.svg) ``` [![Health](https://phpackages.com/badges/symfony-ai-demo/health.svg)](https://phpackages.com/packages/symfony-ai-demo) ``` ### Alternatives [kimai/kimai Kimai - Time Tracking 4.8k9.4k1](/packages/kimai-kimai)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 595.8M676](/packages/shopware-core)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.5k6.0M779](/packages/sylius-sylius)[chameleon-system/chameleon-base The Chameleon System core. 1029.4k6](/packages/chameleon-system-chameleon-base)[easycorp/easyadmin-bundle Admin generator for Symfony applications 4.3k18.3M430](/packages/easycorp-easyadmin-bundle)[shopware/platform The Shopware e-commerce core 3.4k1.5M3](/packages/shopware-platform) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)