Laravel MCP Server SDK

https://github.com/php-mcp/laravel
Admin
A comprehensive Laravel SDK for building Model Context Protocol (MCP) servers that expose Laravel...
Tokens:63,058
Snippets:515
Trust Score:5.6
License:MIT
Update:4 days ago
Show doc for...
Tokens:
Raw
### Development Setup Commands

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

Commands to clone the repository, install dependencies, run tests with Pest, and check code style with Pint.

```bash
git clone https://github.com/php-mcp/laravel.git
cd laravel

# Install dependencies
composer install

# Run tests
./vendor/bin/pest

# Check code style
./vendor/bin/pint
```

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

### mcp:list output example

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

Example output from the list command showing tables for tools and resources with their names, descriptions, URIs, and MIME types.

```text
Tools:
┌─────────────────┬──────────────────────────────────────────────┐
│ Name            │ Description                                  │
├─────────────────┼──────────────────────────────────────────────┤
│ add_numbers     │ Add two numbers together                     │
│ send_email      │ Send email to specified recipient            │
│ create_user     │ Create a new user account with validation    │
└─────────────────┴──────────────────────────────────────────────┘

Resources:
┌─────────────────────────┬───────────────────┬─────────────────────┐
│ URI                     │ Name              │ MIME                │
├─────────────────────────┼───────────────────┼─────────────────────┤
│ config://app/settings   │ app_settings      │ application/json    │
│ file://readme.txt       │ readme_file       │ text/plain          │
└─────────────────────────┴───────────────────┴─────────────────────┘
```

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

### mcp:discover output example

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

Example output from the discovery command showing a table of element types and counts, followed by a confirmation message.

```text
Starting MCP element discovery...
Discovery complete.

┌─────────────────────┬───────┐
│ Element Type        │ Count │
├─────────────────────┼───────┤
│ Tools               │ 5     │
│ Resources           │ 3     │
│ Resource Templates  │ 2     │
│ Prompts             │ 1     │
└─────────────────────┴───────┘

MCP element definitions updated and cached.
```

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

### Start dedicated HTTP server with artisan mcp:serve

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

Launch a standalone ReactPHP-based HTTP server for production. Use --transport=http and optionally customize host, port, and path prefix.

```bash
# Start dedicated server
php artisan mcp:serve --transport=http

# With custom configuration
php artisan mcp:serve --transport=http \
    --host=0.0.0.0 \
    --port=8091 \
    --path-prefix=mcp_api
```

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

### Serve MCP server with mcp:serve

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

Starts the MCP server. Without options, prompts for transport selection. Use --transport=stdio or --transport=http; HTTP supports custom host, port, and path-prefix.

```bash
# Interactive mode (prompts for transport selection)
php artisan mcp:serve

# STDIO transport
php artisan mcp:serve --transport=stdio

# HTTP transport with defaults
php artisan mcp:serve --transport=http

# HTTP transport with custom settings
php artisan mcp:serve --transport=http \
    --host=0.0.0.0 \
    --port=8091 \
    --path-prefix=api/mcp
```

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

### Install php-mcp/laravel via Composer

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

Use this command to install the package. The -W flag also updates dependencies. Requires PHP >= 8.1 and Laravel >= 10.0.

```bash
composer require php-mcp/laravel:^3.0 -W
```

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

### Publish MCP configuration file

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

Publishes config/mcp.php with all server settings. Run after installation to customize options.

```bash
php artisan vendor:publish --provider="PhpMcp\Laravel\McpServiceProvider" --tag="mcp-config"
```

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

### Example mcp:discover commands

Source: https://github.com/php-mcp/laravel

Shows basic usage of the mcp:discover artisan command, including the --force and --no-cache flags.

```bash
php artisan mcp:discover
php artisan mcp:discover --force
php artisan mcp:discover --no-cache
```

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

### Basic resource registration example

Source: https://github.com/php-mcp/laravel

Registers a resource with name, description, mimeType, and size using the Mcp facade.

```php
use PhpMcp\Laravel\Facades\Mcp;

Mcp::resource('config://app/settings', [UserService::class, 'getAppSettings'])
    ->name('app_settings')
    ->description('Application configuration settings')
    ->mimeType('application/json')
    ->size(1024);
```

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

### resource() usage example

Source: https://github.com/php-mcp/laravel

Registers a static resource at system://time using a closure that returns the current time as an ISO string. Chains name(), description(), and mimeType() on the returned ResourceBlueprint.

```php
Mcp::resource('system://time', function (): string {
    return now()->toISOString();
})
    ->name('current_time')
    ->description('Get current server time')
    ->mimeType('text/plain');
```

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

### prompt() usage example

Source: https://github.com/php-mcp/laravel

Registers a prompt handler that generates a topic summary. The handler receives a topic and optional tone, returning a user message. Chains ->name() and ->description() to configure the prompt blueprint.

```php
Mcp::prompt(function (string $topic, string $tone = 'professional'): array {
    return [
        [
            'role' => 'user',
            'content' => "Write a {$tone} summary about {$topic}. Make it informative and engaging."
        ]
    ];
})
    ->name('topic_summary')
    ->description('Generate topic summary prompts');
```

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

### Supervisor configuration for Laravel MCP server

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

