Laravel MCP

🚀 Laravel MCP Documentation

Laravel MCP is a package that allows Laravel applications to communicate with AI assistants and other systems through a standardized API. It provides developers with a simple way to extend application functionality and enable interaction with external tools and services.

🚀 Quick Start

📦 Installation

To install Laravel MCP, run the following command:

composer require laravel/mcp

💻 Usage Examples

🔧 Setting up the MCP Server

To create an MCP server, follow these steps:

1. Create a new command file in the app/Console/Commands directory, for example, McpServerCommand.php.
2. Add the following code to the file:

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use InnoGE\LaravelMCP\Tools\ServesMcpServer;

class McpServerCommand extends Command
{
    /**
     * The signature of the command.
     *
     * @return string
     */
    protected function signature(): string
    {
        return 'mcp:serve';
    }

    /**
     * The description of the command.
     *
     * @return string
     */
    protected function description(): string
    {
        return 'Start the MCP server.';
    }

    /**
     * Execute the command.
     *
     * @return int
     */
    public function handle()
    {
        $this->registerMcpServer();
        return 0;
    }

    protected function registerMcpServer()
    {
        // Register the MCP server here
    }
}

3. Register the command in app/Console/Kernel.php:

protected function commands()
{
    require app_path('Console/Commands/McpServerCommand.php');
}

4. Start the server:

php artisan mcp:serve

📚 Resources

🌟 Concept

Resources are the core feature of the MCP server, allowing external systems to query and manipulate data. For example, you can create a resource to represent users in your application.

🆕 Creating a Resource

Create a new model file in the app/Models directory, for example, UserResource.php:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use InnoGE\LaravelMCP\Resources\Resource;

class UserResource extends Model implements Resource
{
    protected $table = 'users';
}

📝 Registering a Resource

Register the resource in app/Providers/AppServiceProvider.php:

public function register()
{
    // Register the user resource
    $this->app->singleton(UserResource::class, function () {
        return new UserResource();
    });
}

🛠️ Tools

🌟 Concept

Tools are the core feature of the MCP server, allowing external systems to operate the application by executing commands. For example, you can create a tool to send emails.

🆕 Creating a Tool

Create a new tool file in the app/Tools directory, for example, SendEmailTool.php:

<?php

namespace App\Tools;

use InnoGE\LaravelMCP\Tools\Tool;

class SendEmailTool implements Tool
{
    /**
     * Get the tool name.
     */
    public function getName(): string
    {
        return 'send-email';
    }

    /**
     * Get the tool description.
     */
    public function getDescription(): string
    {
        return 'Send an email.';
    }

    /**
     * Get the input schema.
     */
    public function getInputSchema(): array
    {
        return [
            'type' => 'object',
            'properties' => [
                'to' => [
                    'type' => 'string',
                    'description' => 'The recipient\'s email address.',
                ],
                'subject' => [
                    'type' => 'string',
                    'description' => 'The email subject.',
                ],
                'body' => [
                    'type' => 'string',
                    'description' => 'The email body content.',
                ],
            ],
            'required' => ['to', 'subject', 'body'],
        ];
    }

    /**
     * Execute the tool.
     */
    public function execute(array $parameters): string
    {
        // Implement the email sending logic here
        return 'The email has been successfully sent.';
    }
}

📝 Registering a Tool

Register the tool in app/Providers/AppServiceProvider.php:

public function register()
{
    // Register the email sending tool
    $this->app->singleton(SendEmailTool::class, function () {
        return new SendEmailTool();
    });
}

🧪 Testing

🛠️ Testing with Modelcontext Protocol Inspector

To test the MCP server, run the following command:

php artisan mcp:serve

Then access http://localhost:8000 in your browser.

⚙️ Configuring Claude Desktop

To use the MCP server in Claude Desktop, follow these steps:

1. Open Claude Desktop.
2. Click File in the top menu bar, then select New Connection.
3. Enter your MCP server address (e.g., http://localhost:8000) in the connection settings.
4. Click Connect.

🤝 Contribution

If you have any questions or suggestions, please submit Issues or Pull Requests on GitHub.

🔒 Security Policy

Please refer to the Security Policy Document for more information.

📄 License

Laravel MCP is released under the MIT License. Please refer to LICENSE for detailed information.