|
1 | | -## Boost |
2 | | -- Boost MCP comes with powerful tools designed specifically for this application. Use them. |
| 1 | +## Laravel Boost |
| 2 | +- Laravel Boost is an MCP server that comes with powerful tools designed specifically for this application. Use them. |
| 3 | + |
| 4 | +## Artisan |
| 5 | +- Use the `list-artisan-commands` tool when you need to call an Artisan command to double check the available parameters. |
3 | 6 |
|
4 | 7 | ## URLs |
5 | 8 | - Whenever you share a project URL with the user you should use the `get-absolute-url` tool to ensure you're using the correct scheme, domain / IP, and port. |
6 | 9 |
|
7 | | -## Artisan |
8 | | -- Use the `list-artisan-commands` tool when you need to call an artisan command to triple check the available parameters. |
9 | | - |
10 | 10 | ## Tinker / Debugging |
11 | | -- You should use the `tinker` tool from Boost MCP when you need to run PHP to debug code or query Eloquent models directly. |
| 11 | +- You should use the `tinker` tool when you need to execute PHP to debug code or query Eloquent models directly. |
12 | 12 | - Use the `database-query` tool when you only need to read from the database. |
13 | 13 |
|
14 | | -@if(config('boost.browser_logs', true) !== false || config('boost.browser_logs_watcher', true) !== false) |
15 | | -## Reading browser logs with the `browser-logs` tool |
16 | | -- You can read browser logs, errors, and exceptions with the `browser-logs` tool from Boost. |
17 | | -- Only recent browser logs will be useful, ignore old logs. |
| 14 | +@if (config('boost.browser_logs', true) !== false || config('boost.browser_logs_watcher', true) !== false) |
| 15 | +## Reading Browser Logs With the `browser-logs` Tool |
| 16 | +- You can read browser logs, errors, and exceptions using the `browser-logs` tool from Boost. |
| 17 | +- Only recent browser logs will be useful - ignore old logs. |
18 | 18 | @endif |
19 | 19 |
|
20 | | -## Searching documentation (critically important) |
21 | | -- Boost comes with a powerful `search-docs` tool you should use before any other approaches. This tool automatically passes a list of installed packages and their versions to the remote Boost API, so it returns only version-specific documentation specific for the user's circumstance. You should pass an array of packages to filter docs on if you know you need docs for particular packages. |
22 | | -- The 'search-docs' tool is perfect for all Laravel related packages. Laravel, Inertia, Pest, Livewire, Nova, Nightwatch, etc.. |
23 | | -- You must use this tool to search for Laravel-ecosystem docs before falling back to other approaches. |
24 | | -- Search the docs before making code changes to ensure we are approaching this in the correct way. |
25 | | -- Use multiple broad simple topic based queries to start, i.e. `rate limiting##routing rate limiting##routing`. |
| 20 | +## Searching Documentation (Critically Important) |
| 21 | +- Boost comes with a powerful `search-docs` tool you should use before any other approaches. This tool automatically passes a list of installed packages and their versions to the remote Boost API, so it returns only version-specific documentation specific for the user's circumstance. You should pass an array of packages to filter on if you know you need docs for particular packages. |
| 22 | +- The 'search-docs' tool is perfect for all Laravel related packages, including Laravel, Inertia, Livewire, Pest, Nova, Nightwatch, etc. |
| 23 | +- You must use this tool to search for Laravel-ecosystem documentation before falling back to other approaches. |
| 24 | +- Search the documentation before making code changes to ensure we are taking the correct approach. |
| 25 | +- Use multiple, broad, simple, topic based queries to start. For example: `rate limiting##routing rate limiting##routing`. |
26 | 26 |
|
27 | | -### Available search syntax |
28 | | -- You can and should pass multiple queries at once, the most relevant results will be returned first. |
| 27 | +### Available Search Syntax |
| 28 | +- You can and should pass multiple queries at once. The most relevant results will be returned first. |
29 | 29 |
|
30 | 30 | 1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth' |
31 | 31 | 2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit" |
32 | 32 | 3. Quoted Phrases (Exact Position) - query="infinite scroll - Words must be adjacent and in that order |
33 | 33 | 4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit" |
34 | 34 | 5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms |
35 | | - |
0 commit comments