Example Supervisor program configuration to manage the long-running MCP server process. Adjust command path and user as needed.

```ini
[program:laravel-mcp]
process_name=%(program_name)s_%(process_num)02d
command=php /var/www/laravel/artisan mcp:serve --transport=http
autostart=true
autorestart=true
stopasgroup=true
killasgroup=true
user=www-data
numprocs=1
redirect_stderr=true
stdout_logfile=/var/log/laravel-mcp.log
```

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

### mcp:list command usage examples

Source: https://github.com/php-mcp/laravel

Shows how to invoke the `mcp:list` command: without arguments lists all types, with `tools` filters to tools, and with `--json` outputs JSON.

```bash
php artisan mcp:list
php artisan mcp:list tools
php artisan mcp:list --json
```

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

### listen()

Source: https://github.com/php-mcp/laravel

Starts the transport listener. Emits a 'ready' event for the integrated transport (no socket).

```APIDOC
## listen()

### Description
Starts the transport listener. Emits a 'ready' event for the integrated transport (no socket).

### Method
listen

### Signature
```php
public function listen(): void
```

### Parameters
None
```

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

### Example mcp:serve command with HTTP transport

Source: https://github.com/php-mcp/laravel

Runs the mcp:serve command with the HTTP transport, binding to 0.0.0.0 on port 8091 with path prefix mcp_api.

```bash
php artisan mcp:serve --transport=http --host=0.0.0.0 --port=8091 --path-prefix=mcp_api
```

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

### Mcp facade usage example

Source: https://github.com/php-mcp/laravel

Shows how to register a tool and a resource using the Mcp facade. The tool is created from a service class and named 'calculate'; the resource uses a callable array and sets a MIME type.

```php
use PhpMcp\Laravel\Facades\Mcp;

Mcp::tool(App\Services\CalculatorService::class)
    ->name('calculate');

Mcp::resource('config://app/settings', [App\Services\UserService::class, 'getAppSettings'])
    ->mimeType('application/json');
```

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

### STDIO transport startup code

Source: https://github.com/php-mcp/laravel

Creates a StdioServerTransport and starts listening on the server. Used in the STDIO branch after printing startup info to stderr to avoid corrupting the JSON-RPC STDOUT channel.

```php
$transport = new StdioServerTransport;
$server->listen($transport);
```

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

### Configure FileSessionHandler via provider

Source: https://github.com/php-mcp/laravel

Example configuration for using the file session driver with optional environment variables for path and TTL.

```php
'session' => [
    'driver' => 'file',
    'path' => env('MCP_SESSION_FILE_PATH', storage_path('framework/mcp_sessions')),
    'ttl' => (int) env('MCP_SESSION_TTL', 3600),
],
```

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

### Run MCP Server with STDIO Transport

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

Starts the Laravel MCP server using STDIO transport, suitable for direct client execution and Cursor IDE. Never write to STDOUT in handlers; use Laravel's logger or STDERR for debugging.

```bash
php artisan mcp:serve --transport=stdio
```

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

### ServeCommand signature and description

Source: https://github.com/php-mcp/laravel

Defines the mcp:serve command signature with options for transport, host, port, and path-prefix. The description states it starts the MCP server using the specified transport (stdio or http).

```php
protected $signature = 'mcp:serve 
                        {--transport= : The transport to use (stdio or http)}
                        {--H|host= : Host for the HTTP transport (overrides config)}
                        {--P|port= : Port for the HTTP transport (overrides config)}
                        {--path-prefix= : URL path prefix for the HTTP transport (overrides config)}';

protected $description = 'Starts the MCP server using the specified transport (stdio or http).';
```

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

### Stateless mode GET request handling

Source: https://github.com/php-mcp/laravel

Creates a transport in stateless mode and sends a GET request. Returns 405 because SSE is unavailable in stateless mode.

```php
$transport = new StreamableHttpServerTransport($sessionManager, null, stateless: true);
$get = $transport->handleGetRequest(Request::create('/mcp', 'GET')); // 405, SSE unavailable

```

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

### resourceTemplate() usage example

Source: https://github.com/php-mcp/laravel

Registers a resource template for file://{path} that reads file contents. The handler receives template variables as arguments (e.g., {path} → $path) and throws an InvalidArgumentException if the file is missing or unreadable. Chains name(), description(), and mimeType() on the returned ResourceTemplateBlueprint.

```php
Mcp::resourceTemplate('file://{path}', function (string $path): string {
    if (!file_exists($path) || !is_readable($path)) {
        throw new \InvalidArgumentException("File not found or not readable: {$path}");
    }
    return file_get_contents($path);
})
    ->name('file_reader')
    ->description('Read file contents by path')
    ->mimeType('text/plain');
```

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

### Closure handlers and class-based handlers in Laravel MCP v3.1

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

Shows the transition from class-based and invokable class handlers in v3.0 to the new closure support in v3.1. The first two lines illustrate the old class-based approach, while the closure examples demonstrate the new feature for tools and resources.

```php
// v3.0 and earlier - Class-based handlers only
Mcp::tool([CalculatorService::class, 'add'])
    ->name('add_numbers');

Mcp::tool(EmailService::class)  // Invokable class
    ->name('send_email');

// v3.1+ - Now supports closures
Mcp::tool(function(float $x, float $y): float {
    return $x * $y;
})
    ->name('multiply')
    ->description('Multiply two numbers');

Mcp::resource('system://time', function(): string {
    return now()->toISOString();
})
    ->name('current_time');
```

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

