Laravel MCP Server

https://github.com/opgginc/laravel-mcp-server
Admin
Laravel MCP Server is a PHP package for building route-first Model Context Protocol (MCP) servers in...
Tokens:13,130
Snippets:109
Trust Score:8.5
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example requests for dynamic tool filtering

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Example URLs showing how the 'phase' query parameter filters tools. Use 'lobby' or 'inprogress' to get the corresponding tool set.

```text
/mcp/voice/lol/live?phase=lobby
/mcp/voice/lol/live?phase=inprogress
```

--------------------------------

### Example preview output for interactive grouping

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Example output shown when running the command without `--group-by`. It displays grouping options (tag-based, path-based, or no grouping) with endpoint counts and example folder structures.

```text
Choose how to organize your generated tools and resources:

Tag-based grouping (organize by OpenAPI tags)
  Total: 25 endpoints -> 15 tools + 10 resources
  Examples: Tools/Pet, Tools/Store, Tools/User

Path-based grouping (organize by API path)
  Total: 25 endpoints -> 15 tools + 10 resources
  Examples: Tools/Api, Tools/Users, Tools/Orders

No grouping (everything in root folder)
  Total: 25 endpoints -> 15 tools + 10 resources
  Examples: Tools/, Resources/
```

--------------------------------

### Install and run Laravel Octane with FrankenPHP

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/AGENTS.md

Use these commands to set up and start Laravel Octane with the FrankenPHP server, which is required instead of 'php artisan serve' when using the SSE driver with this package.

```bash
composer require laravel/octane
php artisan octane:install --server=frankenphp
php artisan octane:start
```

--------------------------------

### Example implementation after migration

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/docs/migrations/v1.1.0-tool-interface-migration.md

Shows a tool class implementing the new interface, including the messageType() method and a deprecated annotation.

```php
use OPGG\LaravelMcpServer\Services\ToolService\ToolInterface;
use OPGG\LaravelMcpServer\Enums\ProcessMessageType;

class MyTool implements ToolInterface
{
    /**
     * @deprecated since v1.3.0, use isStreaming() instead. Will be removed in v2.0.0
     */
    public function messageType(): ProcessMessageType
    {
        return ProcessMessageType::HTTP;
    }

    public function isStreaming(): bool
    {
        return false;
    }

    public function name(): string { return 'MyTool'; }
    public function description(): string { return 'This is my tool.'; }
    public function inputSchema(): array { return []; }
    public function annotations(): array { return []; }
    public function execute(array $arguments): mixed { /* ... */ }
}
```

--------------------------------

### Install translation dependencies and run translation script

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Install Python dependencies for the translation script, set the Anthropic API key, and run the translation script to translate the README. The API key is required for the script to work.

```bash
pip install -r scripts/requirements.txt
export ANTHROPIC_API_KEY='your-api-key'
python scripts/translate_readme.py
```

--------------------------------

### Install Laravel MCP Server via Composer

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Install the package using Composer. Requires PHP >= 8.2 and Laravel (Illuminate) >= 9.x.

```bash
composer require opgginc/laravel-mcp-server
```

--------------------------------

### WeatherTool class with JsonSchema builder

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Example tool class that returns weather data. Demonstrates fluent schema building with string, enum, and integer types, including min/max/default constraints. Uses compact() on the platform enum.

```php
<?php

namespace App\MCP\Tools;

use App\Enums\Platform;
use OPGG\LaravelMcpServer\JsonSchema\JsonSchema;
use OPGG\LaravelMcpServer\Services\ToolService\ToolInterface;

class WeatherTool implements ToolInterface
{
    public function name(): string
    {
        return 'weather-tool';
    }

    public function description(): string
    {
        return 'Get weather by location.';
    }

    public function inputSchema(): array
    {
        return [
            'location' => JsonSchema::string()
                ->description('Location to query')
                ->required(),
            'platform' => JsonSchema::string()
                ->enum(Platform::class)
                ->description('Client platform'),
            'days' => JsonSchema::integer()
                ->min(1)
                ->max(7)
                ->default(1),
        ];
    }

    public function annotations(): array
    {
        return [];
    }

    public function execute(array $arguments): mixed
    {
        return ['ok' => true];
    }
}
```

