Laravel Boost

Вступ

Laravel Boost пришвидшує розробку з допомогою AI, надаючи ключові настанови й навички агентів, які допомагають AI-агентам писати якісні застосунки Laravel відповідно до найкращих практик фреймворку.

Boost також надає потужний API документації екосистеми Laravel, що поєднує вбудований інструмент MCP із великою базою знань, яка містить понад 17 000 фрагментів інформації про Laravel, - усе це підсилено семантичним пошуком на ембедингах для точних результатів з урахуванням контексту. Boost вказує AI-агентам на кшталт Claude Code і Cursor користуватися цим API, щоб дізнаватися про найновіші можливості й найкращі практики Laravel.

Встановлення

Laravel Boost можна встановити через Composer:

composer require laravel/boost --dev

Далі встановіть MCP-сервер і настанови щодо написання коду:

php artisan boost:install

Команда boost:install згенерує відповідні файли настанов і навичок для тих агентів, яких ви обрали під час встановлення.

Коли Laravel Boost встановлено, ви готові писати код у Cursor, Claude Code чи будь-якому іншому AI-агенті на ваш вибір.

Сміливо додавайте згенерований конфігураційний файл MCP (.mcp.json), файли настанов (CLAUDE.md, AGENTS.md, junie/ тощо) та конфігураційний файл boost.json до .gitignore вашого застосунку - ці файли автоматично перегенеровуються під час виконання boost:install і boost:update.

Налаштування агентів

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 support is typically enabled automatically. If you find it isn't, open a shell in the project's directory and run the following command:

claude mcp add -s local -t stdio laravel-boost php artisan boost:mcp

Codex support is typically enabled automatically. If you find it isn't, open a shell in the project's directory and run the following command:

codex mcp add laravel-boost -- php "artisan" "boost:mcp"

Gemini CLI support is typically enabled automatically. If you find it isn't, open a shell in the project's directory and run the following command:

gemini mcp add -s project -t stdio laravel-boost php artisan boost:mcp

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"

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

Оновлення ресурсів Boost

Вам, можливо, варто час від часу оновлювати локальні ресурси Boost (настанови для AI та навички), щоб вони відповідали найновішим версіям встановлених у вас пакетів екосистеми Laravel. Для цього скористайтеся артизан-командою boost:update.

php artisan boost:update

Ви також можете автоматизувати цей процес, додавши команду до скриптів Composer «post-update-cmd»:

{
  "scripts": {
    "post-update-cmd": [
      "@php artisan boost:update --ansi"
    ]
  }
}

За замовчуванням команда boost:update оновлюватиме лише ті ресурси Boost, які вже опубліковано у вашому застосунку. Якщо ви хочете, щоб Boost просканував ваш застосунок на нововстановлені пакети й запропонував опублікувати відповідні настанови й навички, скористайтеся опцією --discover:

php artisan boost:update --discover

MCP-сервер

Laravel Boost надає MCP-сервер (Model Context Protocol), який відкриває AI-агентам інструменти для взаємодії з вашим застосунком Laravel. Ці інструменти дають агентам змогу оглядати структуру застосунку, робити запити до бази даних, виконувати код тощо.

Доступні інструменти MCP

Ручна реєстрація MCP-сервера

Іноді вам може знадобитися зареєструвати MCP-сервер Laravel Boost у вашому редакторі вручну. Реєструйте MCP-сервер із такими даними:

Command	php
Args	artisan boost:mcp

Приклад JSON:

{
    "mcpServers": {
        "laravel-boost": {
            "command": "php",
            "args": ["artisan", "boost:mcp"]
        }
    }
}

Настанови для AI

Настанови для AI - це складані файли інструкцій, які завантажуються наперед, щоб дати AI-агентам ключовий контекст про пакети екосистеми Laravel. Ці настанови містять основні угоди, найкращі практики та специфічні для фреймворку патерни, які допомагають агентам генерувати послідовний і якісний код.

Доступні настанови для AI

Laravel Boost містить настанови для AI для таких пакетів і фреймворків. Настанови core дають загальні поради AI щодо відповідного пакета, застосовні до всіх версій.

Примітка: щоб тримати настанови для AI актуальними, дивіться розділ Оновлення ресурсів Boost.

Додавання власних настанов для AI