### Database session driver configuration in config/mcp.php

Source: https://github.com/php-mcp/laravel

Example configuration for using the database session driver. Sets driver to 'database', connection from MCP_SESSION_DB_CONNECTION env or database.default, table from MCP_SESSION_DB_TABLE env or mcp_sessions, and ttl from MCP_SESSION_TTL env or 3600.

```php
// config/mcp.php
'session' => [
    'driver' => 'database',
    'connection' => env('MCP_SESSION_DB_CONNECTION', config('database.default')),
    'table' => env('MCP_SESSION_DB_TABLE', 'mcp_sessions'),
    'ttl' => (int) env('MCP_SESSION_TTL', 3600),
],
```

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

### handleGetRequest() method signature

Source: https://github.com/php-mcp/laravel

Public method handling GET /mcp SSE stream requests. Returns 405 in stateless mode, 406 if Accept header lacks text/event-stream, or 400 if Mcp-Session-Id header is missing. Streams with polling every sse_poll_interval seconds (min 1) and supports event replay via replayEvents().

```php
public function handleGetRequest(Request $request): StreamedResponse|Response
```

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

### bootCommands() method signature

Source: https://github.com/php-mcp/laravel

Protected method that registers ServeCommand, DiscoverCommand, and ListCommand when runningInConsole() is true.

```php
protected function bootCommands(): void
```

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

### boot() method signature

Source: https://github.com/php-mcp/laravel

Signature for the boot() method, which calls loadMcpDefinitions(), buildServer(), bootPublishables(), bootRoutes(), bootEvents(), and bootCommands() in order.

```php
public function boot(): void
```

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

### E-commerce Integration with McpTool and McpResource

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

Shows how to expose Laravel Eloquent models as MCP tools and resources. The get_product_info tool retrieves a product with relations, search_products filters by category and limit, and getStoreSettings returns store configuration as a resource.

```php
class EcommerceService
{
    #[McpTool(name: 'get_product_info')]
    public function getProductInfo(int $productId): array
    {
        return Product::with(['category', 'reviews'])
            ->findOrFail($productId)
            ->toArray();
    }

    #[McpTool(name: 'search_products')]
    public function searchProducts(
        string $query,
        ?string $category = null,
        int $limit = 10
    ): array {
        return Product::search($query)
            ->when($category, fn($q) => $q->where('category', $category))
            ->limit($limit)
            ->get()
            ->toArray();
    }

    #[McpResource(uri: 'config://store/settings', mimeType: 'application/json')]
    public function getStoreSettings(): array
    {
        return [
            'currency' => config('store.currency'),
            'tax_rate' => config('store.tax_rate'),
            'shipping_zones' => config('store.shipping_zones'),
        ];
    }
}
```

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

### SseTransportController constructor body

Source: https://github.com/php-mcp/laravel

Constructor body that creates an HttpServerTransport with the server's session manager and starts listening on the transport with false as the second argument.

```php
$this->transport = new HttpServerTransport($server->getSessionManager());
$server->listen($this->transport, false);
```

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

### Integrated HTTP Transport Routes Comment

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

Comment block showing the automatically registered routes for the integrated HTTP transport: GET /mcp, POST /mcp, DELETE /mcp, and legacy SSE endpoints if enabled.

```php
// Routes are automatically registered at:
// GET  /mcp       - Streamable connection endpoint
// POST /mcp       - Message sending endpoint  
// DELETE /mcp     - Session termination endpoint

// Legacy mode (if enabled):
// GET  /mcp/sse   - Server-Sent Events endpoint
// POST /mcp/message - Message sending endpoint
```

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

### Content Management with McpResourceTemplate and McpPrompt

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

Demonstrates exposing blog post content as a resource template and generating a summary prompt. The getPostContent method returns markdown content for a given slug, while generateContentSummary builds a user message asking for a summary with a configurable word limit.

```php
class ContentService
{
    #[McpResourceTemplate(uriTemplate: 'post://{slug}', mimeType: 'text/markdown')]
    public function getPostContent(string $slug): string
    {
        return Post::where('slug', $slug)
            ->firstOrFail()
            ->markdown_content;
    }

    #[McpPrompt(name: 'content_summary')]
    public function generateContentSummary(string $postSlug, int $maxWords = 50): array
    {
        $post = Post::where('slug', $postSlug)->firstOrFail();
        
        return [
            [
                'role' => 'user',
                'content' => "Summarize this blog post in {$maxWords} words or less:\n\n{$post->content}"
            ]
        ];
    }
}
```

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

### getCorsHeaders() method signature and return array

Source: https://github.com/php-mcp/laravel

Returns CORS headers for the transport. Uses config value for origin, defaults to '*'. Allows GET, POST, DELETE, OPTIONS methods and specific headers.

```php
protected function getCorsHeaders(): array
```

```php
[
    'Access-Control-Allow-Origin' => config('mcp.transports.http_integrated.cors_origin', '*'),
    'Access-Control-Allow-Methods' => 'GET, POST, DELETE, OPTIONS',
    'Access-Control-Allow-Headers' => 'Content-Type, Mcp-Session-Id, Last-Event-ID, Authorization, Accept',
]
```

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

