 |
VOOZH | about |
|
VOOZH | about |
This page documents all MCP (Model Context Protocol) tools available through the laravel-boost MCP server and how to use them effectively with GitHub Copilot CLI. These tools provide AI agents with direct access to your Laravel application's environment, database, documentation, and debugging capabilities.
For information about generating the MCP configuration files that enable these tools, see Configuration Generation. For details about starting Copilot CLI with MCP support, see Starting Copilot CLI.
The laravel-boost MCP server exposes Laravel Boost tools to GitHub Copilot CLI through the Model Context Protocol. When properly configured, the AI agent can invoke these tools to inspect your application, query data, search documentation, and assist with development tasks.
Sources: .github/instructions/laravel-boost.instructions.md6-13
The laravel-boost MCP server and its tools are only available when Copilot CLI is started with the MCP configuration file. If the AI agent reports that it cannot see the laravel-boost server or tools, restart Copilot CLI with:
The --additional-mcp-config option must be specified for every Copilot CLI session to access Laravel Boost MCP tools.
Sources: .github/instructions/laravel-boost.instructions.md6-13
The Laravel Boost MCP tools are organized into functional categories:
| Category | Tools | Purpose |
|---|---|---|
| Documentation | search-docs | Search version-specific Laravel ecosystem documentation |
| Database | database-query, database-schema | Query data and inspect table structures |
| Debugging | tinker, browser-logs | Execute PHP code and read browser logs |
| Application Info | application-info, list-artisan-commands, list-routes | Inspect application configuration and available commands |
| Utilities | get-absolute-url | Generate correct URLs for the application |
| Skills | pest-testing | Activate domain-specific testing capabilities |
Sources: .github/instructions/laravel-boost.instructions.md86-110
The search-docs tool is the most powerful tool for working with Laravel and Laravel ecosystem packages. It provides version-specific documentation by automatically passing installed package versions to the Boost API.
The guidelines instruct AI agents to use search-docs before making code changes to ensure the correct approach is taken. This tool should be used when:
Sources: .github/instructions/laravel-boost.instructions.md104-110
The tool supports multiple query syntaxes for flexible searching:
| Syntax | Example | Behavior |
|---|---|---|
| Simple Words | authentication | Auto-stemming finds "authenticate", "auth", etc. |
| Multiple Words (AND) | rate limit | Finds content with both "rate" AND "limit" |
| Quoted Phrases | "infinite scroll" | Exact phrase, words must be adjacent |
| Mixed Queries | middleware "rate limit" | Combines word and phrase matching |
| Multiple Queries | ["authentication", "middleware"] | Returns results matching ANY query |
Important: Do not include package names in queries. Package information is automatically shared with the API. Use test resource table, not filament 4 test resource table.
Sources: .github/instructions/laravel-boost.instructions.md111-118
Guidelines recommend using multiple, broad, simple, topic-based queries at once:
['rate limiting', 'routing rate limiting', 'routing']
The most relevant results are returned first. The tool can optionally filter by specific packages if you know which packages you need documentation for.
Sources: .github/instructions/laravel-boost.instructions.md107-109
The database-query tool executes read-only database queries. It should be used when you only need to read from the database without modifying data.
Use Cases:
Guidelines Recommendation: Use this tool instead of tinker when only reading from the database.
Sources: .github/instructions/laravel-boost.instructions.md93-97
The database-schema tool inspects database table structures, providing information about columns, types, indexes, and constraints.
Use Cases:
Sources: .github/instructions/laravel-boost.instructions.md93-97
The tinker tool executes arbitrary PHP code within the Laravel application context. This provides interactive access to your application's classes, models, and services.
Use Cases:
Guidelines Recommendation: Use this tool when you need to execute PHP to debug code or query Eloquent models directly.
Sources: .github/instructions/laravel-boost.instructions.md93-97
The browser-logs tool reads browser logs, errors, and exceptions from the application. This is useful for debugging frontend issues and JavaScript errors.
Important: Only recent browser logs are useful. Guidelines instruct AI agents to ignore old logs when analyzing issues.
Sources: .github/instructions/laravel-boost.instructions.md99-102
The list-artisan-commands tool lists all available Artisan commands and their parameters. This is essential before calling Artisan commands to verify available options.
Use Cases:
Sources: .github/instructions/laravel-boost.instructions.md86-88
The list-routes tool lists all registered application routes, including route names, URIs, methods, and middleware.
Use Cases:
route() helperSources: .github/instructions/laravel-boost.instructions.md21
The application-info tool provides metadata about the Laravel application, including Laravel version, PHP version, environment, and installed packages.
Sources: .github/instructions/laravel-boost.instructions.md22
The get-absolute-url tool generates properly formatted URLs for the application, ensuring correct scheme, domain/IP, and port configuration.
Guidelines Recommendation: Whenever sharing a project URL with the user, use this tool to ensure you're using the correct URL format.
Sources: .github/instructions/laravel-boost.instructions.md90-91
Tool availability varies depending on the Laravel environment. The MCP server detects the environment and adjusts tool behavior accordingly.
Sources: .github/instructions/laravel-boost.instructions.md15-24
In a standard Laravel application environment, all MCP tools function normally with full access to:
Orchestra Testbench is used for Laravel package development and provides a limited environment. This environment differs significantly from a typical Laravel project:
Available Tools:
application-info - Works normallylist-artisan-commands - Works normallysearch-docs - Works normallyLimited/Unavailable Tools:
database-query - May return limited or no resultsdatabase-schema - May return limited or no resultslist-routes - May return limited or no resultsContext: There is no full application context, database, or application-specific models in Testbench environments. The guidelines instruct AI agents to focus on package-specific development tasks when working in this environment.
Sources: .github/instructions/laravel-boost.instructions.md15-24
Skills are domain-specific capabilities that can be activated to enhance AI agent behavior in specific contexts. Skills are activated on-demand based on the development task.
The pest-testing skill activates specialized capabilities for working with the Pest PHP testing framework (version 4).
Activation Triggers:
The skill should be activated when:
Critical Guideline: AI agents must activate the pest-testing skill whenever working with Pest or testing-related tasks. Guidelines emphasize not waiting until stuck to activate the skill.
Sources: .github/instructions/laravel-boost.instructions.md46-50 .github/instructions/laravel-boost.instructions.md243-252
Sources: .github/instructions/laravel-boost.instructions.md46-50
When skills are activated, the AI agent should use search-docs to retrieve version-specific documentation. For example, with the pest-testing skill activated, the agent should search for Pest 4 documentation before creating tests.
The guidelines explicitly state: "CRITICAL: ALWAYS use search-docs tool for version-specific Pest documentation and updated code examples."
Sources: .github/instructions/laravel-boost.instructions.md250
The guidelines in .github/instructions/laravel-boost.instructions.md provide AI agents with specific instructions for effective tool usage:
| Guideline | Description |
|---|---|
| Use search-docs first | Search documentation before making code changes |
| Multiple queries | Use broad, simple, topic-based queries simultaneously |
| No package names | Don't add package names to queries; versions are auto-shared |
| Prefer database-query | Use for read-only operations instead of tinker |
| Check schema first | Use database-schema before writing migrations/models |
| Verify commands | Use list-artisan-commands to check available parameters |
| Generate URLs correctly | Use get-absolute-url for project URLs |
| Activate skills early | Don't wait until stuck to activate domain skills |
| Environment awareness | Be aware of limited tool availability in Testbench |
Sources: .github/instructions/laravel-boost.instructions.md86-110
Refresh this wiki