--------------------------------

### GreetingTool class implementing ToolInterface

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Example tool class that returns a greeting message. Uses JsonSchema::string() with required() and enum() with compact() for the platform field. Sets readOnlyHint and destructiveHint annotations.

```php
<?php

namespace App\MCP\Tools;

use App\Enums\Platform;
use OPGG\LaravelMcpServer\JsonSchema\JsonSchema;
use OPGG\LaravelMcpServer\Services\ToolService\ToolInterface;

class GreetingTool implements ToolInterface
{
    public function name(): string
    {
        return 'greeting-tool';
    }

    public function description(): string
    {
        return 'Return a greeting message.';
    }

    public function inputSchema(): array
    {
        return [
            'name' => JsonSchema::string()
                ->description('Developer Name')
                ->required(),
            'platform' => JsonSchema::string()
                ->enum(Platform::class)
                ->description('Client platform')
                ->compact(),
        ];
    }

    public function annotations(): array
    {
        return [
            'readOnlyHint' => true,
            'destructiveHint' => false,
        ];
    }

    public function execute(array $arguments): mixed
    {
        return [
            'message' => 'Hello '.$arguments['name'],
        ];
    }
}
```

--------------------------------

### Register generated MCP tools on route (PHP)

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Register the generated tool classes on the MCP endpoint using the `Route::mcp` facade. The example shows setting server info and passing an array of tool classes.

```php
use Illuminate\Support\Facades\Route;

Route::mcp('/mcp')
    ->setServerInfo(
        name: 'Generated MCP Server',
        version: '2.0.0',
    )
    ->tools([
        \App\MCP\Tools\Billing\CreateInvoiceTool::class,
        \App\MCP\Tools\Billing\UpdateInvoiceTool::class,
    ]);
```

--------------------------------

### Register MCP routes in Lumen

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/docs/migrations/v2.0.0-migration.md

Use the McpRoute class to register MCP routes in Lumen, as the standard macro is unavailable. This example demonstrates configuring server information, tools, resources, templates, and prompts.

```php
use OPGG\LaravelMcpServer\Routing\McpRoute;
use App\MCP\Tools\MyTool;
use App\MCP\Resources\MyResource;
use App\MCP\ResourceTemplates\MyTemplate;
use App\MCP\Prompts\MyPrompt;

McpRoute::register('/mcp')
    ->setServerInfo(
        name: 'Acme MCP Server',
        version: '2.0.0',
        title: 'Acme MCP',
        description: 'Acme tool and data gateway',
        websiteUrl: 'https://example.com/mcp',
        icons: [
            ['src' => 'https://example.com/icon.png', 'mimeType' => 'image/png', 'sizes' => ['512x512'], 'theme' => 'dark'],
        ],
        instructions: 'Call tools/list before tools/call.',
    )
    ->tools([MyTool::class])
    ->resources([MyResource::class])
    ->resourceTemplates([MyTemplate::class])
    ->prompts([MyPrompt::class])
    ->toolListChanged(false)
    ->resourcesSubscribe(false)
    ->resourcesListChanged(false)
    ->promptsListChanged(false)
    ->toolsPageSize(50);
```

--------------------------------

### Define a Prompt Class (WelcomePrompt)

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Extends the Prompt base class to define a prompt named 'welcome-user' with a required 'username' argument and a welcome message template. Use this to create custom prompts for the MCP server.

```php
<?php

namespace App\MCP\Prompts;

use OPGG\LaravelMcpServer\Services\PromptService\Prompt;

class WelcomePrompt extends Prompt
{
    public string $name = 'welcome-user';

    public ?string $description = 'Generate a welcome message.';

    public array $arguments = [
        [
            'name' => 'username',
            'description' => 'User name',
            'required' => true,
        ],
    ];

    public string $text = 'Welcome, {username}';
}
```

--------------------------------

### Register MCP Server with Tools, Resources, and Prompts

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Registers an MCP server on the '/mcp' route, setting server info and attaching the GreetingTool, BuildInfoResource, and WelcomePrompt classes. Use this to expose your custom MCP components.