### Publish and run MCP migrations for database session storage

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

Publishes the migration for database session storage and runs it. Required only if using the database session backend.

```bash
php artisan vendor:publish --provider="PhpMcp\Laravel\McpServiceProvider" --tag="mcp-migrations"
```

```bash
php artisan migrate
```

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

### Catch InvalidArgumentException for event store class not implementing EventStoreInterface

Source: https://github.com/php-mcp/laravel

Thrown when the configured event store class exists but does not implement PhpMcp\Server\Contracts\EventStoreInterface. The example instantiates StreamableTransportController with the Server singleton.

```php
try {
    $controller = new StreamableTransportController(app(PhpMcp\Server\Server::class));
} catch (InvalidArgumentException $e) { /* event store misconfigured */ }
```

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

### Manual Registration with Mcp Facade in routes/mcp.php

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

Registers tools, resources, resource templates, and prompts using the fluent Mcp facade. Supports class methods, invokable classes, and closures (v3.2+). Manual registrations take precedence over attribute-based discovery.

```php
<?php

use PhpMcp\Laravel\Facades\Mcp;
use App\Services\{CalculatorService, UserService, EmailService, PromptService};

// Register a simple tool
Mcp::tool([CalculatorService::class, 'add'])
    ->name('add_numbers')
    ->description('Add two numbers together');

// Register an invokable class as a tool
Mcp::tool(EmailService::class)
    ->description('Send emails to users');

// Register a closure as a tool with custom input schema
Mcp::tool(function(float $x, float $y): float {
    return $x * $y;
})
    ->name('multiply')
    ->description('Multiply two numbers')
    ->inputSchema([
        'type' => 'object',
        'properties' => [
            'x' => ['type' => 'number', 'description' => 'First number'],
            'y' => ['type' => 'number', 'description' => 'Second number'],
        ],
        'required' => ['x', 'y'],
    ]);

// Register a resource with metadata
Mcp::resource('config://app/settings', [UserService::class, 'getAppSettings'])
    ->name('app_settings')
    ->description('Application configuration settings')
    ->mimeType('application/json')
    ->size(1024);

// Register a closure as a resource
Mcp::resource('system://time', function(): string {
    return now()->toISOString();
})
    ->name('current_time')
    ->description('Get current server time')
    ->mimeType('text/plain');

// Register a resource template for dynamic content
Mcp::resourceTemplate('user://{userId}/profile', [UserService::class, 'getUserProfile'])
    ->name('user_profile')
    ->description('Get user profile by ID')
    ->mimeType('application/json');

// Register a closure as a resource template
Mcp::resourceTemplate('file://{path}', function(string $path): string {
    if (!file_exists($path) || !is_readable($path)) {
        throw new \InvalidArgumentException("File not found or not readable: {$path}");
    }
    return file_get_contents($path);
})
    ->name('file_reader')
    ->description('Read file contents by path')
    ->mimeType('text/plain');

// Register a prompt generator
Mcp::prompt([PromptService::class, 'generateWelcome'])
    ->name('welcome_user')
    ->description('Generate a personalized welcome message');

// Register a closure as a prompt
Mcp::prompt(function(string $topic, string $tone = 'professional'): array {
    return [
        [
            'role' => 'user',
            'content' => "Write a {$tone} summary about {$topic}. Make it informative and engaging."
        ]
    ];
})
    ->name('topic_summary')
    ->description('Generate topic summary prompts');
```

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

### Catch InvalidArgumentException for invalid Mcp::prompt() arguments

Source: https://github.com/php-mcp/laravel

Thrown when Mcp::prompt() receives an argument shape other than (handler) or (name, handler). The example passes three arguments, which is invalid.

```php
try {
    Mcp::prompt('a', 'b', 'c'); // three args — invalid
} catch (InvalidArgumentException $e) { /* handled */ }
```

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

### Basic call with invokable class

Source: https://github.com/php-mcp/laravel

Uses Mcp::prompt() with an invokable class, then chains name() and description().

```php
use PhpMcp\Laravel\Facades\Mcp;

Mcp::prompt(GenerateWelcomeMessage::class)
    ->name('welcome_user')
    ->description('Generate a personalized welcome message');
```

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

### GET /{prefix}/sse

Source: https://github.com/php-mcp/laravel

Legacy SSE endpoint that establishes a server-sent events stream. The server generates a clientId and sends an endpoint event with the message URL, followed by message events polled from the session queue.

```APIDOC
## [GET] /{prefix}/sse

### Description
Legacy SSE endpoint that establishes a server-sent events stream. The server generates a clientId and sends an endpoint event with the message URL, followed by message events polled from the session queue.

### Method
GET

### Endpoint
/{prefix}/sse

### Response
#### Success Response (200)
- **Content-Type**: text/event-stream
- **Cache-Control**: no-cache
- **Connection**: keep-alive
- **X-Accel-Buffering**: no
- **Access-Control-Allow-Origin**: cors_origin

First event: `event: endpoint`, `id: mcp-endpoint-{clientId}`, `data:` = URL `route('mcp.message', ['clientId' => $clientId])`. Then `message` events polled from the session queue every `sse_poll_interval` seconds; a `: keep-alive` comment is emitted ≈ every 15 s.

```

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

