 |
VOOZH | about |
|
VOOZH | about |
This page documents the installFileMcp() method and related processes that generate the system-wide mcp.json configuration file. This configuration file enables PhpStorm's GitHub Copilot plugin to communicate with the boost:mcp MCP server.
For platform-specific file writing mechanisms (WSL, PowerShell), see page 5 (Platform-Specific Implementations). For method signatures, see page 8.1 (PhpStormCopilot Class API).
The installFileMcp() method in the PhpStormCopilot class src/PhpStormCopilot.php119-132 orchestrates MCP configuration generation. This method is invoked by the parent Agent class's installation workflow when a user runs php artisan boost:install and selects MCP configuration.
The method performs environment detection, command transformation, and delegates to platform-specific writers.
installFileMcp() Method Flow
Sources: src/PhpStormCopilot.php119-132
The useAbsolutePathForMcp() method src/PhpStormCopilot.php29-32 returns true, instructing the parent Agent class to use absolute paths for the PHP binary and artisan script in the generated configuration.
| Method | Return Type | Source |
|---|---|---|
useAbsolutePathForMcp() | bool | src/PhpStormCopilot.php29-32 |
getPhpPath() | string | Inherited from Laravel\Boost\Install\Agents\Agent |
getArtisanPath() | string | Inherited from Laravel\Boost\Install\Agents\Agent |
base_path() | string | Laravel helper function |
Path Resolution in Configuration Generation
Sources: src/PhpStormCopilot.php29-32
The mcpConfigKey() method src/PhpStormCopilot.php99-102 returns "servers", defining the top-level key in the mcp.json structure.
JSON Structure Generated by installFileMcp()
For a typical macOS/Linux environment without Sail:
Sources: .github/copilot-instructions.md102-116 src/PhpStormCopilot.php99-102
The transformSailCommand() method src/PhpStormCopilot.php141-162 handles Laravel Sail command wrapping, while transformMcpCommandForWsl() src/Concerns/WithWSL.php85-128 handles WSL command transformation.
Sail Command Detection and Transformation
| Input Command | Input Args | Method Called | Output Command | Output Args |
|---|---|---|---|---|
/usr/bin/php | ["artisan", "boost:mcp"] | transformSailCommand() | /usr/bin/php | ["artisan", "boost:mcp"] |
./vendor/bin/sail | ["artisan", "boost:mcp"] | transformSailCommand() | bash | ["-c", "cd /path && ./vendor/bin/sail artisan boost:mcp"] |
./vendor/bin/sail (WSL) | ["artisan", "boost:mcp"] | transformMcpCommandForWsl() | wsl.exe | ["--cd", "/path", "./vendor/bin/sail", "artisan", "boost:mcp"] |
/usr/bin/php (WSL) | ["artisan", "boost:mcp"] | transformMcpCommandForWsl() | wsl.exe | ["--cd", "/path", "/usr/bin/php", "artisan", "boost:mcp"] |
Sources: src/PhpStormCopilot.php141-162
Sources: .github/copilot-instructions.md156-170
The transformMcpCommandForWsl() method src/Concerns/WithWSL.php85-128 wraps commands with wsl.exe for Windows-to-WSL execution.
WSL Command Transformation Logic
Example WSL Configurations
Non-Sail WSL:
Sail WSL:
Sources: src/Concerns/WithWSL.php85-128 .github/copilot-instructions.md120-154
The removeEmptyArrays() method src/PhpStormCopilot.php168-181 recursively removes empty arrays from the configuration. This prevents compatibility issues with MCP clients that fail when encountering empty array fields.
Recursive Empty Array Removal Algorithm
Example Transformation
Input:
Output after removeEmptyArrays():
Sources: src/PhpStormCopilot.php168-181 .github/copilot-instructions.md117-118
The mcpConfigPath() method src/PhpStormCopilot.php104-114 returns the system-wide path where PhpStorm's GitHub Copilot plugin reads its MCP configuration.
Platform-Specific Path Resolution
| Platform | Path Template | Example Output |
|---|---|---|
Platform::Darwin | $HOME/.config/github-copilot/intellij/mcp.json | /Users/dev/.config/github-copilot/intellij/mcp.json |
Platform::Linux | $HOME/.config/github-copilot/intellij/mcp.json | /home/user/.config/github-copilot/intellij/mcp.json |
Platform::Windows | %LOCALAPPDATA%\github-copilot\intellij\mcp.json | C:\Users\User\AppData\Local\github-copilot\intellij\mcp.json |
WSL (via installMcpViaWsl()) | wslvar LOCALAPPDATA result | Windows path accessed from WSL |
Sources: src/PhpStormCopilot.php104-114 .github/copilot-instructions.md63-66
The complete flow from php artisan boost:install invocation to mcp.json file creation.
End-to-End Configuration Generation Sequence
Sources: src/PhpStormCopilot.php119-132 src/PhpStormCopilot.php141-162 src/Concerns/WithWSL.php16-76
Key methods involved in MCP configuration generation:
| Method | File | Lines | Return Type | Description |
|---|---|---|---|---|
installFileMcp() | PhpStormCopilot.php | 119-132 | bool | Main orchestrator; checks environment, delegates to WSL or standard path |
useAbsolutePathForMcp() | PhpStormCopilot.php | 29-32 | bool | Returns true to instruct parent class to use absolute paths |
mcpConfigKey() | PhpStormCopilot.php | 99-102 | string | Returns "servers" as top-level JSON key |
mcpConfigPath() | PhpStormCopilot.php | 104-114 | string | Returns platform-specific system-wide path |
transformSailCommand() | PhpStormCopilot.php | 141-162 | array | Wraps Sail commands in bash -c for proper working directory |
removeEmptyArrays() | PhpStormCopilot.php | 168-181 | array | Recursively removes empty arrays from config |
isRunningInTestbench() | PhpStormCopilot.php | 183-186 | bool | Detects Orchestra Testbench by checking TESTBENCH_CORE constant |
isWSL() | WithWSL.php | 11-14 | bool | Detects WSL by checking WSL_DISTRO_NAME environment variable |
installMcpViaWsl() | WithWSL.php | 16-76 | bool | WSL-specific installation via PowerShell and wslvar |
transformMcpCommandForWsl() | WithWSL.php | 85-128 | array | Wraps commands with wsl.exe for Windows-to-WSL execution |
Sources: src/PhpStormCopilot.php1-187 src/Concerns/WithWSL.php1-130
The installFileMcp() method explicitly rejects execution in Orchestra Testbench environments by checking isRunningInTestbench(), which tests for the TESTBENCH_CORE constant. This restriction exists because Testbench environments lack a proper home directory structure for system-wide MCP configuration.
Sources: src/PhpStormCopilot.php121-123 src/PhpStormCopilot.php183-186 README.md86-88
Refresh this wiki