|
14 | 14 | > 10. Write a great README |
15 | 15 |
|
16 | 16 | ## Introduction |
| 17 | +Laravel Boost gives you a jump-start with AI assisted coding by making it simple to add everything you need to help the AI make good choices. |
17 | 18 |
|
18 | | -- `composer require laravel/boost` |
19 | | -- `./artisan vendor:publish --tag=boost-config` |
20 | | -- `./artisan boost:install` |
| 19 | +Core features: |
| 20 | +- MCP server with 15+ tools |
| 21 | +- Composable AI guidelines for ecosystem packages |
| 22 | +- Documentation API with built-in MCP tool |
| 23 | + |
| 24 | +Other features: |
| 25 | +- Browser logs streamed to `log/storage/browser.log` |
21 | 26 |
|
22 | 27 | > [!IMPORTANT] |
23 | | -> Boost is currently in Beta, is subject to change prior to the v1.0.0 release, and will be updated frequently. All notable changes will be documented in the [changelog](./CHANGELOG.md). |
| 28 | +> Boost is in Beta and will be updated frequently. |
| 29 | +
|
| 30 | +## Installation |
| 31 | + |
| 32 | +Add the package |
| 33 | +```bash |
| 34 | +composer require laravel/boost --dev |
| 35 | +``` |
| 36 | + |
| 37 | +Install the MCP server & guidelines |
| 38 | +```bash |
| 39 | +./artisan boost:install |
| 40 | +``` |
| 41 | + |
| 42 | +## Current MCP Tools |
| 43 | + |
| 44 | +| Name | Notes | |
| 45 | +| -------------------------- | ------------------------------------------------------------ | |
| 46 | +| Application Info | Shares PHP & Laravel versions, database engine, list of ecosystem packages with versions, and Eloquent models. | |
| 47 | +| Browser Logs | Read logs & errors from the browser | |
| 48 | +| Database Connections | List database connections, and the default | |
| 49 | +| Database Query | | |
| 50 | +| Database Schema | | |
| 51 | +| Get Absolute Url | Converts relative path to absolute so AI doesn't give you invalid URLs | |
| 52 | +| Get Config | Get specific value from config using dot notation | |
| 53 | +| Last Error | From the log files | |
| 54 | +| List Artisan Commands | | |
| 55 | +| List Available Config Keys | | |
| 56 | +| List Available Env Vars | Keys only | |
| 57 | +| List Routes | Regular & folio routes are combined. Ability to filter routes too | |
| 58 | +| Read Log Entries | Last X entries | |
| 59 | +| Report Feedback | Share Boost & Laravel AI feedback with the team | |
| 60 | +| Search Docs | Use hosted API service to retrieve docs based on installed packages | |
| 61 | +| Tinker | Run arbitrary code within the context of the project | |
| 62 | + |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | +## Adding your own AI guidelines |
| 67 | + |
24 | 68 |
|
25 | 69 | ## Official Documentation |
26 | 70 |
|
|
0 commit comments