### Artisan Commands for MCP Discovery

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

Run `php artisan mcp:discover` to discover and cache MCP elements. Use `--force` to ignore cache and `--no-cache` to avoid saving to cache. Manual registrations always override discovered elements with the same identifier.

```bash
# Discover and cache MCP elements
php artisan mcp:discover

# Force re-discovery (ignores cache)
php artisan mcp:discover --force

# Discover without saving to cache
php artisan mcp:discover --no-cache
```

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

### GET /{prefix} — server-sent events stream (streamable)

Source: https://github.com/php-mcp/laravel

Opens a server-sent events (SSE) stream for receiving messages from the MCP server. Supports event replay via `Last-Event-ID` when an event store is configured.

```APIDOC
## [GET] /{prefix}

### Description
Opens a server-sent events (SSE) stream for receiving messages from the MCP server. Supports event replay via `Last-Event-ID` when an event store is configured.

### Method
GET

### Endpoint
/{prefix}

### Parameters
#### Headers
- **Accept** (string) - Required - Must contain `text/event-stream` else `406`
- **Mcp-Session-Id** (string) - Required (stateful) - Missing → `400`
- **Last-Event-ID** (string) - Optional - When present and an event store is configured, replays events after this id first

### Response
#### Success Response (200)
- **Content-Type**: `text/event-stream`
- **Body**: Emits `message` events as they are queued; polls every `sse_poll_interval` seconds; stops when the client aborts or the session no longer exists

#### Error Response (400)
- **Condition**: Missing `Mcp-Session-Id`

#### Error Response (405)
- **Condition**: Stateless mode — body `SSE not available in stateless mode`, header `Allow: POST, DELETE, OPTIONS`

#### Error Response (406)
- **Condition**: `Accept` header unacceptable

### Event Framing
```
event: message
optional id:
one or more data: lines
```
```

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

### description() method

Source: https://github.com/php-mcp/laravel

Sets the tool description shown to clients and returns the blueprint for chaining.

```php
public function description(string $description): static
```

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

### Basic tool registration with name, description, and inputSchema

Source: https://github.com/php-mcp/laravel

Registers a tool with handler precedence and chains name, description, and inputSchema. Uses the Mcp facade.

```php
use PhpMcp\Laravel\Facades\Mcp;

Mcp::tool([App\Services\CalculatorService::class, 'add'])
    ->name('add_numbers')
    ->description('Add two numbers together')
    ->inputSchema([
        'type' => 'object',
        'properties' => [
            'a' => ['type' => 'number'],
            'b' => ['type' => 'number'],
        ],
        'required' => ['a', 'b'],
    ]);
```

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

### Catch InvalidArgumentException for unsupported session driver

Source: https://github.com/php-mcp/laravel

Thrown when config('mcp.session.driver') is not one of the supported drivers. The example uses 'in-memory-foo' as an invalid driver. The exception surfaces at boot/container resolution when building the Server singleton.

```php
// config/mcp.php
'session' => ['driver' => 'in-memory-foo'], // invalid

try {
    app(PhpMcp\Server\Server::class);
} catch (InvalidArgumentException $e) {
    // "Unsupported MCP session driver: in-memory-foo"
}
```

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

### Constructor implementation

Source: https://github.com/php-mcp/laravel

Constructor initializes the transport with session manager, event store, and stateless config. Calls server->listen with the transport.

```php
public function __construct(Server $server)
```

```php
$eventStore = $this->createEventStore();
$sessionManager = $server->getSessionManager();
$stateless = config('mcp.transports.http_integrated.stateless', false);

$this->transport = new StreamableHttpServerTransport($sessionManager, $eventStore, $stateless);
$server->listen($this->transport, false);
```

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

### prompt() method signature

Source: https://github.com/php-mcp/laravel

Declares the prompt registration method. Accepts either a single handler or a (name, handler) pair, identical to tool(). Returns a new PromptBlueprint appended to pendingPrompts.

```php
public function prompt(string|callable|array ...$args): PromptBlueprint
```

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

### Cursor IDE Client Configuration for STDIO

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

JSON configuration for Cursor IDE to connect to the Laravel MCP server via STDIO. Uses the artisan command with the --transport=stdio flag.

```json
{
    "mcpServers": {
        "my-laravel-app": {
            "command": "php",
            "args": [
                "/absolute/path/to/your/laravel/project/artisan",
                "mcp:serve",
                "--transport=stdio"
            ]
        }
    }
}
```

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

### Summary table output format

Source: https://github.com/php-mcp/laravel

On success, the command prints a summary table of element counts for tools, resources, resource templates, and prompts. Counts are derived from the server's registry.

```text
| Element Type        | Count |
| Tools               | ...   |
| Resources           | ...   |
| Resource Templates  | ...   |
| Prompts             | ...   |
```

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

### HTTP dedicated server configuration options

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

Configuration array for the dedicated HTTP server. Set 'enabled' to true, adjust host, port, path prefix, and choose between streamable and legacy modes.

