boost

<p align="center"> <img alt="Boost Logo Dark Mode" src="/art/boost-light-mode.svg#gh-light-mode-only"/> <img alt="Boost Logo Dark Mode" src="/art/boost-dark-mode.svg#gh-dark-mode-only"/> </p> <p align="center"> <a href="https://github.com/laravel/boost/actions"><img src="https://github.com/laravel/boost/workflows/tests/badge.svg" alt="Build Status"></a> <a href="https://packagist.org/packages/laravel/boost"><img src="https://img.shields.io/packagist/dt/laravel/boost?v=1" alt="Total Downloads"></a> <a href="https://packagist.org/packages/laravel/boost"><img src="https://img.shields.io/packagist/v/laravel/boost?v=1" alt="Latest Stable Version"></a> <a href="https://packagist.org/packages/laravel/boost"><img src="https://img.shields.io/packagist/l/laravel/boost?v=1" alt="License"></a> </p> ## Introduction Laravel Boost accelerates AI-assisted development by providing the essential context and structure that AI needs to generate high-quality, Laravel-specific code. At its foundation, Laravel Boost is an MCP server equipped with over 15 specialized tools designed to streamline AI-assisted coding workflows. The package includes composable AI guidelines specifically crafted for Laravel ecosystem packages, ensuring consistent and framework-appropriate code generation. Boost also features a powerful Documentation API that combines a built-in MCP tool with an extensive knowledge base containing over 17,000 pieces of Laravel-specific information, all enhanced by semantic search capabilities using embeddings for precise, context-aware results. > [!IMPORTANT] > Laravel Boost is currently in beta and receives frequent updates as we refine features and expand capabilities. ## Installation Laravel Boost can be installed via Composer: ```bash composer require laravel/boost --dev ``` Next, install the MCP server and coding guidelines: ```bash php artisan boost:install ``` Feel free to add the generated MCP configuration file, guideline files (`.mcp.json`, `CLAUDE.md`, `AGENTS.md`, `junie/`, etc.) and `boost.json` configuration file to your application's `.gitignore` as these files are automatically re-generated when running `boost:install` and `boost:update`. Once Laravel Boost has been installed, you're ready to start coding with Cursor, Claude Code, or your AI agent of choice. ### Set up Your Code Editors #### PhpStorm 1. Press `shift` twice to open the command palette 2. Search "MCP Settings" and press `enter` 3. Check the box next to `laravel-boost` 4. Click "Apply" at the bottom right #### VS Code 1. Open the command palette (`Cmd+Shift+P` or `Ctrl+Shift+P`) 2. Press `enter` on "MCP: List Servers" 3. Arrow to `laravel-boost` and press `enter` 4. Choose "Start server" #### Cursor 1. Open the command palette (`Cmd+Shift+P` or `Ctrl+Shift+P`) 2. Press `enter` on "/open MCP Settings" 3. Turn the toggle on for `laravel-boost` #### Claude Code 1. Claude support is typically enabled automatically, but if you find it isn't 2. Open a shell in the project's directory 3. Run `claude mcp add -s local -t stdio laravel-boost php artisan boost:mcp` #### Codex 1. Codex support is typically enabled automatically, but if you find it isn't 2. Open a shell in the project's directory 3. Run `codex mcp add -- php artisan boost:mcp` #### Gemini 1. Gemini support is typically enabled automatically, but if you find it isn't 2. Open a shell in the project's directory 3. Run `gemini mcp add -s project -t stdio laravel-boost php artisan boost:mcp` ## Available MCP Tools | Name | Notes | | -------------------------- |----------------------------------------------------------------------------------------------------------------| | Application Info | Read PHP & Laravel versions, database engine, list of ecosystem packages with versions, and Eloquent models | | Browser Logs | Read logs and errors from the browser | | Database Connections | Inspect available database connections, including the default connection | | Database Query | Execute a query against the database | | Database Schema | Read the database schema | | Get Absolute URL | Convert relative path URIs to absolute so agents generate valid URLs | | Get Config | Get a value from the configuration files using "dot" notation | | Last Error | Read the last error from the application's log files | | List Artisan Commands |