```php
use App\MCP\Prompts\WelcomePrompt;
use App\MCP\Resources\BuildInfoResource;
use App\MCP\Tools\GreetingTool;
use Illuminate\Support\Facades\Route;

Route::mcp('/mcp')
    ->setServerInfo(
        name: 'Example MCP Server',
        version: '2.0.0',
    )
    ->tools([GreetingTool::class])
    ->resources([BuildInfoResource::class])
    ->prompts([WelcomePrompt::class]);
```

--------------------------------

### Generate MCP tools with options (--group-by, --prefix, --test-api)

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Run the command with options to group by tag, prefix class names, and test API connectivity. The `--group-by` accepts `tag`, `path`, or `none`; `--prefix` sets the class-name prefix; `--test-api` tests endpoint connectivity before generation.

```bash
php artisan make:swagger-mcp-tool ./specs/openapi.json \
  --group-by=tag \
  --prefix=Billing \
  --test-api
```

--------------------------------

### Run tests, static analysis, and code style

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Run the project's test suite with Pest, static analysis with PHPStan, and code style fixes with Pint. These commands are typically executed in the project root.

```bash
vendor/bin/pest
vendor/bin/phpstan analyse
vendor/bin/pint
```

--------------------------------

### Manual tool compatibility reference

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/docs/migrations/v2.0.0-migration.md

Reference for manual cleanup of legacy tool methods.

```php
// Required removals for v2 compatibility:
// - use OPGG\LaravelMcpServer\Enums\ProcessMessageType;
// - public function messageType(): ProcessMessageType { ... }
//
// Optional cleanup (runtime no longer uses this method):
// - public function isStreaming(): bool { ... }
```

--------------------------------

### Verify migration end-to-end

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/docs/migrations/v2.0.0-migration.md

Commands to verify route registration, tool resolution, and pipeline health.

```bash
php artisan route:list | grep mcp
php artisan mcp:test-tool --list --endpoint=/mcp
vendor/bin/pest
vendor/bin/phpstan analyse
```

--------------------------------

### Run migration with default path

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/docs/migrations/v1.1.0-tool-interface-migration.md

Run the migration command immediately after upgrading the package. It uses the default app/MCP/Tools/ directory.

```bash
php artisan mcp:migrate-tools
```

--------------------------------

### Run migration with custom path

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/docs/migrations/v1.1.0-tool-interface-migration.md

Supply a different directory when your tools are not stored in the default app/MCP/Tools/ path.

```bash
php artisan mcp:migrate-tools path/to/your/tools
```

--------------------------------

### Define a Resource Class (BuildInfoResource)

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Extends the Resource base class to expose build information via the 'app://build-info' URI. The read() method returns a JSON-encoded payload with version and environment details.

```php
<?php

namespace App\MCP\Resources;

use OPGG\LaravelMcpServer\Services\ResourceService\Resource;

class BuildInfoResource extends Resource
{
    public string $uri = 'app://build-info';

    public string $name = 'Build Info';

    public ?string $mimeType = 'application/json';

    public function read(): array
    {
        return [
            'uri' => $this->uri,
            'mimeType' => $this->mimeType,
            'text' => json_encode([
                'version' => '2.0.0',
                'environment' => app()->environment(),
            ], JSON_THROW_ON_ERROR),
        ];
    }
}
```

--------------------------------

### Verify MCP routes and tools with artisan commands

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Lists MCP routes and tests tools for the /mcp endpoint. Use these commands to verify the endpoint is registered correctly.

```bash
php artisan route:list | grep mcp
php artisan mcp:test-tool --list --endpoint=/mcp
```

--------------------------------

### Run command without --group-by to trigger interactive preview

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Running the command without `--group-by` shows an interactive preview of folder structure and file counts before creation. This preview lets you choose how to organize generated tools and resources.

```bash
php artisan make:swagger-mcp-tool ./specs/openapi.json
```

--------------------------------

### Run automated migration command

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/docs/migrations/v1.1.0-tool-interface-migration.md

Use this Artisan command to automatically migrate existing tools. It identifies old implementations, creates backups, and refactors the tool class.

```bash
php artisan mcp:migrate-tools {path?}
```

--------------------------------

### Generate MCP tools from Swagger/OpenAPI spec (URL and local file)

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Run the artisan command to generate MCP tools from an OpenAPI spec, either from a URL or a local file. The command processes the spec and creates tool/resource classes.