```php
'http_dedicated' => [
    'enabled' => true,
    'host' => '127.0.0.1',              // Bind address
    'port' => 8090,                     // Port number
    'path_prefix' => 'mcp',             // URL path prefix
    'legacy' => false,                  // Use legacy transport
    'enable_json_response' => false,    // JSON mode vs SSE streaming
    'event_store' => null,              // Event store for resumability
    'ssl_context_options' => [],        // SSL configuration
],
```

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

### Constructor

Source: https://github.com/php-mcp/laravel

Creates a new ToolBlueprint instance with a handler and optional explicit name.

```APIDOC
## Constructor

### Description
Creates a new ToolBlueprint instance.

### Signature
```php
public function __construct(
    public mixed $handler,
    public ?string $name = null
) {}
```

### Parameters
- **handler** (`mixed`) - Required - Tool handler (closure, method array, or invokable class)
- **name** (`?string`) - Optional - Explicit tool name; auto-inferred when omitted
```

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

### resource()

Source: https://github.com/php-mcp/laravel

Registers a static resource with a URI and handler. Returns a ResourceBlueprint for further configuration.

```APIDOC
## resource()

### Description
Registers a static resource with a URI and handler. Returns a ResourceBlueprint for further configuration.

### Method
`resource`

### Signature
```php
public function resource(string $uri, callable|array|string $handler): ResourceBlueprint
```

### Parameters
- **uri** (`string`) - Required - The resource URI (e.g. `config://app/settings`, `system://time`)
- **handler** (`callable|array|string`) - Required - Closure, `[Class::class, 'method']`, or invokable class-string

### Returns
A new `ResourceBlueprint`, appended to `pendingResources`.

### Request Example
```php
Mcp::resource('system://time', function (): string {
    return now()->toISOString();
})
    ->name('current_time')
    ->description('Get current server time')
    ->mimeType('text/plain');
```
```

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

### Server discovery call with configuration

Source: https://github.com/php-mcp/laravel

Calls the server's discover method with base path, scan directories, exclude directories, force flag, and saveToCache flag. The force flag is always truthy, and saveToCache is the negation of the --no-cache option.

```php
$server->discover(
    basePath: config('mcp.discovery.base_path', base_path()),
    scanDirs: config('mcp.discovery.directories', ['app/Mcp']),
    excludeDirs: config('mcp.discovery.exclude_dirs', []),
    force: $forceDiscovery,
    saveToCache: ! $noCache
);
```

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

### description()

Source: https://github.com/php-mcp/laravel

Sets the tool description shown to clients and returns the blueprint for chaining.

```APIDOC
## description()

### Description
Sets the tool description shown to clients.

### Signature
```php
public function description(string $description): static
```

### Parameters
- **description** (`string`) - Required - Sets the tool description shown to clients

### Returns
Returns the blueprint for chaining.
```

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

### prompt()

Source: https://github.com/php-mcp/laravel

Registers a new prompt with the MCP server. Accepts either a single handler or a (name, handler) pair, and returns a PromptBlueprint that can be further configured.

```APIDOC
## prompt()

### Description
Registers a new prompt with the MCP server. Accepts either a single handler or a (name, handler) pair, and returns a PromptBlueprint that can be further configured.

### Method
prompt

### Signature
```php
public function prompt(string|callable|array ...$args): PromptBlueprint
```

### Parameters
- **args** (string|callable|array, variadic) - Required - Either a single handler or a `(name, handler)` pair

### Returns
A new `PromptBlueprint`, appended to `pendingPrompts`.

### Example
```php
Mcp::prompt(function (string $topic, string $tone = 'professional'): array {
    return [
        [
            'role' => 'user',
            'content' => "Write a {$tone} summary about {$topic}. Make it informative and engaging."
        ]
    ];
})
    ->name('topic_summary')
    ->description('Generate topic summary prompts');
```
```

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

### ListCommand signature and description

Source: https://github.com/php-mcp/laravel

Defines the `mcp:list` command signature and description. The `type` argument accepts `tools`, `resources`, `prompts`, or `templates`; anything else triggers an error. The `--json` flag outputs pretty-printed JSON.

```php
protected $signature = 'mcp:list 
                        {type? : The type of element to list (tools, resources, prompts, templates)} 
                        {--json : Output the list as JSON}';

protected $description = 'Lists discovered MCP elements (tools, resources, prompts, templates).';
```

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

### Cursor IDE client configuration for mcp:serve

Source: https://github.com/php-mcp/laravel

JSON configuration for a Cursor IDE MCP client that launches the Laravel artisan command with the stdio transport. Uses an absolute path to the project's artisan file.

```json
{
  "mcpServers": {
    "my-laravel-app": {
      "command": "php",
      "args": ["/absolute/path/to/laravel/project/artisan", "mcp:serve", "--transport=stdio"]
    }
  }
}
```

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

### STDIO client configuration (JSON)

Source: https://github.com/php-mcp/laravel

Configure an MCP client to launch the Laravel MCP server via STDIO using the 'php' command with the artisan 'mcp:serve' command and '--transport=stdio' flag. Use the absolute path to the artisan file.

```json
{
  "mcpServers": {
    "my-laravel-app": {
      "command": "php",
      "args": ["/abs/path/artisan", "mcp:serve", "--transport=stdio"]
    }
  }
}
```

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

### size() method

Source: https://github.com/php-mcp/laravel

Set the content size in bytes. Returns the blueprint.

```php
public function size(int $size): static
```

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

### tool()

Source: https://github.com/php-mcp/laravel

Registers a new tool with the MCP server. Accepts either a single handler or a name-handler pair, and returns a ToolBlueprint for fluent configuration.

```APIDOC
## `tool()`

