Laravel Boost
Overview
Laravel Boost is an official Laravel package that accelerates AI-assisted development by providing composable guidelines, on-demand agent skills, an MCP (Model Context Protocol) server, and a documentation API with semantic search across 17,000+ Laravel-specific knowledge pieces. It bridges AI coding tools and the Laravel ecosystem, ensuring that AI agents generate high-quality, convention-compliant Laravel code.
Apply this skill when setting up, configuring, or extending Laravel Boost in a project, or when integrating AI agents with a Laravel application.
Multi-Phase Process
Phase 1: Assessment
- Confirm Laravel version compatibility (10.x, 11.x, 12.x)
- Identify the AI IDE or agent in use (Cursor, Claude Code, Codex, Gemini CLI, GitHub Copilot, Junie)
- Check if an MCP configuration already exists (
.mcp.json)
- Review existing guideline and skill customizations in
.ai/
STOP — Do NOT install Boost without confirming Laravel version compatibility and target IDE.
Phase 2: Installation and Configuration
- Install the package and run the installer
- Configure MCP server for the target IDE
- Set up automatic updates via Composer hooks
- Verify MCP tools are accessible from the AI agent
STOP — Do NOT proceed until MCP server connectivity is verified with at least one tool call.
Phase 3: Customization
- Add project-specific guidelines in
.ai/guidelines/
- Create domain-specific skills in
.ai/skills/
- Override built-in guidelines or skills where project conventions differ
- Register custom agents if extending to unsupported IDEs
STOP — Do NOT override built-in guidelines unless project conventions genuinely differ from Laravel defaults.
Phase 4: Validation
- Confirm MCP server responds to tool calls (Application Info, Database Schema, Search Docs)
- Verify guidelines load in the AI agent's context window
- Test skill activation for domain-relevant tasks
- Check that
boost:update keeps resources current after dependency changes
IDE Setup Decision Table
| IDE / Agent |
Setup Method |
Configuration File |
| Claude Code |
CLI command |
.mcp.json (auto-generated) |
| Codex |
CLI command |
.mcp.json |
| Gemini CLI |
CLI command |
.mcp.json |
| Cursor |
Command Palette GUI |
.cursor/mcp.json |
| GitHub Copilot |
Command Palette GUI |
.mcp.json |
| Junie |
Settings GUI |
.mcp.json |
| Custom / Unsupported |
Custom agent class |
Manual MCP config |
Installation
# Install as a development dependency
composer require laravel/boost --dev
# Run the installer — generates .mcp.json, guideline files, and boost.json
php artisan boost:install
The installer generates:
.mcp.json — MCP server configuration for IDE integration
- Guideline files (
CLAUDE.md, AGENTS.md, etc.) tailored to detected packages
boost.json — Boost configuration file
IDE-Specific MCP Setup
| IDE / Agent |
Setup Command or Action |
| Claude Code |
claude mcp add -s local -t stdio laravel-boost php artisan boost:mcp |
| Codex |
codex mcp add laravel-boost -- php "artisan" "boost:mcp" |
| Gemini CLI |
gemini mcp add -s project -t stdio laravel-boost php artisan boost:mcp |
| Cursor |
Command Palette -> "Open MCP Settings" -> toggle on laravel-boost |
| GitHub Copilot |
Command Palette -> "MCP: List Servers" -> select laravel-boost -> "Start server" |
| Junie |
Shift-Shift -> "MCP Settings" -> check laravel-boost -> Apply |
Manual MCP Configuration
{
"mcpServers": {
"laravel-boost": {
"command": "php",
"args": ["artisan", "boost:mcp"]
}
}
}
Keeping Resources Updated
# Manual update after dependency changes
php artisan boost:update
# Automatic updates — add to composer.json scripts
{
"scripts": {
"post-update-cmd": [
"@php artisan boost:update --ansi"
]
}
}
MCP Server Tools
Laravel Boost exposes the following tools through its MCP server, giving AI agents direct access to application context:
| Tool |
Purpose |
Typical Use |
| Application Info |
Read PHP and Laravel versions, database engine, ecosystem packages, Eloquent models |
Context discovery at session start |
| Database Schema |
Read full database schema |
Migration planning, model generation |
| Database Query |
Execute queries against the database |
Data inspection, debugging |
| Database Connections |
Inspect available database connections |
Multi-database configuration |
| Search Docs |
Semantic search across Laravel documentation API |
Finding best practices, API references |
| Last Error |
Read the most recent application log error |
Debugging workflow |
| Read Log Entries |
Read last N log entries |
Monitoring, debugging |
| Browser Logs |
Read logs and errors from browser |
Frontend debugging |
| Get Absolute URL |
Convert relative path URIs to absolute URLs |
Link generation |
AI Guidelines
Guidelines are composable instruction files loaded upfront into the AI agent's context, providing broad conventions and best practices.
Available Built-in Guidelines
| Package |
Versions Supported |
| Laravel Framework |
Core, 10.x, 11.x, 12.x |
| Livewire |
Core, 2.x, 3.x, 4.x |
| Flux UI |
Core, Free, Pro |
| Inertia |
React, Vue, Svelte (1.x-3.x) |
| Tailwind CSS |
Core, 3.x, 4.x |
| Pest |
Core, 3.x, 4.x |
| PHPUnit, Pint, Sail, Pennant, Volt, Wayfinder, Folio, Herd, MCP |
Core |
Custom Guidelines
Create .blade.php or .md files in .ai/guidelines/:
.ai/guidelines/team-conventions.md
.ai/guidelines/billing/stripe-patterns.blade.php
Override a built-in guideline by matching its path:
.ai/guidelines/inertia-react/2/forms.blade.php
Third-Party Package Guidelines
Package authors can ship guidelines at:
resources/boost/guidelines/core.blade.php
Agent Skills
Skills are on-demand knowledge modules activated only when relevant, reducing context window bloat.
Available Built-in Skills
| Skill |
Domain |
livewire-development |
Livewire components and reactivity |
inertia-react-development |
Inertia.js with React |
inertia-vue-development |
Inertia.js with Vue |
inertia-svelte-development |
Inertia.js with Svelte |
pest-testing |
Pest test patterns |
fluxui-development |
Flux UI components |
folio-routing |
Folio page-based routing |
tailwindcss-development |
Tailwind CSS utility classes |
volt-development |
Volt single-file Livewire components |
pennant-development |
Pennant feature flags |
wayfinder-development |
Wayfinder type-safe routing |
mcp-development |
MCP server/tool development |
Custom Skills
Create .ai/skills/{skill-name}/SKILL.md:
---
name: invoice-management
description: Build and work with invoice features including PDF generation and payment tracking.
---
# Invoice Management
## When to use this skill
Use when working with the invoicing module...
Guidelines vs Skills Decision Table
| Question |
Guidelines |
Skills |
| When is it loaded? |
Always — upfront context |
On-demand — when the task matches |
| How broad is the scope? |
Foundational conventions |
Focused implementation patterns |
| Impact on context window? |
Constant (always present) |
Minimal (loaded only when needed) |
| Best for? |
Coding standards, package versions |
Step-by-step implementation guides |
| Content changes often? |
Rarely (stable conventions) |
Frequently (evolving patterns) |
| Team-wide applicability? |
High (everyone follows) |
Varies (domain-specific) |
Documentation API
Boost provides semantic search across 17,000+ documentation pieces covering:
| Package |
Versions |
| Laravel Framework |
10.x, 11.x, 12.x |
| Filament |
2.x, 3.x, 4.x, 5.x |
| Flux UI |
2.x Free, 2.x Pro |
| Inertia |
1.x, 2.x |
| Livewire |
1.x, 2.x, 3.x, 4.x |
| Nova |
4.x, 5.x |
| Pest |
3.x, 4.x |
| Tailwind CSS |
3.x, 4.x |
The Search Docs MCP tool queries this API. Guidelines and skills automatically instruct agents to use it when they need implementation details.
When to Use vs When Not Needed
| Scenario |
Use Laravel Boost? |
Why |
| Laravel project with AI-assisted development |
Yes |
Primary use case |
| Team uses Cursor, Claude Code, Copilot, or other AI IDE |
Yes |
MCP integration improves output |
| Need consistent Laravel conventions across AI-generated code |
Yes |
Guidelines enforce standards |
| Non-Laravel PHP project |
No |
Boost is Laravel-specific |
| No AI coding tools in workflow |
No |
Boost's value is in AI agent integration |
| Production runtime performance optimization |
No |
Boost is dev-time only, not a runtime optimizer |
| Already have comprehensive custom AI prompts |
Optional |
Boost may supplement or replace them |
Extending Boost
Custom Agent Registration
For AI tools not supported out of the box:
// In AppServiceProvider::boot()
use Laravel\Boost\Boost;
Boost::registerAgent('custom-ide', CustomAgent::class);
The custom agent class must extend Laravel\Boost\Install\Agents\Agent and implement the relevant interfaces:
SupportsGuidelines — for guideline file generation
SupportsMcp — for MCP server configuration
SupportsSkills — for skill file generation
Anti-Patterns / Common Mistakes
| Anti-Pattern |
Why It Fails |
What To Do Instead |
| Installing in production |
Boost is dev-time only, adds unnecessary overhead |
Use composer require --dev |
| Overriding every built-in guideline |
Drifts from Laravel core team recommendations |
Override only where project genuinely differs |
Ignoring boost:update |
Guidelines fall out of sync with installed packages |
Run after every composer update |
| Overly broad custom skills |
Wastes context window tokens when activated |
Focus each skill on a single domain |
| Skipping MCP verification |
Misconfigured MCP silently degrades AI agent quality |
Test tool calls after installation |
Not committing .mcp.json |
Team members get inconsistent AI agent experience |
Commit to version control |
| Mixing guidelines and skills |
Context window pollution with always-loaded content |
Conventions in guidelines, patterns in skills |
| Not running installer after upgrade |
Missing new guideline files and MCP tools |
Run php artisan boost:install after major upgrades |
Anti-Rationalization Guards
- Do NOT skip MCP verification because "the install succeeded" -- test at least one tool call.
- Do NOT override built-in guidelines without a documented reason for the deviation.
- Do NOT create broad skills -- if it covers more than one domain, split it.
- Do NOT install Boost in production -- it is a
--dev dependency exclusively.
- Do NOT forget to run
boost:update after dependency changes -- stale guidelines degrade AI output.
Documentation Lookup (Context7)
Use mcp__context7__resolve-library-id then mcp__context7__query-docs for up-to-date docs. Returned docs override memorized knowledge.
laravel/framework — for core Laravel APIs, configuration, or Artisan commands
livewire — for component lifecycle, wire directives, or Alpine.js integration
Integration Points
| Skill |
How It Connects |
laravel-specialist |
Boost guidelines and skills enhance AI-generated Laravel code quality |
php-specialist |
Boost respects PHP version and PSR standards in generated guidelines |
mcp-builder |
Boost's MCP server is an example of the MCP pattern; extend it for custom tools |
self-learning |
Boost's Application Info tool feeds project context into the learning phase |
senior-backend |
Boost's Database Schema and Query tools support backend architecture decisions |
test-driven-development |
Boost's Pest skill provides testing patterns for AI-generated tests |
Skill Type
FLEXIBLE — Adapt the process phases to what the project needs. A new project requires full installation and IDE setup (Phases 1-4). An existing Boost installation may only need customization (Phase 3) or validation after a Laravel upgrade (Phase 4). The non-negotiable minimum: verify MCP server connectivity and confirm guidelines match installed package versions.
1---2name: laravel-boost3description: Use when setting up or configuring Laravel Boost for AI-assisted development — package installation, MCP server configuration, guideline customization, skill authoring, documentation API integration. Trigger conditions: install Laravel Boost, configure MCP for IDE, create custom AI guidelines, write project-specific skills, verify MCP tool connectivity, update Boost after dependency changes, extend Boost for custom agents.4---5
6# Laravel Boost
7
8## Overview
9
10Laravel Boost is an official Laravel package that accelerates AI-assisted development by providing composable guidelines, on-demand agent skills, an MCP (Model Context Protocol) server, and a documentation API with semantic search across 17,000+ Laravel-specific knowledge pieces. It bridges AI coding tools and the Laravel ecosystem, ensuring that AI agents generate high-quality, convention-compliant Laravel code.
11
12Apply this skill when setting up, configuring, or extending Laravel Boost in a project, or when integrating AI agents with a Laravel application.
13
14## Multi-Phase Process
15
16### Phase 1: Assessment
17
181. Confirm Laravel version compatibility (10.x, 11.x, 12.x)
192. Identify the AI IDE or agent in use (Cursor, Claude Code, Codex, Gemini CLI, GitHub Copilot, Junie)
203. Check if an MCP configuration already exists (`.mcp.json`)
214. Review existing guideline and skill customizations in `.ai/`
22
23> **STOP — Do NOT install Boost without confirming Laravel version compatibility and target IDE.**
24
25### Phase 2: Installation and Configuration
26
271. Install the package and run the installer
282. Configure MCP server for the target IDE
293. Set up automatic updates via Composer hooks
304. Verify MCP tools are accessible from the AI agent
31
32> **STOP — Do NOT proceed until MCP server connectivity is verified with at least one tool call.**
33
34### Phase 3: Customization
35
361. Add project-specific guidelines in `.ai/guidelines/`
372. Create domain-specific skills in `.ai/skills/`
383. Override built-in guidelines or skills where project conventions differ
394. Register custom agents if extending to unsupported IDEs
40
41> **STOP — Do NOT override built-in guidelines unless project conventions genuinely differ from Laravel defaults.**
42
43### Phase 4: Validation
44
451. Confirm MCP server responds to tool calls (Application Info, Database Schema, Search Docs)
462. Verify guidelines load in the AI agent's context window
473. Test skill activation for domain-relevant tasks
484. Check that `boost:update` keeps resources current after dependency changes
49
50## IDE Setup Decision Table
51
52| IDE / Agent | Setup Method | Configuration File |
53|---|---|---|
54| **Claude Code** | CLI command | `.mcp.json` (auto-generated) |
55| **Codex** | CLI command | `.mcp.json` |
56| **Gemini CLI** | CLI command | `.mcp.json` |
57| **Cursor** | Command Palette GUI | `.cursor/mcp.json` |
58| **GitHub Copilot** | Command Palette GUI | `.mcp.json` |
59| **Junie** | Settings GUI | `.mcp.json` |
60| **Custom / Unsupported** | Custom agent class | Manual MCP config |
61
62## Installation
63
64```bash
65# Install as a development dependency
66composer require laravel/boost --dev
67
68# Run the installer — generates .mcp.json, guideline files, and boost.json
69php artisan boost:install
70```
71
72The installer generates:
73- `.mcp.json` — MCP server configuration for IDE integration
74- Guideline files (`CLAUDE.md`, `AGENTS.md`, etc.) tailored to detected packages
75- `boost.json` — Boost configuration file
76
77### IDE-Specific MCP Setup
78
79| IDE / Agent | Setup Command or Action |
80|---|---|
81| **Claude Code** | `claude mcp add -s local -t stdio laravel-boost php artisan boost:mcp` |
82| **Codex** | `codex mcp add laravel-boost -- php "artisan" "boost:mcp"` |
83| **Gemini CLI** | `gemini mcp add -s project -t stdio laravel-boost php artisan boost:mcp` |
84| **Cursor** | Command Palette -> "Open MCP Settings" -> toggle on `laravel-boost` |
85| **GitHub Copilot** | Command Palette -> "MCP: List Servers" -> select `laravel-boost` -> "Start server" |
86| **Junie** | Shift-Shift -> "MCP Settings" -> check `laravel-boost` -> Apply |
87
88### Manual MCP Configuration
89
90```json
91{
92 "mcpServers": {
93 "laravel-boost": {
94 "command": "php",
95 "args": ["artisan", "boost:mcp"]
96 }
97 }
98}
99```
100
101### Keeping Resources Updated
102
103```bash
104# Manual update after dependency changes
105php artisan boost:update
106
107# Automatic updates — add to composer.json scripts
108{
109 "scripts": {
110 "post-update-cmd": [
111 "@php artisan boost:update --ansi"
112 ]
113 }
114}
115```
116
117## MCP Server Tools
118
119Laravel Boost exposes the following tools through its MCP server, giving AI agents direct access to application context:
120
121| Tool | Purpose | Typical Use |
122|---|---|---|
123| **Application Info** | Read PHP and Laravel versions, database engine, ecosystem packages, Eloquent models | Context discovery at session start |
124| **Database Schema** | Read full database schema | Migration planning, model generation |
125| **Database Query** | Execute queries against the database | Data inspection, debugging |
126| **Database Connections** | Inspect available database connections | Multi-database configuration |
127| **Search Docs** | Semantic search across Laravel documentation API | Finding best practices, API references |
128| **Last Error** | Read the most recent application log error | Debugging workflow |
129| **Read Log Entries** | Read last N log entries | Monitoring, debugging |
130| **Browser Logs** | Read logs and errors from browser | Frontend debugging |
131| **Get Absolute URL** | Convert relative path URIs to absolute URLs | Link generation |
132
133## AI Guidelines
134
135Guidelines are composable instruction files loaded upfront into the AI agent's context, providing broad conventions and best practices.
136
137### Available Built-in Guidelines
138
139| Package | Versions Supported |
140|---|---|
141| Laravel Framework | Core, 10.x, 11.x, 12.x |
142| Livewire | Core, 2.x, 3.x, 4.x |
143| Flux UI | Core, Free, Pro |
144| Inertia | React, Vue, Svelte (1.x-3.x) |
145| Tailwind CSS | Core, 3.x, 4.x |
146| Pest | Core, 3.x, 4.x |
147| PHPUnit, Pint, Sail, Pennant, Volt, Wayfinder, Folio, Herd, MCP | Core |
148
149### Custom Guidelines
150
151Create `.blade.php` or `.md` files in `.ai/guidelines/`:
152
153```
154.ai/guidelines/team-conventions.md
155.ai/guidelines/billing/stripe-patterns.blade.php
156```
157
158Override a built-in guideline by matching its path:
159
160```
161.ai/guidelines/inertia-react/2/forms.blade.php
162```
163
164### Third-Party Package Guidelines
165
166Package authors can ship guidelines at:
167
168```
169resources/boost/guidelines/core.blade.php
170```
171
172## Agent Skills
173
174Skills are on-demand knowledge modules activated only when relevant, reducing context window bloat.
175
176### Available Built-in Skills
177
178| Skill | Domain |
179|---|---|
180| `livewire-development` | Livewire components and reactivity |
181| `inertia-react-development` | Inertia.js with React |
182| `inertia-vue-development` | Inertia.js with Vue |
183| `inertia-svelte-development` | Inertia.js with Svelte |
184| `pest-testing` | Pest test patterns |
185| `fluxui-development` | Flux UI components |
186| `folio-routing` | Folio page-based routing |
187| `tailwindcss-development` | Tailwind CSS utility classes |
188| `volt-development` | Volt single-file Livewire components |
189| `pennant-development` | Pennant feature flags |
190| `wayfinder-development` | Wayfinder type-safe routing |
191| `mcp-development` | MCP server/tool development |
192
193### Custom Skills
194
195Create `.ai/skills/{skill-name}/SKILL.md`:
196
197```markdown
198---
199name: invoice-management
200description: Build and work with invoice features including PDF generation and payment tracking.
201---
202
203# Invoice Management
204
205## When to use this skill
206Use when working with the invoicing module...
207```
208
209### Guidelines vs Skills Decision Table
210
211| Question | Guidelines | Skills |
212|---|---|---|
213| When is it loaded? | Always — upfront context | On-demand — when the task matches |
214| How broad is the scope? | Foundational conventions | Focused implementation patterns |
215| Impact on context window? | Constant (always present) | Minimal (loaded only when needed) |
216| Best for? | Coding standards, package versions | Step-by-step implementation guides |
217| Content changes often? | Rarely (stable conventions) | Frequently (evolving patterns) |
218| Team-wide applicability? | High (everyone follows) | Varies (domain-specific) |
219
220## Documentation API
221
222Boost provides semantic search across 17,000+ documentation pieces covering:
223
224| Package | Versions |
225|---|---|
226| Laravel Framework | 10.x, 11.x, 12.x |
227| Filament | 2.x, 3.x, 4.x, 5.x |
228| Flux UI | 2.x Free, 2.x Pro |
229| Inertia | 1.x, 2.x |
230| Livewire | 1.x, 2.x, 3.x, 4.x |
231| Nova | 4.x, 5.x |
232| Pest | 3.x, 4.x |
233| Tailwind CSS | 3.x, 4.x |
234
235The `Search Docs` MCP tool queries this API. Guidelines and skills automatically instruct agents to use it when they need implementation details.
236
237## When to Use vs When Not Needed
238
239| Scenario | Use Laravel Boost? | Why |
240|---|---|---|
241| Laravel project with AI-assisted development | Yes | Primary use case |
242| Team uses Cursor, Claude Code, Copilot, or other AI IDE | Yes | MCP integration improves output |
243| Need consistent Laravel conventions across AI-generated code | Yes | Guidelines enforce standards |
244| Non-Laravel PHP project | No | Boost is Laravel-specific |
245| No AI coding tools in workflow | No | Boost's value is in AI agent integration |
246| Production runtime performance optimization | No | Boost is dev-time only, not a runtime optimizer |
247| Already have comprehensive custom AI prompts | Optional | Boost may supplement or replace them |
248
249## Extending Boost
250
251### Custom Agent Registration
252
253For AI tools not supported out of the box:
254
255```php
256// In AppServiceProvider::boot()
257use Laravel\Boost\Boost;
258
259Boost::registerAgent('custom-ide', CustomAgent::class);
260```
261
262The custom agent class must extend `Laravel\Boost\Install\Agents\Agent` and implement the relevant interfaces:
263- `SupportsGuidelines` — for guideline file generation
264- `SupportsMcp` — for MCP server configuration
265- `SupportsSkills` — for skill file generation
266
267## Anti-Patterns / Common Mistakes
268
269| Anti-Pattern | Why It Fails | What To Do Instead |
270|---|---|---|
271| Installing in production | Boost is dev-time only, adds unnecessary overhead | Use `composer require --dev` |
272| Overriding every built-in guideline | Drifts from Laravel core team recommendations | Override only where project genuinely differs |
273| Ignoring `boost:update` | Guidelines fall out of sync with installed packages | Run after every `composer update` |
274| Overly broad custom skills | Wastes context window tokens when activated | Focus each skill on a single domain |
275| Skipping MCP verification | Misconfigured MCP silently degrades AI agent quality | Test tool calls after installation |
276| Not committing `.mcp.json` | Team members get inconsistent AI agent experience | Commit to version control |
277| Mixing guidelines and skills | Context window pollution with always-loaded content | Conventions in guidelines, patterns in skills |
278| Not running installer after upgrade | Missing new guideline files and MCP tools | Run `php artisan boost:install` after major upgrades |
279
280## Anti-Rationalization Guards
281
282- Do NOT skip MCP verification because "the install succeeded" -- test at least one tool call.
283- Do NOT override built-in guidelines without a documented reason for the deviation.
284- Do NOT create broad skills -- if it covers more than one domain, split it.
285- Do NOT install Boost in production -- it is a `--dev` dependency exclusively.
286- Do NOT forget to run `boost:update` after dependency changes -- stale guidelines degrade AI output.
287
288## Documentation Lookup (Context7)
289
290Use `mcp__context7__resolve-library-id` then `mcp__context7__query-docs` for up-to-date docs. Returned docs override memorized knowledge.
291- `laravel/framework` — for core Laravel APIs, configuration, or Artisan commands
292- `livewire` — for component lifecycle, wire directives, or Alpine.js integration
293
294---
295
296## Integration Points
297
298| Skill | How It Connects |
299|---|---|
300| `laravel-specialist` | Boost guidelines and skills enhance AI-generated Laravel code quality |
301| `php-specialist` | Boost respects PHP version and PSR standards in generated guidelines |
302| `mcp-builder` | Boost's MCP server is an example of the MCP pattern; extend it for custom tools |
303| `self-learning` | Boost's Application Info tool feeds project context into the learning phase |
304| `senior-backend` | Boost's Database Schema and Query tools support backend architecture decisions |
305| `test-driven-development` | Boost's Pest skill provides testing patterns for AI-generated tests |
306
307## Skill Type
308
309**FLEXIBLE** — Adapt the process phases to what the project needs. A new project requires full installation and IDE setup (Phases 1-4). An existing Boost installation may only need customization (Phase 3) or validation after a Laravel upgrade (Phase 4). The non-negotiable minimum: verify MCP server connectivity and confirm guidelines match installed package versions.