```bash
# From URL
php artisan make:swagger-mcp-tool https://api.example.com/openapi.json

# From local file
php artisan make:swagger-mcp-tool ./specs/openapi.json
```

--------------------------------

### Configure server identity and route middleware

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/docs/migrations/v2.0.0-migration.md

Define server information and apply middleware directly within the route group.

```php
use Illuminate\Support\Facades\Route;
use App\MCP\Tools\MyTool;

Route::domain('api.example.com')
    ->middleware(['auth:sanctum', 'throttle:100,1'])
    ->group(function (): void {
        Route::mcp('/mcp')
            ->setServerInfo(
                name: 'Acme MCP Server',
                version: '2.0.0',
                title: 'Acme MCP',
                description: 'Acme tool and data gateway',
                websiteUrl: 'https://example.com/mcp',
                icons: [
                    ['src' => 'https://example.com/icon.png', 'mimeType' => 'image/png', 'sizes' => ['512x512'], 'theme' => 'dark'],
                ],
                instructions: 'Call tools/list before tools/call.',
            )
            ->tools([MyTool::class]);
    });
```

--------------------------------

### Register MCP route with tools

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Registers an MCP route at '/mcp' with server info and a list of tools. Use this in a routes file to expose the MCP endpoint.

```php
use OPGG\LaravelMcpServer\Routing\McpRoute;
use OPGG\LaravelMcpServer\Services\ToolService\Examples\HelloWorldTool;

McpRoute::register('/mcp')
    ->setServerInfo(
        name: 'OP.GG MCP Server',
        version: '2.0.0',
    )
    ->tools([
        HelloWorldTool::class,
    ]);
```

--------------------------------

### Enable Tool API route with Route::mcp()->enabledApi()

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Configure the MCP route to enable the Tool API and register tool classes. Use setServerInfo to set server name and version, and tools() to list tool classes. This is required for the OpenAPI export to include the tools.

```php
use Illuminate\Support\Facades\Route;

Route::mcp('/mcp')
    ->setServerInfo(name: 'OP.GG MCP Server', version: '2.0.0')
    ->enabledApi()
    ->tools([
        \App\MCP\Tools\GreetingTool::class,
    ]);
```

--------------------------------

### Translate README to selected languages

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Run the translation script for specific languages, e.g., Spanish (es) and Korean (ko). The script translates the README into the specified language codes.

```bash
python scripts/translate_readme.py es ko
```

--------------------------------

### Register a minimal MCP route

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/docs/migrations/v2.0.0-migration.md

Register the smallest working route to verify the migration base.

```php
use Illuminate\Support\Facades\Route;
use App\MCP\Tools\MyTool;

Route::mcp('/mcp')
    ->tools([MyTool::class]);
```

--------------------------------

### Configure advanced MCP capabilities

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/docs/migrations/v2.0.0-migration.md

Explicitly define resources, templates, prompts, and capability flags for the MCP endpoint.

```php
use Illuminate\Support\Facades\Route;
use App\MCP\Tools\MyTool;
use App\MCP\Resources\MyResource;
use App\MCP\ResourceTemplates\MyTemplate;
use App\MCP\Prompts\MyPrompt;

Route::mcp('/mcp')
    ->setServerInfo(
        name: 'Acme MCP Server',
        version: '2.0.0',
        title: 'Acme MCP',
        description: 'Acme tool and data gateway',
        websiteUrl: 'https://example.com/mcp',
        icons: [
            ['src' => 'https://example.com/icon.png', 'mimeType' => 'image/png', 'sizes' => ['512x512'], 'theme' => 'dark'],
        ],
        instructions: 'Call tools/list before tools/call.',
    )
    ->tools([MyTool::class])
    ->resources([MyResource::class])
    ->resourceTemplates([MyTemplate::class])
    ->prompts([MyPrompt::class])
    ->toolListChanged(false)
    ->resourcesSubscribe(false)
    ->resourcesListChanged(false)
    ->promptsListChanged(false)
    ->toolsPageSize(50);
```

--------------------------------