### Description
Registers a new tool with the MCP server. Accepts either a single handler or a name-handler pair, and returns a ToolBlueprint for fluent configuration.

### Method
`tool()`

### Signature
```php
public function tool(string|callable|array ...$args): ToolBlueprint
```

### Parameters
- **args** (`string|callable|array`, variadic) - Required - Either a single handler `(handler)` or a `(name, handler)` pair. Accepted handler forms: a callable (closure), an array `[ClassName::class, 'method']`, or a class-string of an invokable class.

### Argument Resolution Rules
- `1` arg → treated as `handler` (name is inferred later by `php-mcp/server`).
- `2` args → first must be a `string` name, second the handler.
- Anything else → `InvalidArgumentException` (see errors.md).

### Returns
A new `ToolBlueprint`, appended to `pendingTools`, ready for fluent configuration.

### Request Example
```php
Mcp::tool(function (float $x, float $y): float {
    return $x * $y;
})
    ->name('multiply')
    ->description('Multiply two numbers')
    ->inputSchema([
        'type' => 'object',
        'properties' => [
            'x' => ['type' => 'number', 'description' => 'First number'],
            'y' => ['type' => 'number', 'description' => 'Second number'],
        ],
        'required' => ['x', 'y'],
    ]);
```

### Error Handling Example
```php
try {
    Mcp::tool('only_a_name'); // single non-callable string arg
} catch (\InvalidArgumentException $e) {
    // "Invalid arguments for Mcp::tool(). Expected (handler) or (name, handler)."
}
```
```

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

### ServeCommand handle method signature

Source: https://github.com/php-mcp/laravel

The handle method receives a Server instance injected from the container and dispatches based on the resolved transport option.

```php
public function handle(Server $server): int
```

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

### bootEvents() method signature

Source: https://github.com/php-mcp/laravel

Protected method that registers McpNotificationListener for the three list-changed events.

```php
protected function bootEvents(): void
```

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

### bootRoutes() method signature

Source: https://github.com/php-mcp/laravel

Signature for the protected method that registers HTTP routes when the integrated HTTP transport is enabled. It loads routes from the package's routes/web.php file.

```php
protected function bootRoutes(): void
```

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

### Mcp::tool() basic call with fluent configuration

Source: https://github.com/php-mcp/laravel

Registers a tool by passing a single callable handler; the name is inferred later by php-mcp/server. Returns a ToolBlueprint appended to pendingTools for fluent configuration with name, description, and inputSchema.

```php
Mcp::tool(function (float $x, float $y): float {
    return $x * $y;
})
    ->name('multiply')
    ->description('Multiply two numbers')
    ->inputSchema([
        'type' => 'object',
        'properties' => [
            'x' => ['type' => 'number', 'description' => 'First number'],
            'y' => ['type' => 'number', 'description' => 'Second number'],
        ],
        'required' => ['x', 'y'],
    ]);
```

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

### PromptBlueprint::description

Source: https://github.com/php-mcp/laravel

Sets the prompt description. Returns the blueprint instance for chaining.

```APIDOC
## Method: description

### Description
Set the prompt description. Returns the blueprint.

### Signature
```php
public function description(string $description): static
```

### Parameters
- **description** (string) - Required - Human-readable description of what the prompt does

### Return Value
Returns the blueprint instance (static) for method chaining.

### Example
```php
Mcp::prompt(GenerateWelcomeMessage::class)
    ->name('welcome_user')
    ->description('Generate a personalized welcome message');
```
```

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

### applyBlueprints()

Source: https://github.com/php-mcp/laravel

Applies all pending blueprints to the provided ServerBuilder instance. Called by McpServiceProvider::buildServer() to flush tools, resources, resource templates, and prompts onto the builder.

```APIDOC
## applyBlueprints()

### Description
Applies all pending blueprints to the provided ServerBuilder instance. Called by McpServiceProvider::buildServer() to flush tools, resources, resource templates, and prompts onto the builder.

### Method
applyBlueprints

### Signature
```php
public function applyBlueprints(ServerBuilder $builder): void
```

### Parameters
- **builder** (PhpMcp\Server\ServerBuilder) - Required - Builder being configured by the service provider

### Notes
Because `applyBlueprints` runs before `Server::discover()`, manually registered elements override attribute-discovered ones with the same identifier.
```

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

### Integrated HTTP Transport Configuration Options

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

Configuration array for the integrated HTTP transport. Set 'enabled' to true, customize route_prefix, middleware, domain, and legacy mode.

```php
'http_integrated' => [
    'enabled' => true,
    'route_prefix' => 'mcp',           // URL prefix
    'middleware' => ['api'],           // Applied middleware
    'domain' => 'api.example.com',     // Optional domain
    'legacy' => false,                 // Use legacy SSE transport instead
],
```

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

### Mcp facade static API docblock

Source: https://github.com/php-mcp/laravel

Declares the static methods available on the Mcp facade, matching McpRegistrar's methods: tool, resource, resourceTemplate, and prompt. Each method returns a corresponding Blueprint instance.

```php
/**
 * @method static ToolBlueprint tool(string|callable|array $handlerOrName, callable|array|string|null $handler = null)
 * @method static ResourceBlueprint resource(string $uri, callable|array|string $handler)
 * @method static ResourceTemplateBlueprint resourceTemplate(string $uriTemplate, callable|array|string $handler)
 * @method static PromptBlueprint prompt(string|callable|array $handlerOrName, callable|array|string|null $handler = null)
 */
