Laravel Boost

• Вступ
• Встановлення
  • Оновлення ресурсів Boost
  • Налаштуйте свої агентів
• Сервер MCP
  • Доступні інструменти MCP
  • Ручна реєстрація MCP сервера
• Рекомендації щодо ШІ
  • Доступні AI настанови
  • Додавання власних AI-інструкцій
  • Перевизначення Boost AI Guidelines
  • Керівництво щодо використання AI у сторонніх пакетах
• Навички агентів
  • Доступні навички
  • Користувацькі навички
  • Перевизначення навичок
  • Навички роботи з пакетами сторонніх розробників
• Керівні принципи vs. Навички
• Документація API
• Розширення Boost
  • Додавання підтримки інших IDE / AI агентів

Вступ

Laravel Boost прискорює розробку з підтримкою ШІ, надаючи необхідні рекомендації та навички агентів, які допомагають агентам ШІ створювати високоякісні застосунки Laravel, що відповідають найкращим практикам Laravel.

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

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

Laravel Boost можна встановити за допомогою компонувальника:

composer require laravel/boost --dev

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

php artisan boost:install

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

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

Налаштуйте свої агентів

1. Відкрити палітру команд (`Cmd+Shift+P` чи `Ctrl+Shift+P`)
2. Натисніть `enter` на "/open MCP Settings"
3. Увімкніть перемикач для `laravel-boost`

Підтримка 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

1. Відкрити палітру команд (`Cmd+Shift+P` or `Ctrl+Shift+P`)
2. Натисніть `enter` на"MCP: List Servers"
3. Перейдіть стрілками до `laravel-boost` і натисніть `enter`
4. Виберіть"Start server"

1. Натисніть `shift` двічі, щоб відкрити палітру команд
2. Знайдіть "MCP Settings" і натисніть `enter`
3. Поставте галочку поруч із `laravel-boost`
4. Натисніть "Apply" внизу праворуч

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

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

php artisan boost:update

Ви також можете автоматизувати цей процес, додавши його до ваших сценаріїв "post-update-cmd" компонувальника:

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

Сервер MCP

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

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

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

Іноді вам може знадобитися вручну зареєструвати сервер Laravel Boost MCP у вашому редакторі. Ви повинні зареєструвати сервер MCP, використовуючи такі дані:

Приклад JSON:

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

AI-інструкції

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

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

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

Додавання власних AI-інструкцій

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

Перевизначення Boost AI Guidelines

Ви можете перевизначити вбудовані AI-інструкції Boost, створивши власні інструкції з відповідними шляхами до файлів. Коли ви створюєте власну інструкцію, шлях якої збігається з існуючим шляхом інструкції 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 міг генерувати коректний код для ваших користувачів. Ось приклад:

## Назва пакета
 
Цей пакет надає [короткий опис функціональності].
 
### Features
 
- Функція 1: [чіткий і короткий опис].
- Функція 2: [чіткий і короткий опис]. Приклад використання:
 
@verbatim
<code-snippet name="Як використовувати функцію 2" lang="php">
$result = PackageName::featureTwo($param1, $param2);
</code-snippet>
@endverbatim

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

Agent Skills — це легкі, цілеспрямовані модулі знань, які агенти можуть активувати за потреби під час роботи в конкретних доменах. На відміну від інструкцій, які завантажуються заздалегідь, skills дозволяють завантажувати детальні шаблони та найкращі практики лише тоді, коли це доречно, зменшуючи перевантаження контексту та підвищуючи релевантність коду, згенерованого ШІ.

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

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

Користувацькі навички

Щоб створити власні користувацькі навички, додайте файл 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 Skills підтримують формат Agent Skills і повинні бути структуровані як папка, що містить файл SKILL.md з YAML-фронтматером і інструкціями у форматі Markdown. Файл SKILL.md повинен містити обов'язковий фронтматер (name і description), а також може додатково містити скрипти, шаблони та довідкові матеріали.

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

---
name: package-name-development
description: Створюйте та працюйте з функціями PackageName, включаючи компоненти та робочі процеси.
---
 
# Розробка PackageName
 
## Коли використовувати цю навичку
Використовуйте цю навичку під час роботи з функціями PackageName...
 
## Функції
 
- Функція 1: [чіткий і короткий опис].
- Функція 2: [чіткий і короткий опис]. Приклад використання:
 
$result = PackageName::featureTwo($param1, $param2);

Керівні принципи vs. Навички

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

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

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

Документація API

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

Інструмент MCP Пошук у документації дозволяє агентам здійснювати запити до API-сервісу документації Laravel для отримання документації на основі встановлених у вас пакетів. AI-інструкції та навички 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
{
    // Ваша реалізація...
}

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

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

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

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

Після реєстрації ваш агент буде доступний для вибору під час виконання php artisan boost:install.