### Register dynamic tools endpoint with Route::mcp

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Registers an MCP endpoint at /mcp/voice/lol/live using a dynamic tool resolver. The resolver filters tools based on the 'phase' query parameter.

```php
Route::mcp('/mcp/voice/lol/live')
    ->setServerInfo(
        name: 'OP.GG MCP Server - Voice lol Live',
        version: '1.0.0',
    )
    ->dynamicTools(LolPhaseToolResolver::class);
```

--------------------------------

### Dynamic tool resolver with phase-based filtering

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Implements DynamicToolResolverInterface to expose different tool sets based on the 'phase' query parameter. The resolver declares the full catalog and returns a filtered subset per request.

```php
use OPGG\LaravelMcpServer\Data\ToolResolutionContext;
use OPGG\LaravelMcpServer\Routing\McpEndpointDefinition;
use OPGG\LaravelMcpServer\Services\ToolService\DynamicToolResolverInterface;

final class LolPhaseToolResolver implements DynamicToolResolverInterface
{
    public function declaredTools(McpEndpointDefinition $endpoint): array
    {
        return [
            \App\MCP\Tools\LolSearchChampionMetaTool::class,
            \App\MCP\Tools\LolGetChampionAnalysisTool::class,
            \App\MCP\Tools\LolGetLiveItemRecommendationsTool::class,
        ];
    }

    public function resolve(
        McpEndpointDefinition $endpoint,
        ToolResolutionContext $context,
    ): array {
        return match ($context->queryParameters['phase'] ?? null) {
            'lobby' => [
                \App\MCP\Tools\LolSearchChampionMetaTool::class,
                \App\MCP\Tools\LolGetChampionAnalysisTool::class,
            ],
            'inprogress' => [
                \App\MCP\Tools\LolGetLiveItemRecommendationsTool::class,
            ],
            default => $this->declaredTools($endpoint),
        };
    }

    public function consumedQueryParameters(): array
    {
        return ['phase'];
    }
}
```

--------------------------------

### Lumen bootstrap configuration

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Configures the Lumen application to enable facades, Eloquent, and register the LaravelMcpServer service provider. Place this in bootstrap/app.php.

```php
// bootstrap/app.php
$app->withFacades();
$app->withEloquent();
$app->register(OPGG\LaravelMcpServer\LaravelMcpServerServiceProvider::class);
```

--------------------------------

### v2.0.0 Route-Driven Definition

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/docs/migrations/v2.0.0-migration.md

The v2.0.0 approach uses a fluent route definition to configure the MCP server, replacing the previous configuration file.

```php
use Illuminate\Support\Facades\Route;
use App\MCP\Tools\MyTool;
use App\MCP\Resources\MyResource;
use App\MCP\ResourceTemplates\MyTemplate;
use App\MCP\Prompts\MyPrompt;

Route::middleware(['auth:sanctum', 'throttle:100,1'])
    ->group(function (): void {
        Route::mcp('/mcp')
            ->setServerInfo(
                name: 'Acme MCP Server',
                version: '2.0.0',
                title: 'Acme MCP',
                description: 'Acme tool and data gateway',
                websiteUrl: 'https://example.com/mcp',
                icons: [
                    ['src' => 'https://example.com/icon.png', 'mimeType' => 'image/png', 'sizes' => ['512x512'], 'theme' => 'dark'],
                ],
                instructions: 'Call tools/list before tools/call.',
            )
            ->tools([MyTool::class])
            ->resources([MyResource::class])
            ->resourceTemplates([MyTemplate::class])
            ->prompts([MyPrompt::class])
            ->toolListChanged(false)
            ->resourcesSubscribe(false)
            ->resourcesListChanged(false)
            ->promptsListChanged(false)
            ->toolsPageSize(50);
    });
```

--------------------------------

### v1.0.0 Configuration File

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/docs/migrations/v2.0.0-migration.md

The v1.0.0 configuration file located at config/mcp-server.php, which is removed in v2.0.0.

```php
// config/mcp-server.php (removed in v2)
return [
    'enabled' => true,
    'server' => [
        'name' => 'Acme MCP Server',
        'version' => '2.0.0',
    ],
    'server_provider' => 'streamable_http',
    'default_path' => 'mcp',
    'middlewares' => ['auth:sanctum'],
    'tools' => [
        App\MCP\Tools\MyTool::class,
    ],
];
```

