Laravel Artisan MCP

A Laravel Artisan command execution server based on the MCP protocol, which securely manages local Laravel projects through an AI assistant

Developer tools Artificial intelligence chatbots #Laravel management #Command execution #AI integration #Local development .Python

rating : 2.5 points

downloads : 14

update time : 2025-04-28

What is Laravel Artisan MCP Server?

Laravel Artisan MCP Server is a secure server that allows you to manage and execute Artisan commands in Laravel applications through natural language conversations. It is a powerful bridge that connects AI assistants with your local Laravel projects.

How to use Laravel Artisan MCP Server?

You can start using it in just a few steps. First, install the server, then configure the environment variables, and finally integrate and use it in an AI assistant (such as Claude).

Applicable scenarios

Suitable for developers, operations personnel, and teams that need to quickly manage Laravel projects.

Main features

Single directory accessLimited to the specified Laravel project directory to ensure security.

Automatic PHP detectionAutomatically find the PHP path on the system without manual configuration.

Command whitelistOnly execute pre-approved Artisan commands to prevent accidental operations.

Comprehensive input validationStrictly validate all inputs to avoid potential security risks.

Error handlingPrevent the leakage of sensitive information and improve stability.

Advantages and limitations

Advantages

Easily manage Laravel projects through natural language.

Support command whitelisting to reduce misoperations.

Automatically detect the PHP path to simplify the installation process.

Provide detailed error feedback and logging.

Support integration with multiple AI assistants for high flexibility.

Limitations

Requires installation and configuration in the local environment.

May require additional permission settings.

Need to carefully configure the whitelist when using in a production environment.

Depends on the correct installation of PHP and Python.

How to use

Clone the code repository

Use Git to clone this project locally.

Initialize the virtual environment

Create and activate the virtual environment.

Install dependencies

Install the required Python dependencies.

Configure environment variables

Set the ARTISAN_DIRECTORY and WHITELISTED_COMMANDS variables.

Start the server

Run the server to listen for MCP requests.

Usage examples

Case 1: View all routesQuery all available routes through natural language.

Case 2: Clear the cacheClear the cache to improve performance.

Case 3: Create a controllerCreate a new controller through an AI assistant.

Frequently Asked Questions

What happens if ARTISAN_DIRECTORY is not provided?

Why can't the Artisan command be found?

What if PHP is not found?

How to ensure security?

Related resources

GitHub code repository

Project source code and documentation.

Official documentation

Detailed usage guide and API reference.

Video tutorial

Quick start guide.

🚀 Laravel Artisan MCP Server

A Model Context Protocol (MCP) server that allows secure execution of Laravel Artisan commands via Claude and other MCP clients. This server acts as a bridge between the AI assistant and your local Laravel application, enabling controlled management of Laravel projects through natural language conversations.

✨ Features

Access a single directory containing a Laravel project.
Automatically locate PHP in the system.
Execute only whitelisted Artisan commands.
View all available Artisan commands.
Designed with security in mind, featuring robust input validation.

🖼️ Examples

Example

📋 Requirements

Python 3.10 or higher.
A Laravel project with the Artisan CLI.
PHP installed and accessible in the PATH.
An MCP-compatible client (e.g., Claude Desktop).

📦 Installation

Clone the repository:

git clone https://github.com/diggy/laravel-artisan-mcp.git
cd laravel-artisan-mcp

Create a virtual environment and install dependencies:

python -m venv venv
source venv/bin/activate  # Use `venv\Scripts\activate` on Windows
pip install -r requirements.txt

Run the server:
```
python server.py
```

⚙️ Configuration

Edit the configuration file config.py and set the following parameters:

ARTISAN_DIRECTORY: Specify your Laravel project directory.
COMMAND_WHITELIST: List the allowed commands.

💻 Usage Examples

Basic Usage

# Execute an Artisan command
python server.py --command "php artisan migrate"

# Display help information
python server.py --help

⚠️ Security Considerations

Directory Isolation: Only access the specified Laravel directory.
Command Whitelisting: Execute only specifically allowed commands.
Input Validation: Validate all inputs before execution.
Error Handling: Prevent the leakage of sensitive information.

🛠️ Troubleshooting

"ARTISAN_DIRECTORY must be provided in the configuration"

The server cannot find your Laravel project path. Check the following:

Whether the environment variables are set correctly.
Whether the directory exists and is accessible.

"Artisan not found in /path/to/artisan"

The specified directory does not contain the Artisan executable. Verify the following:

Whether the path points to a valid Laravel project directory.
Whether the Artisan file exists and has executable permissions.

"PHP executable not found"

The server cannot find PHP in the PATH. Ensure the following:

PHP is installed.
The PHP executable is in the system PATH.

📄 Disclaimer

This Laravel Artisan MCP server is provided as-is, without any form of warranty or guarantee. By using this software, you agree to assume all risks associated with its operation. This server can execute commands in a development or testing environment, which may affect your application data and functionality. We strongly recommend using this tool in a production Laravel application only after understanding its security implications and implementing appropriate safeguards. Always back up your Laravel project before allowing an AI assistant to execute Artisan commands through this interface. This software has not undergone a formal security audit and should be considered experimental. Use at your own risk.

📄 License

This project is released under the MIT License - see the LICENSE file for details.

👨‍💻 Author

This MCP server was developed with the assistance of Claude (Anthropic's AI assistant), who insisted on adding this humble note of thanks while promising to avoid emojis or excessive enthusiasm.