Skip to content

Commit abcbbcc

Browse files
taylorotwelltaylorotwell
committed
update readme
1 parent 216342e commit abcbbcc

File tree

1 file changed

+47
-46
lines changed

1 file changed

+47
-46
lines changed

‎README.md‎

Lines changed: 47 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -8,99 +8,100 @@
88
</p>
99

1010
## Introduction
11-
Laravel Boost gives you a jump-start with AI assisted coding by making it simple to add everything you need to help AI make good choices.
1211

13-
Core features:
14-
- MCP server with 15+ tools
15-
- Composable AI guidelines for ecosystem packages
16-
- Documentation API with built-in MCP tool, over 15, 000 pieces of knowledge, and semantic search with embeddings
12+
Laravel Boost accelerates AI-assisted development by providing the essential context and structure that AI needs to generate high-quality, Laravel-specific code.
1713

18-
Other features:
19-
- Browser logs streamed to `log/storage/browser.log`
14+
At its foundation 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.
15+
16+
Boost also features a powerful Documentation API that combines a built-in MCP tool with an extensive knowledge base containing over 15,000 pieces of Laravel-specific information, all enhanced by semantic search capabilities using embeddings for precise, context-aware results.
2017

2118
> [!IMPORTANT]
22-
> Boost is in _Beta_ and will be updated frequently.
19+
> Laravel Boost is currently in beta and receives frequent updates as we refine features and expand capabilities.
2320
2421
## Installation
2522

26-
Add the package
23+
Laravel Boost can be installed via Composer:
24+
2725
```bash
2826
composer require laravel/boost --dev
2927
```
3028

31-
Install the MCP server & guidelines
29+
Next, install the MCP server and coding guidelines:
30+
3231
```bash
3332
php artisan boost:install
3433
```
3534

36-
You're ready to go!
35+
Once Laravel Boost has been installed, you're ready to start coding with Cursor, Claude Code, or your AI agent of choice.
3736

3837
## Available MCP Tools
3938

4039
| Name | Notes |
4140
| -------------------------- |----------------------------------------------------------------------------------------------------------------|
42-
| Application Info | Shares PHP & Laravel versions, database engine, list of ecosystem packages with versions, and Eloquent models. |
43-
| Browser Logs | Read logs & errors from the browser |
44-
| Database Connections | List database connections, and the default |
45-
| Database Query | |
46-
| Database Schema | |
47-
| Get Absolute Url | Converts relative path to absolute so AI doesn't give you invalid URLs |
48-
| Get Config | Get specific value from config using dot notation |
49-
| Last Error | From the log files |
50-
| List Artisan Commands | |
51-
| List Available Config Keys | |
52-
| List Available Env Vars | Keys only |
53-
| List Routes | Regular & folio routes are combined. Ability to filter routes too |
54-
| Read Log Entries | Last X entries |
55-
| Report Feedback | Share Boost & Laravel AI feedback with the team, just say "give Boost feedback: x, y, and z" |
56-
| Search Docs | Use hosted API service to retrieve docs based on installed packages |
57-
| Tinker | Run arbitrary code within the context of the project |
41+
| Application Info | Read PHP & Laravel versions, database engine, list of ecosystem packages with versions, and Eloquent models |
42+
| Browser Logs | Read logs and errors from the browser |
43+
| Database Connections | Inspect available database connections, including the default connection |
44+
| Database Query | Execute a query against the database |
45+
| Database Schema | Read the database schema |
46+
| Get Absolute URL | Convert relative path URIs to absolute so agents generate valid URLs |
47+
| Get Config | Get a value from the configuration files using "dot" notation |
48+
| Last Error | Read the last error from the application's log files |
49+
| List Artisan Commands | Inspect the available Artisan commands |
50+
| List Available Config Keys | Inspect the available configuration keys |
51+
| List Available Env Vars | Inspect the available environment variable keys |
52+
| List Routes | Inspect the application's routes |
53+
| Read Log Entries | Read the last N log entries |
54+
| Report Feedback | Share Boost & Laravel AI feedback with the team, just say "give Boost feedback: x, y, and z" |
55+
| Search Docs | Query the Laravel hosted documentation API service to retrieve documentation based on installed packages |
56+
| Tinker | Execute arbitrary code within the context of the application |
5857

5958
## Available AI Guidelines
6059

6160
| Package | Versions Supported |
6261
|---------|-------------------|
6362
| Core & Boost | core |
64-
| Laravel Framework | core, v10, v11, v12 |
65-
| Livewire | core, v2, v3 |
63+
| Laravel Framework | core, 10.x, 11.x, 12.x |
64+
| Livewire | core, 2.x, 3.x |
6665
| Flux UI | core, free, pro |
6766
| Herd | core |
68-
| Inertia Laravel | core, v1, v2 |
69-
| Inertia React | core, v1, v2 |
70-
| Inertia Vue | core, v1, v2 |
71-
| Pest | core, v4 |
67+
| Inertia Laravel | core, 1.x, 2.x |
68+
| Inertia React | core, 1.x, 2.x |
69+
| Inertia Vue | core, 1.x, 2.x |
70+
| Pest | core, 4.x |
7271
| PHPUnit | core |
7372
| Pint | core |
74-
| TailwindCSS | core, v3, v4 |
73+
| TailwindCSS | core, 3.x, 4.x |
7574
| Livewire Volt | core |
7675
| Laravel Folio | core |
77-
| Enforce tests | conditional |
76+
| Enforce Tests | conditional |
7877

7978

80-
## Available documentation
79+
## Available Documentation
8180

8281
| Package | Versions Supported |
8382
|---------|-------------------|
84-
| Laravel Framework | v10, v11, v12 |
85-
| Flux UI | v2 Free, v2 Pro |
86-
| Inertia | v1, v2 |
87-
| Livewire | v1, v2, v3 |
88-
| Pest | v3, v4 |
83+
| Laravel Framework | 10.x, 11.x, 12.x |
84+
| Flux UI | Free, 2.x, Pro |
85+
| Inertia | 1.x, 2.x |
86+
| Livewire | 1.x, 2.x, 3.x |
87+
| Pest | 3.x, 4.x |
8988

9089

91-
## Adding your own AI guidelines
90+
## Adding Custom AI Guidelines
9291

93-
Add `.blade.php` files to `.ai/guidelines/*` in your project, and they'll be included with Boost guidelines when you run `boost:install`.
92+
To augment Laravel Boost with your own custom AI guidelines, add `.blade.php` files to your application's `.ai/guidelines/*` directory. These files will automatically be included with Laravel Boost's guidelines when you run `boost:install`.
9493

95-
## Adding Boost MCP manually
96-
Create the necessary config for your code editor using these details.
94+
## Manually Registering the Boost MCP Server
95+
96+
Sometimes you may need to manually register the Laravel Boost MCP server with your editor of choice. You should register the MCP server using the following details:
9797

9898
<table>
9999
<tr><td><strong>Command</strong></td><td><code>php</code></td></tr>
100100
<tr><td><strong>Args</strong></td><td><code>./artisan boost:mcp</code></td></tr>
101101
</table>
102102

103-
JSON Example
103+
JSON Example:
104+
104105
```json
105106
{
106107
"mcpServers": {

0 commit comments

Comments
 (0)