```

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

### PromptBlueprint::__construct

Source: https://github.com/php-mcp/laravel

Creates a new PromptBlueprint instance with a prompt handler and optional name. The handler can be a closure, an array callable, or an invokable class-string.

```APIDOC
## Constructor

### Description
Creates a new PromptBlueprint instance.

### Signature
```php
public function __construct(
    public mixed $handler,
    public ?string $name = null
) {}
```

### Parameters
- **handler** (mixed) - Required - Prompt handler (closure, array callable, or invokable class-string)
- **name** (?string) - Optional - Prompt name; auto-inferred when omitted

### Example
```php
use PhpMcp\Laravel\Facades\Mcp;

Mcp::prompt(GenerateWelcomeMessage::class)
    ->name('welcome_user')
    ->description('Generate a personalized welcome message');
```
```

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

### Dispatch list change events (ToolsListChanged, ResourcesListChanged, PromptsListChanged)

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

Use these events to notify connected clients when available tools, resources, or prompts change. Each event is dispatched via its static dispatch method.

```php
use PhpMcp\Laravel\Events\{ToolsListChanged, ResourcesListChanged, PromptsListChanged};

// Notify clients that available tools have changed
ToolsListChanged::dispatch();

// Notify about resource list changes
ResourcesListChanged::dispatch();

// Notify about prompt list changes  
PromptsListChanged::dispatch();
```

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

### bootPublishables() method signature

Source: https://github.com/php-mcp/laravel

Signature for the protected method that publishes package configuration and migrations when running in console. It publishes config/mcp.php and the session table migration.

```php
protected function bootPublishables(): void
```

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

### PHP 8 Attribute-Based MCP Discovery in UserService

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

Use PHP 8 attributes (McpTool, McpResource, McpResourceTemplate, McpPrompt) to mark methods as MCP elements, avoiding manual registration in routes/mcp.php. Elements are auto-discovered when auto_discover is enabled (default: true) or via the artisan command.

```php
<?php

namespace App\Services;

use PhpMcp\Server\Attributes\{McpTool, McpResource, McpResourceTemplate, McpPrompt};

class UserService
{
    /**
     * Create a new user account.
     */
    #[McpTool(name: 'create_user')]
    public function createUser(string $email, string $password, string $role = 'user'): array
    {
        // Create user logic
        return [
            'id' => 123,
            'email' => $email,
            'role' => $role,
            'created_at' => now()->toISOString(),
        ];
    }

    /**
     * Get application configuration.
     */
    #[McpResource(
        uri: 'config://app/settings',
        mimeType: 'application/json'
    )]
    public function getAppSettings(): array
    {
        return [
            'theme' => config('app.theme', 'light'),
            'timezone' => config('app.timezone'),
            'features' => config('app.features', []),
        ];
    }

    /**
     * Get user profile by ID.
     */
    #[McpResourceTemplate(
        uriTemplate: 'user://{userId}/profile',
        mimeType: 'application/json'
    )]
    public function getUserProfile(string $userId): array
    {
        return [
            'id' => $userId,
            'name' => 'John Doe',
            'email' => 'john@example.com',
            'profile' => [
                'bio' => 'Software developer',
                'location' => 'New York',
            ],
        ];
    }

    /**
     * Generate a welcome message prompt.
     */
    #[McpPrompt(name: 'welcome_user')]
    public function generateWelcome(string $username, string $role = 'user'): array
    {
        return [
            [
                'role' => 'user',
                'content' => "Create a personalized welcome message for {$username} with role {$role}. Be warm and professional."
            ]
        ];
    }
}
```

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

### annotations() method

Source: https://github.com/php-mcp/laravel

Set MCP annotations object (external php-mcp/server type). Returns the blueprint.

```php
public function annotations(Annotations $annotations): static
```

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

### Completion Provider for User IDs

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

Provide auto-completion suggestions for resource template variables and prompt arguments. Uses Eloquent to filter usernames based on current input, limited to 10 results. Session-aware and supports real-time filtering.

```php
use PhpMcp\Server\Contracts\CompletionProviderInterface;
use PhpMcp\Server\Contracts\SessionInterface;
use PhpMcp\Server\Attributes\CompletionProvider;

class UserIdCompletionProvider implements CompletionProviderInterface
{
    public function getCompletions(string $currentValue, SessionInterface $session): array
    {
        return User::where('username', 'like', $currentValue . '%')
            ->limit(10)
            ->pluck('username')
            ->toArray();
    }
}

class UserService
{
    public function getUserData(
        #[CompletionProvider(UserIdCompletionProvider::class)]
        string $userId
    ): array {
        return User::where('username', $userId)->first()->toArray();
    }
}
```

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

### getMethod() method

Source: https://github.com/php-mcp/laravel

Returns the notification method name.

```php
public function getMethod(): string
```
Tokens:
Raw