Щоб доповнити Laravel Boost власними настановами для AI, додайте файли .blade.php чи .md до каталогу .ai/guidelines/* вашого застосунку. Ці файли автоматично потраплять до настанов Laravel Boost, коли ви виконаєте boost:install.

Перевизначення настанов Boost

Ви можете перевизначити вбудовані настанови Boost для AI, створивши власні настанови з такими самими шляхами до файлів. Коли ви створюєте власну настанову, шлях якої збігається зі шляхом наявної настанови Boost, Boost використає вашу версію замість вбудованої.

Наприклад, щоб перевизначити настанови Boost «Inertia React v2 Form Guidance», створіть файл .ai/guidelines/inertia-react/2/forms.blade.php. Коли ви виконаєте boost:install, Boost включить вашу настанову замість стандартної.

Настанови для AI у сторонніх пакетах

Якщо ви підтримуєте сторонній пакет і хочете, щоб Boost включав настанови для AI щодо нього, додайте до пакета файл resources/boost/guidelines/core.blade.php. Коли користувачі вашого пакета виконають php artisan boost:install, Boost автоматично завантажить ваші настанови.

Настанови для AI мають коротко описувати, що робить ваш пакет, окреслювати потрібну структуру файлів чи угоди й пояснювати, як створювати чи використовувати його основні можливості (з прикладами команд або фрагментами коду). Тримайте їх стислими, дієвими й зосередженими на найкращих практиках, щоб AI міг генерувати правильний код для ваших користувачів. Ось приклад:

## Package Name

This package provides [brief description of functionality].

### Features

- Feature 1: [clear & short description].
- Feature 2: [clear & short description]. Example usage:

@verbatim
<code-snippet name="How to use Feature 2" lang="php">
$result = PackageName::featureTwo($param1, $param2);
</code-snippet>
@endverbatim

Навички агентів

Навички агентів - це легкі цільові модулі знань, які агенти можуть активувати на вимогу, працюючи в конкретних доменах. На відміну від настанов, які завантажуються наперед, навички дозволяють підтягувати детальні патерни й найкращі практики лише тоді, коли вони доречні, - це зменшує роздування контексту й підвищує релевантність згенерованого AI коду.

Коли ви виконуєте boost:install і обираєте навички як можливість, вони встановлюються автоматично - за пакетами, виявленими у вашому composer.json. Наприклад, якщо ваш проєкт містить livewire/livewire, навичку livewire-development буде встановлено автоматично.

Доступні навички

Примітка: щоб тримати навички актуальними, дивіться розділ Оновлення ресурсів Boost.

Власні навички

Щоб створити власні навички, додайте файл SKILL.md до каталогу .ai/skills/{skill-name}/ вашого застосунку. Коли ви виконаєте boost:update, ваші навички буде встановлено разом із вбудованими навичками Boost.

Наприклад, щоб створити власну навичку для доменної логіки вашого застосунку:

.ai/skills/creating-invoices/SKILL.md

Перевизначення навичок

Ви можете перевизначити вбудовані навички Boost, створивши власні навички з такими самими іменами. Коли ви створюєте власну навичку, ім'я якої збігається з іменем наявної навички Boost, Boost використає вашу версію замість вбудованої.

Наприклад, щоб перевизначити навичку Boost livewire-development, створіть файл .ai/skills/livewire-development/SKILL.md. Коли ви виконаєте boost:update, Boost включить вашу навичку замість стандартної.

Навички у сторонніх пакетах

Якщо ви підтримуєте сторонній пакет і хочете, щоб Boost включав навички щодо нього, додайте до пакета файл resources/boost/skills/{skill-name}/SKILL.md. Коли користувачі вашого пакета виконають php artisan boost:install, Boost автоматично встановить ваші навички відповідно до їхніх уподобань.

Навички Boost підтримують формат Agent Skills і мають бути оформлені як каталог із файлом SKILL.md, що містить YAML-хедер та інструкції в Markdown. Файл SKILL.md має містити обов'язковий хедер (name та description), а також може за бажання містити скрипти, шаблони й довідкові матеріали.

Навички мають окреслювати потрібну структуру файлів чи угоди й пояснювати, як створювати чи використовувати основні можливості (з прикладами команд або фрагментами коду). Тримайте їх стислими, дієвими й зосередженими на найкращих практиках, щоб AI міг генерувати правильний код для ваших користувачів:

---
name: package-name-development
description: Build and work with PackageName features, including components and workflows.
---

# Package Name Development

## When to use this skill
Use this skill when working with PackageName features...

## Features

- Feature 1: [clear & short description].
- Feature 2: [clear & short description]. Example usage:

$result = PackageName::featureTwo($param1, $param2);

Настанови проти навичок

Laravel Boost надає два різні способи дати AI-агентам контекст про ваш застосунок: настанови та навички.

Настанови завантажуються наперед при старті AI-агента й дають ключовий контекст про угоди та найкращі практики Laravel, які широко застосовні у всій вашій кодовій базі.

Навички активуються на вимогу під час роботи над конкретними завданнями й містять детальні патерни для окремих доменів (як-от компоненти Livewire чи тести Pest). Завантаження навичок лише за потреби зменшує роздування контексту й підвищує якість коду.

API документації

Laravel Boost містить API документації, який дає AI-агентам доступ до великої бази знань із понад 17 000 фрагментів інформації про Laravel. Цей API використовує семантичний пошук на ембедингах, щоб видавати точні результати з урахуванням контексту.

Інструмент MCP Search Docs дозволяє агентам робити запити до хостованого сервісу API документації Laravel і отримувати документацію за встановленими у вас пакетами. Настанови й навички Boost автоматично вкажуть вашому агенту користуватися цим API.

Розширення Boost

Boost працює з багатьма популярними IDE та AI-агентами одразу з коробки. Якщо ваш інструмент ще не підтримується, ви можете створити власного агента й інтегрувати його з Boost.

Додавання підтримки інших IDE та AI-агентів

Щоб додати підтримку нової IDE чи AI-агента, створіть клас, який успадковує Laravel\Boost\Install\Agents\Agent, і реалізуйте один чи кілька таких контрактів - залежно від ваших потреб:

• Laravel\Boost\Contracts\SupportsGuidelines - додає підтримку настанов для AI.
• Laravel\Boost\Contracts\SupportsMcp - додає підтримку MCP.
• Laravel\Boost\Contracts\SupportsSkills - додає підтримку навичок агентів.

Написання агента

<?php

declare(strict_types=1);

namespace App;

use Laravel\Boost\Contracts\SupportsGuidelines;
use Laravel\Boost\Contracts\SupportsMcp;
use Laravel\Boost\Contracts\SupportsSkills;
use Laravel\Boost\Install\Agents\Agent;

class CustomAgent extends Agent implements SupportsGuidelines, SupportsMcp, SupportsSkills
{
    // Your implementation...
}

Приклад реалізації дивіться в ClaudeCode.php.

Реєстрація агента

Зареєструйте свого агента в методі boot класу App\Providers\AppServiceProvider вашого застосунку:

use Laravel\Boost\Boost;

public function boot(): void
{
    Boost::registerAgent('customagent', CustomAgent::class);
}

Коли агента зареєстровано, він буде доступний для вибору під час виконання php artisan boost:install.