https://github.com/symfony/ai-demo
Symfony AI Demo Application
https://github.com/symfony/ai-demo
ai llm symfony symfony-ai
Last synced: about 1 month ago
JSON representation
Symfony AI Demo Application
- Host: GitHub
- URL: https://github.com/symfony/ai-demo
- Owner: symfony
- License: mit
- Created: 2025-07-11T10:58:45.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2026-02-16T22:56:45.000Z (about 1 month ago)
- Last Synced: 2026-02-17T02:05:49.465Z (about 1 month ago)
- Topics: ai, llm, symfony, symfony-ai
- Language: PHP
- Homepage: https://symfony.com/bundles/ai-demo
- Size: 865 KB
- Stars: 34
- Watchers: 0
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Symfony AI - Demo Application
Symfony application demoing Symfony AI components.
## Examples
## 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
This small demo sits on top of following technologies:
* [PHP >= 8.4](https://www.php.net/releases/8.4/en.php)
* [Symfony 7.3 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)
* [ChromaDB Vector Store](https://www.trychroma.com/)
* [FrankenPHP](https://frankenphp.dev/)
## Setup
The setup is split into three parts, the Symfony application, the OpenAI configuration, and initializing the Chroma DB.
### 1. Symfony App
Checkout the repository, start the docker environment and install dependencies:
```shell
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 https://localhost:8000/ 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
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.
```shell
echo "OPENAI_API_KEY='sk-...'" > .env.local
```
Verify the success of this step by running the following command:
```shell
symfony console debug:dotenv
```
You should be able to see the `OPENAI_API_KEY` in the list of environment variables.
### 3. Chroma DB Initialization
The [Chroma DB](https://www.trychroma.com/) is a vector store that is used to store embeddings of the chatbot's context.
To initialize the Chroma DB, you need to run the following command:
```shell
symfony console ai:store:index blog -vv
```
Now you should be able to retrieve documents from the store:
```shell
symfony console ai:store:retrieve blog "Week of Symfony"
```
**Don't forget to set up the project in your favorite IDE or editor.**
## Functionality
* The chatbot application is a simple and small Symfony 7.3 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
Demo MCP server added with a `current-time` tool to return the current time, with an optional format string.
To add the server, add the following configuration to your MCP Client's settings, e.g. your IDE:
```json
{
"servers": {
"symfony": {
"command": "php",
"args": [
"/your/full/path/to/bin/console",
"mcp:server"
]
}
}
}
```
#### Testing the MCP Server
You can test the MCP server by running the following command to start the MCP client:
```shell
symfony console mcp:server
```
**With plain JSON RPC requests**
Then, you can initialize the MCP session with the following JSON RPC request:
```json
{ "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:
```json
{ "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):
```shell
npx @modelcontextprotocol/inspector php bin/console mcp:server
```
Which opens a web UI to interactively test the MCP server.
## 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
**This demo is already configured!** For new projects you can set up AI Mate as follows:
```shell
# 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
The `mcp.json` file in the project root enables automatic MCP client detection:
```json
{
"mcpServers": {
"symfony-ai-mate": {
"command": "./vendor/bin/mate",
"args": ["serve"]
}
}
}
```
For other projects, add AI Mate to your MCP client settings (e.g., `~/.claude/mcp.json`, IDE settings, etc.).
### Custom Capability Example
This demo includes a **`symfony-ai-features`** tool (see `mate/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
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
```shell
# Test with MCP Inspector
npx @modelcontextprotocol/inspector ./vendor/bin/mate serve
```