revolution/laravel-boost-phpstorm-copilot

Laravel Boost Custom Agent for PhpStorm with GitHub Copilot plugin

Docs: English Japanese

Requirements

• PHP >= 8.3
• Laravel >= 12.x
• Laravel Boost >= 2.0
• GitHub Copilot plugin installed in PhpStorm

Suggest

• laravel-copilot-sdk Copilot SDK for Laravel

Supported Platforms

• macOS
• Windows (Native Windows)
• Linux

Laravel Sail

It also supports Laravel Sail. Before use, start it with vendor/bin/sail up -d.

WSL (Windows Subsystem for Linux)

This package supports WSL environments where PhpStorm runs on native Windows and PHP runs in WSL. This is a common development setup that provides Windows IDE features with Linux development environment.

Requirements for WSL

• wslu package must be installed in WSL
• Check if installed: wslvar -v
• Install if needed: sudo apt install wslu
• Ensure your user profile is on the C drive (default location)

1. Detection: Automatically detects WSL environment by checking WSL_DISTRO_NAME environment variable
2. Path Resolution: Uses wslvar LOCALAPPDATA to get Windows AppData\Local path (e.g., C:\Users\YourUsername\AppData\Local)
3. File Writing: Writes MCP config to Windows side via PowerShell commands
   • Creates temporary file in Windows %TEMP% directory
   • Uses Base64 encoding to safely transfer JSON content
   • Copies to final location: %LOCALAPPDATA%\github-copilot\intellij\mcp.json
4. Path Handling: Converts WSL paths to Windows paths for absolute command and artisan paths

• Ensure wslu is installed and wslvar command works
• Check that PowerShell is accessible from WSL with powershell.exe -Command "Write-Output 'test'"
• Verify Windows LOCALAPPDATA path with wslvar LOCALAPPDATA (should return C:\Users\YourUsername\AppData\Local)
• If MCP config file is not created, check Windows directory permissions
• Ensure your user profile is on the C drive (default location)
• [error] WSL Interoperability is disabled. Please enable it before using WSL. If you see this error, enable WSL Interop by adding the following binfmt configuration:

echo ":WSLInterop:M::MZ::/init:PF" | sudo tee /usr/lib/binfmt.d/WSLInterop.conf
sudo systemctl restart systemd-binfmt

Remote Development

Because it is not possible to distinguish between a "Windows version of PhpStorm and WSL environment" and a "PhpStorm remote development environment with WSL". The remote development environment is the same as Linux, so if you really want to use it, please configure the MCP file manually. ~/.config/github-copilot/intellij/mcp.json

{
  "servers": {
    "laravel-boost": {
      "command": "/absolute/path/to/php",
      "args": ["/absolute/path/to/laravel/artisan", "boost:mcp"]
    }
  }
}

Recommendation for WSL

Consider using laravel-boost-copilot-cli, which allows you to use a project-level MCP configuration file.

Testbench for Package Developers

Not supported. Please use laravel-boost-copilot-cli instead.

Installation

composer require revolution/laravel-boost-phpstorm-copilot --dev

Usage

When you run the Laravel Boost installation command within your Laravel project, you'll see a PhpStorm with GitHub Copilot item added to the list.

• First, you will see Which Boost features would you like to configure?. The files will be installed depending on the features you select.
  • AI Guidelines: .github/instructions/laravel-boost.instructions.md
  • Agent Skills: .github/skills
  • Boost MCP Server Configuration: A location appropriate for your environment.
• Next, you will see Which AI agents would you like to configure?. Select PhpStorm with GitHub Copilot for the AI agent.

php artisan boost:install

[!NOTE] DO NOT select PhpStorm, it's actually PhpStorm Junie

Important

With PhpStorm and GitHub Copilot plugin, the MCP configuration file is stored in a system-wide location. Therefore, you need to run the boost:install command to update the configuration file whenever you switch Laravel projects. The configuration file contains the absolute path to your Laravel project.

php artisan boost:install --guidelines --skills --mcp --no-interaction

In boost 1.8 and later, the boost:update command does not update the MCP configuration file.

MCP Configuration File Location by OS

• macOS, Linux: ~/.config/github-copilot/intellij/mcp.json
• Windows: %LOCALAPPDATA%\github-copilot\intellij\mcp.json

License

MIT