--------------------------------

### Quick JSON-RPC check with curl

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Sends a tools/list request to the MCP endpoint. Expect a JSON-RPC response listing available tools.

```bash
curl -X POST http://localhost:8000/mcp \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
```

--------------------------------

### Export OpenAPI with artisan mcp:export-openapi

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Use these artisan commands to export MCP tools to OpenAPI JSON. Default output is storage/api-docs-mcp/api-docs.json. Options include --output, --title, --api-version, --endpoint, and --discover-path. Existing output is overwritten by default.

```bash
# Default output: storage/api-docs-mcp/api-docs.json
php artisan mcp:export-openapi

# Custom output + metadata
php artisan mcp:export-openapi \
  --output=storage/app/mcp.openapi.json \
  --title="MCP Tools API" \
  --api-version=2.1.0

# Limit to one endpoint (id or path)
php artisan mcp:export-openapi --endpoint=/mcp

# Discover tools from additional directory paths
php artisan mcp:export-openapi --discover-path=app/MCP/Tools

# Existing output is overwritten by default
php artisan mcp:export-openapi
```

--------------------------------

### v1.1.0 ToolInterface definition

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/docs/migrations/v1.1.0-tool-interface-migration.md

The new interface definition with messageType(), name(), description(), inputSchema(), and annotations() methods.

```php
<?php

namespace OPGG\LaravelMcpServer\Services\ToolService;

use OPGG\LaravelMcpServer\Enums\ProcessMessageType;

interface ToolInterface
{
    public function messageType(): ProcessMessageType;
    public function name(): string;
    public function description(): string;
    public function inputSchema(): array;
    public function annotations(): array;
    public function execute(array $arguments): mixed;
}
```

--------------------------------

### v1.0.x ToolInterface definition

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/docs/migrations/v1.1.0-tool-interface-migration.md

The old interface definition with getName(), getDescription(), getInputSchema(), and getAnnotations() methods.

```php
<?php

namespace OPGG\LaravelMcpServer\Services\ToolService;

interface ToolInterface
{
    public function getName(): string;
    public function getDescription(): string;
    public function getInputSchema(): array;
    public function getAnnotations(): array;
    public function execute(array $arguments): mixed;
}
```

--------------------------------

### Set protocol version to V2025_06_18 for compatibility

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Use this alternative protocol version for clients that do not support 2025-11-25. Replace the setProtocolVersion call in the endpoint registration.

```php
->setProtocolVersion(ProtocolVersion::V2025_06_18)
```

--------------------------------

### Secure MCP route with middleware

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Applies authentication and rate limiting middleware to the MCP route group. Use this in production to protect the endpoint.

```php
use Illuminate\Support\Facades\Route;

Route::middleware([
    'auth:sanctum',
    'throttle:100,1',
])->group(function (): void {
    Route::mcp('/mcp')
        ->setServerInfo(
            name: 'Secure MCP',
            version: '2.0.0',
        )
        ->tools([
            \App\MCP\Tools\MyCustomTool::class,
        ]);
});
```

--------------------------------

### Register MCP endpoint with Route::mcp (Laravel)

Source: https://github.com/opgginc/laravel-mcp-server/blob/main/README.md

Registers an MCP endpoint at /mcp with server info, config, protocol version, enabled API, and tools. Uses ProtocolVersion::V2025_11_25 by default.

```php
use Illuminate\Support\Facades\Route;
use OPGG\LaravelMcpServer\Enums\ProtocolVersion;
use OPGG\LaravelMcpServer\Services\ToolService\Examples\HelloWorldTool;
use OPGG\LaravelMcpServer\Services\ToolService\Examples\VersionCheckTool;

Route::mcp('/mcp')
    ->setServerInfo(
        name: 'OP.GG MCP Server',
        version: '2.0.0',
    )
    ->setConfig(
        compactEnumExampleCount: 3,
    )
    ->setProtocolVersion(ProtocolVersion::V2025_11_25)
    ->enabledApi()
    ->tools([
        HelloWorldTool::class,
        VersionCheckTool::class,
    ]);
```
Tokens:
Raw