Laravel MCP

https://github.com/laravel/mcp
Admin
Laravel MCP enables the rapid development of Model Context Protocol (MCP) servers, allowing AI...
Tokens:177,456
Snippets:1,310
Trust Score:9.7
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### createMcpApp(setup)

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/ui.md

Initializes the MCP browser SDK inside an `<x-mcp::app>` view. It sends the `ui/initialize` request, stores host information, and exposes helper functions on the setup object.

```APIDOC
## createMcpApp(setup)

### Description
Initializes the MCP browser SDK inside an `<x-mcp::app>` view. It sends the `ui/initialize` request, stores host information, and exposes helper functions on the setup object.

### Method
JavaScript function

### Endpoint
`window.createMcpApp(setup)`

### Parameters
- **setup** (function) - Required - Callback function that receives an `app` object with helper methods.

### Request Example
```blade
<x-mcp::app title="Dashboard App">
    <x-slot:head>
        <script type="module">
        createMcpApp(async (app) => {
            const result = await app.callServerTool({ name: 'load-dashboard', arguments: {} });

            if (result.isError) {
                document.getElementById('output').textContent = result.content[0]?.text ?? '';
            }
        });
        </script>
    </x-slot:head>
</x-mcp::app>
```

### Response
#### Success Response
- **hostInfo** - Host information from the `ui/initialize` response.
- **hostCapabilities** - Host capabilities from the `ui/initialize` response.
- **hostContext** - Host context from the `ui/initialize` response.

#### Response Example
No explicit response example provided.
```

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

### ReviewPrompt example implementation

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/primitives.md

Concrete example of a Prompt subclass. Defines a single required argument 'pr' for a pull request URL and returns a text response that includes the provided value. This demonstrates how to implement the arguments() and handle() methods for a custom prompt.

```php
use Laravel\Mcp\Server\Prompts\Argument;
use Laravel\Mcp\Server\Prompt;

class ReviewPrompt extends Prompt
{
    public function arguments(): array
    {
        return [
            new Argument(name: 'pr', description: 'Pull request URL', required: true),
        ];
    }

    public function handle(Request $request): Response
    {
        return Response::text('Please review '.$request->get('pr'));
    }
}
```

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

### DocsResource example implementation

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/primitives.md

Example resource implementation that returns the contents of docs/README.md as a text response. Must implement handle(Request $request): Response|array and is invoked by ReadResource::invokeResource().

```php
use Laravel\Mcp\Request;
use Laravel\Mcp\Response;
use Laravel\Mcp\Server\Resource;

class DocsResource extends Resource
{
    public function handle(Request $request): Response
    {
        return Response::text(file_get_contents(base_path('docs/README.md')));
    }
}
```

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

### start(): void

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/server.md

Boots the server and begins listening on the transport. Automatically adds the UI extension when any registered resource is an AppResource subclass.

```APIDOC
## start(): void

### Description
Boots the server and begins listening on the transport. Automatically adds the UI extension when any registered resource is an AppResource subclass.

### Method
start

### Parameters
None

### Returns
void
```

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

### mcp:start

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/console-commands.md

Starts a locally-registered stdio server by handle. Returns exit code 0 on success, 1 if the handle is not registered.

```APIDOC
## [CLI] mcp:start

### Description
Starts a locally-registered stdio server by handle.

### Command
`php artisan mcp:start {handle}`

### Arguments
- **handle** (string) - Required - The handle of the MCP server to start

### Exit Codes
- `0` - SUCCESS after the server runs
- `1` - FAILURE when the handle is not registered

### Example
```bash
php artisan mcp:start my-server
```
```

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

### start method implementation

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/server.md

Boots the server, detects UI capability, and begins listening on the transport. Automatically adds the io.modelcontextprotocol/ui extension when any registered resource is an AppResource subclass.

```php
public function start(): void
{
    $this->boot();
    $this->detectUiCapability();
    $this->transport->onReceive($this->handle(...));
}
```

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

### WebClient OAuth Example

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/client.md

Configures OAuth on a WebClient, gets the authorization redirect URL, and exchanges the callback for a token. Requires withOAuth() to be called first; oAuthClient() throws OAuthException otherwise.

```php
$web = $client->withOAuth(clientId: config('services.mcp.client_id'));

$authUrl = $web->oAuthClient()->redirect('/dashboard');  // RedirectResponse

// ...on the callback route...
$token = $web->oAuthClient()->exchangeCallback();        // TokenSet
```

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

### WeatherTool example implementation

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/primitives.md

Example Tool subclass showing schema() override with required string and enum with default, plus handle() returning a text Response. Uses Illuminate\Contracts\JsonSchema\JsonSchema and Laravel\Mcp\Request/Response.

```php
use Illuminate\Contracts\JsonSchema\JsonSchema;
use Laravel\Mcp\Request;
use Laravel\Mcp\Response;
use Laravel\Mcp\Server\Tool;

class WeatherTool extends Tool
{
    public function schema(JsonSchema $schema): array
    {
        return [
            'city' => $schema->string()->required()->description('City name'),
            'units' => $schema->string()->enum(['celsius', 'fahrenheit'])->default('celsius'),
        ];
    }

    public function handle(Request $request): Response
    {
        return Response::text('Forecast for '.$request->get('city'));
    }
}
```

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

### Start an MCP server with mcp:start

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/console-commands.md

Starts a locally-registered stdio server by handle. Exit code 0 on success; exit code 1 with the message "MCP Server with name [{handle}] not found. Did you register it using [Mcp::local()]?" if the handle is not registered.

```bash
php artisan mcp:start my-server
```

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

### Minimal HTTP server example

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/server.md

Shows a minimal HTTP server extending Laravel\Mcp\Server, defining tools and boot() to add capabilities and methods, then registering it via Mcp::web().

```php
use Laravel\Mcp\Server;
use Laravel\Mcp\Server\Tool;

class WeatherServer extends Server
{
    protected array $tools = [WeatherTool::class];

    protected function boot(): void
    {
        $this->addCapability('weather.forecasts');
        $this->addMethod('custom/endpoint', CustomMethod::class);
    }
}

// routes/ai.php
use Laravel\Mcp\Facades\Mcp;
use App\Mcp\Servers\WeatherServer;

Mcp::web('/mcp/weather', WeatherServer::class);
```

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

### app.getHostInfo() - Get host info

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Returns host information.

```javascript
const info = app.getHostInfo();
```

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

### UriTemplate usage example

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/support.md

Shows how to instantiate UriTemplate with a template containing placeholders, match a URI to extract variables, and echo the template. The match returns an associative array of variable names to captured values, or null if no match.

```php
use Laravel\Mcp\Support\UriTemplate;

$template = new UriTemplate('docs://resources/{user}/{slug}');
$vars = $template->match('docs://resources/8/budget');  // ['user' => '8', 'slug' => 'budget']
echo $template;                                          // docs://resources/{user}/{slug}
```

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

### app.getHostCapabilities() - Get host capabilities

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Returns host capabilities.

```javascript
const caps = app.getHostCapabilities();
```

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

### Before: Implementing Transport with setProtocolVersion

Source: https://github.com/laravel/mcp/blob/main/UPGRADE.md

Shows the previous way to implement the Transport contract, which included a setProtocolVersion() method. This is the 'Before...' example for the migration to the UsesProtocol interface.

```php
class MyTransport implements Transport
{
    public function setProtocolVersion(string $version): void
    {
        $this->version = $version;
    }
}
```

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

### After: Implementing Transport with UsesProtocol and useProtocol

Source: https://github.com/laravel/mcp/blob/main/UPGRADE.md

Shows the new way to implement the Transport contract, using the UsesProtocol interface and the useProtocol() method with a ProtocolVersion enum. This is the 'After...' example for the migration.

```php
use Laravel\Mcp\Client\Contracts\UsesProtocol;
use Laravel\Mcp\Enums\ProtocolVersion;

class MyTransport implements Transport, UsesProtocol
{
    public function useProtocol(ProtocolVersion $protocolVersion): void
    {
        $this->version = $protocolVersion;
    }
}
```

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

### createMcpApp - Initialize MCP client app

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Pre-bundled and inlined automatically; no npm install or imports required. The callback receives an app instance once the connection is established and theming is applied.

```javascript
createMcpApp(async (app) => {
    // app is ready — connection established, theming applied
});
```

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

### PaginatesList usage example

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/client-methods.md

Shows manual pagination with a cursor using ListTools and direct tool invocation via CallTool. Requires a Protocol instance.

```php
use Laravel\Mcp\Client\Methods\Tools\CallTool;
use Laravel\Mcp\Client\Methods\Tools\ListTools;

// Paginate manually with a cursor
$page1 = (new ListTools(limit: 10))->handle($protocol);
$cursor = $page1->last()?->meta['cursor'] ?? null;

// Call a tool directly through the method class
$result = (new CallTool('issues.update', ['id' => 1, 'status' => 'done']))
    ->handle($protocol);
```

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

### Example test using WeatherServer::tools() and WeatherServer::tool()

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/testing.md

Pest/PHPUnit feature test showing how to assert registered tools and call a tool with arguments. Uses the static testing helpers on a server class. Expects a successful response containing 'Forecast for Paris'.

```php
// tests/Feature/McpServerTest.php
it('exposes the weather tool', function () {
    WeatherServer::tools()
        ->assertRegistered(WeatherTool::class)
        ->assertNotRegistered([AdminTool::class]);

    $response = WeatherServer::tool(WeatherTool::class, ['city' => 'Paris'])
        ->assertOk()
        ->assertSee('Forecast for Paris');
});
```

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

### local(string $handle, string $serverClass): void

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/server.md

Registers a stdio server under a handle, startable via `php artisan mcp:start $handle`.

```APIDOC
## local(string $handle, string $serverClass): void

### Description
Registers a stdio server under a handle, startable via `php artisan mcp:start $handle`.

### Parameters
- **handle** (string) - Required - The handle to register the server under.
- **serverClass** (string) - Required - The server class name (must be a class-string of Server).

### Return
void

```

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

### app.getHostContext() - Get host context

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Returns the current host context, including theme and style variables. Access theme, styles.variables, and styles.css.fonts.

```javascript
const ctx = app.getHostContext();
ctx?.theme; // 'light' | 'dark'
ctx?.styles?.variables; // CSS variable map from host
ctx?.styles?.css?.fonts; // font CSS from host
```

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

### Usage example: HttpTransport construction and recipe round-trip

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/transports.md

Shows direct construction of an HttpTransport with fluent configuration (token and timeout), creating a Client, and then serializing/restoring the transport via recipe(). Requires the Client and HttpTransport classes.

```php
use Laravel\Mcp\Client;
use Laravel\Mcp\Client\Transport\HttpTransport;

// Direct transport construction + fluent configuration
$transport = new HttpTransport('https://mcp.example.com');
$transport->withToken(fn () => cache('mcp_token'));
$transport->withTimeout(5.0);

$client = new Client($transport);

// Recipe round-trip (used by Client serialization)
$recipe = $transport->recipe();
$restored = TransportFactory::fromRecipe($recipe);
```

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

### Example: multiple responses with structured content

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/request-response.md

Builds a response with two text parts (second marked as assistant) plus structured content and a meta warning. Uses withStructuredContent() and withMeta() to aggregate data into the final result.

```php
use Laravel\Mcp\Response;

return Response::make([
    Response::text('First part'),
    Response::text('Second part')->asAssistant(),
])->withStructuredContent([
    'forecast' => ['high' => 21, 'low' => 12],
])->withMeta('warning', 'Data from cache');
```

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

### Response factory usage examples

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/request-response.md

Shows common factory methods: text, error, fromStorage, and image with metadata. fromStorage reads from a storage disk; image/* maps to image(), audio/* to audio(), other MIME throws InvalidArgumentException.

```php
use Laravel\Mcp\Response;

// Single text response
return Response::text('Hello world');

// Error response (surfaces as isError in tools/call, JsonRpc error otherwise)
return Response::error('The widget could not be found.');

// Binary file from storage
return Response::fromStorage('photos/avatar.png', 's3');

// Image with metadata
return Response::image(base64_decode($data))
    ->withMeta('source', 'uploads');
```

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

### Example usage of Name and Version attributes

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/attributes.md

Shows how to apply class-level attributes to a server class. The Name attribute sets the server name and Version sets the version, both resolved reflectively.

```php
#[Name('GitHub Tools')]
#[Version('1.0.0')]
class MyServer extends Server {}
```

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

### Client usage example

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/schema.md

Shows how to use the client with the schema result objects. Connects to a web MCP server, retrieves server info, calls a tool, and accesses the result's text and structured content.

```php
use Laravel\Mcp\Client;

$client = Client::web('https://mcp.linear.app/mcp')->withOAuth(...);
$client->connect();

$server = $client->serverInfo();      // ?Implementation — name/version/icons
$result = $client->callTool('issues.get', ['id' => 123]);

echo $result->text();                 // concatenated text content
$data = $result->structuredContent;   // ?array<string, mixed>
```

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

### Response with metadata example

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/content.md

Shows a tool returning multiple typed contents (text, image, audio) with metadata using Response::make() and withMeta(). The withMeta('session', 'abc123') call attaches a session key to the response metadata.

```php
use Laravel\Mcp\Response;

// Tool returning multiple typed contents with metadata
return Response::make([
    Response::text('Plan:'),
    Response::image($pngBytes, 'image/png'),
    Response::audio($wavBytes, 'audio/wav'),
])->withMeta('session', 'abc123');
```

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

### OAuthClient usage example

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/oauth.md

Shows how to instantiate OAuthClient with OAuthConfig and HttpTransport, redirect the user to the authorization server, then exchange the callback and refresh credentials. The callback exchange returns a TokenSet; refreshCredentials uses the refresh token. OAuthException is thrown on state mismatch or other OAuth errors.

```php
use Laravel\Mcp\Client\OAuth\OAuthConfig;
use Laravel\Mcp\Client\OAuth\OAuthClient;
use Laravel\Mcp\Client\Transport\HttpTransport;

$oauth = new OAuthClient(
    new OAuthConfig(clientId: 'app-123', scope: 'mcp:use'),
    'https://mcp.example.com/mcp',
);

// 1. Send the user to the authorization server
return $oauth->redirect('/dashboard');

// 2. On the callback route
try {
    $token = $oauth->exchangeCallback();          // TokenSet
    $refreshed = $oauth->refreshCredentials($token->refreshToken);
} catch (Laravel\Mcp\Client\Exceptions\OAuthException $e) {
    // "The OAuth state parameter did not match..." etc.
}
```

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

### GET mcp/{client}/connect

Source: https://github.com/laravel/mcp/blob/main/_autodocs/endpoints.md

Starts the OAuth authorization flow for a client. Forwards query parameters `resource_metadata` and `scope` to `OAuthClient::redirect()` and applies the configured middleware (default `'web'`).

```APIDOC
## [GET] mcp/{client}/connect

### Description
Starts the OAuth authorization flow for a client. Forwards query parameters `resource_metadata` and `scope` to `OAuthClient::redirect()` and applies the configured middleware (default `'web'`).

### Method
GET

### Endpoint
mcp/{client}/connect (or `$connectUri`)

### Parameters
#### Path Parameters
- **client** (string) - Required - The OAuth client identifier.

#### Query Parameters
- **resource_metadata** (string) - Optional - Forwarded to `OAuthClient::redirect()`.
- **scope** (string) - Optional - Forwarded to `OAuthClient::redirect()`.

### Response
#### Success Response (302)
Redirects to the authorization provider.

```

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

### createMcpApp usage in Blade view

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/ui.md

Example of using the browser SDK's createMcpApp inside an AppResource Blade view. The setup callback receives an app object with callServerTool to invoke tools and handle errors.

```blade
<x-mcp::app title="Dashboard App">
    <x-slot:head>
        <script type="module">
        createMcpApp(async (app) => {
            const result = await app.callServerTool({ name: 'load-dashboard', arguments: {} });

            if (result.isError) {
                document.getElementById('output').textContent = result.content[0]?.text ?? '';
            }
        });
        </script>
    </x-slot:head>
</x-mcp::app>
```

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

### Client::instructions()

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/client.md

Returns server instructions, connecting on demand.

```APIDOC
## Client::instructions()

### Description
Server instructions (connect-on-demand).

### Method
`Client::instructions`

### Returns
`?string`
```

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

### HeaderValue usage example

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/json-rpc.md

Shows creating a HeaderValue with spaces and a Unicode character, casting to string to get the base64-encoded form, and decoding a base64-encoded header with fromHeader() then checking exact equality with matches(). The encoded output is =?base64?YSB2YWx1ZSB3aXRoIHNwYWNlcyDp?= and matches() returns true for the decoded value 'a value'.

```php
use Laravel\Mcp\Transport\HeaderValue;

$hv = new HeaderValue("a value with spaces \u{00E9}");
echo (string) $hv; // =?base64?YSB2YWx1ZSB3aXRoIHNwYWNlcyDp?=

$decoded = HeaderValue::fromHeader('=?base64?YSB2YWx1ZQ==?=');
var_dump($decoded->matches('a value')); // true
```

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

### StdioTransport::connect

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/transports.md

Starts the underlying Symfony Process with an InputStream and disables the timeout. If the process fails to start, a ClientException is thrown.

```APIDOC
## StdioTransport::connect

### Description
Starts the underlying Symfony Process with an InputStream and disables the timeout. If the process fails to start, a ClientException is thrown.

### Method
connect

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

### Exceptions
- **ClientException** - Thrown when the process fails to start with message "Failed to start process [...]".
```

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

### AppMeta fluent builder with full configuration

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Builds AppMeta with CSP, permissions, libraries, domain, and prefersBorder.

```php
AppMeta::make()
    ->csp(Csp::make()->connectDomains([...]))
    ->permissions(Permissions::make()->allow(Permission::Camera))
    ->libraries(Library::Tailwind, Library::Alpine)
    ->domain('sandbox.example.com')  // dedicated sandbox origin (OAuth/CORS)
    ->prefersBorder(false);
```

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

### Permissions::make()

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Fluent builder for permissions. Allows enabling camera, microphone, geolocation, and clipboardWrite permissions.

```APIDOC
## Permissions::make()

### Description
Fluent builder for permissions. Allows enabling camera, microphone, geolocation, and clipboardWrite permissions.

### Methods
- **allow(Permission ...$permissions)** - Allow specific permissions.
- **camera()** - Enable camera permission.
- **microphone()** - Enable microphone permission.
- **geolocation()** - Enable geolocation permission.
- **clipboardWrite()** - Enable clipboardWrite permission.

### Example
```php
Permissions::make()->allow(Permission::Camera, Permission::ClipboardWrite);

Permissions::make()
    ->camera()
    ->microphone()
    ->geolocation()
    ->clipboardWrite();
```
```

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

### AppMeta::make()

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Fluent builder for AppMeta configuration. Allows setting CSP, permissions, libraries, domain, and prefersBorder.

```APIDOC
## AppMeta::make()

### Description
Fluent builder for AppMeta configuration. Allows setting CSP, permissions, libraries, domain, and prefersBorder.

### Methods
- **csp(Csp $csp)** - Set the CSP configuration.
- **permissions(Permissions $permissions)** - Set the permissions.
- **libraries(Library ...$libraries)** - Add libraries.
- **domain(string $domain)** - Set the domain.
- **prefersBorder(bool $prefersBorder)** - Set prefersBorder (default true).

### Example
```php
AppMeta::make()
    ->csp(Csp::make()->connectDomains([...]))
    ->permissions(Permissions::make()->allow(Permission::Camera))
    ->libraries(Library::Tailwind, Library::Alpine)
    ->domain('sandbox.example.com')
    ->prefersBorder(false);
```
```

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

### build(string $name): Client

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/client.md

Builds a client by name. Resolution order: named factory closure, then config, then throws ClientException.

```APIDOC
## build(string $name): Client

### Description
Builds a client by name. Resolution order: named factory closure, then config, then throws ClientException.

### Method
build

### Parameters
- **$name** (string) - Required - The name of the client to build.

### Returns
- **Client** - The built client instance.

### Exceptions
- **ClientException** - Thrown if the client has not been registered.
```

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

### Server Constructor Options

Source: https://github.com/laravel/mcp/blob/main/_autodocs/configuration.md

Constructor options for the MCP server classes, including Server, ServerContext, ToolInvoker, ToolSearch, SearchTools, ExecuteTools, CursorPaginator, and Registrar.

```APIDOC
## Server Constructor Options

### Description
Constructor options for the MCP server classes, including Server, ServerContext, ToolInvoker, ToolSearch, SearchTools, ExecuteTools, CursorPaginator, and Registrar.

### Method
N/A (Constructor)

### Endpoint
N/A

### Parameters
#### Server
- **transport** (Transport) - Required - The transport instance.
- Protected properties: `$name = 'Laravel MCP Server'`, `$version = '0.0.1'`, `$instructions`, `$capabilities`, `$tools`, `$resources`, `$prompts`, `$extensions`, `$supportedProtocolVersion`.
- Public properties: `$maxPaginationLength = 50`, `$defaultPaginationLength = 15`.

#### ServerContext
- Constructed by `Server::createContext()`. See [server.md](server.md) for details.

#### ToolInvoker
- **mirrorStructuredContent** (bool) - Optional - Default: `true`.

#### ToolSearch
- **tools** (iterable<Tool|string>) - Required - The tools to search.
- Limits from `mcp.tool_search.*`.

#### SearchTools
- **catalog** (ToolSearch) - Required - The tool search catalog.

#### ExecuteTools
- **catalog** (ToolSearch) - Required - The tool search catalog.
- **maxToolCalls** (int) - Required - Maximum number of tool calls.

#### CursorPaginator
- **items** (Collection) - Required - The items to paginate.
- **perPage** (int) - Optional - Default: `10`.
- **cursor** (?string) - Optional - Default: `null`.

#### Registrar::oauthRoutes()
- **oauthPrefix** (string) - Optional - Default: `'oauth'`.
- **registration** (bool) - Optional - Default: `true`.

#### Registrar::oAuthRoutesFor() / OAuthRouteRegistrar::register()
- **client** (string) - Required - The client identifier.
- **handler** (Closure|array) - Required - The handler.
- **middleware** (array|string) - Optional - Default: `'web'`.
- **connectUri** (?string) - Optional - Connect URI.
- **callbackUri** (?string) - Optional - Callback URI.
- **clientMetadataUri** (?string) - Optional - Client metadata URI.
- **clientMetadata** (array) - Optional - Default: `[]`.

### Request Example
No request body.

### Response
#### Success Response
No response body. Constructor initializes the server instance.

#### Response Example
No response body.
```

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

### Permissions fluent builder with convenience methods

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Enables permissions using convenience methods for camera, microphone, geolocation, and clipboardWrite.

```php
Permissions::make()
    ->camera()
    ->microphone()
    ->geolocation()
    ->clipboardWrite();
```

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

### servers(): array

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/server.md

Introspection helper to get all registered servers.

```APIDOC
## servers(): array

### Description
Introspection helper to get all registered servers.

### Return
array

```

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

### Completable prompt example with CountryPrompt

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/completions.md

Example implementation of a completable prompt. Uses CompletionResponse::match() for static arrays or enum classes, and CompletionResponse::empty() as default. For dynamic filtering, return new DirectCompletionResponse(collect($all)->filter(...)->values()->all()) — the array constructor enforces the 100-item cap.

```php
use Laravel\Mcp\Server\Completions\CompletionResponse;
use Laravel\Mcp\Server\Completions\DirectCompletionResponse;
use Laravel\Mcp\Server\Contracts\Completable;
use Laravel\Mcp\Server\Prompt;

class CountryPrompt extends Prompt implements Completable
{
    public function complete(string $argument, string $value, array $context): CompletionResponse
    {
        return match ($argument) {
            'country' => CompletionResponse::match(['France', 'Germany', 'Spain']),
            'kind' => CompletionResponse::match(CountryKind::class), // enum
            default => CompletionResponse::empty(),
        };
    }
}
```

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

### Client Constructor Options

Source: https://github.com/laravel/mcp/blob/main/_autodocs/configuration.md

Constructor options for the MCP client classes, including Client, WebClient, HttpTransport, StdioTransport, Protocol, ResponseCache, and OAuthConfig.

```APIDOC
## Client Constructor Options

### Description
Constructor options for the MCP client classes, including Client, WebClient, HttpTransport, StdioTransport, Protocol, ResponseCache, and OAuthConfig.

### Method
N/A (Constructor)

### Endpoint
N/A

### Parameters
#### Client
- **transport** (Transport) - Required - The transport instance.
- **clientInfo** (?Implementation) - Optional - Default: `new Implementation(config('app.name', 'Laravel MCP Client'), '0.0.1')`.

#### Client::local()
- **command** (string) - Required - The command to execute.
- **args** (array) - Optional - Default: `[]`.
- **env** (array) - Optional - Default: `[]`.

#### Client::web()
- **url** (string) - Required - The URL for the web client.

#### WebClient
- **httpTransport** (HttpTransport) - Required - The HTTP transport instance.
- **clientInfo** (?Implementation) - Optional - Client information.
- **oAuthConfig** (?OAuthConfig) - Optional - OAuth configuration.

#### HttpTransport
- **url** (string) - Required - The URL.
- Fluent methods: `withToken`, `withHeaders`, `setTimeoutSeconds` (default `30.0`).

#### StdioTransport
- **command** (string) - Required - The command to execute.
- **args** (array) - Optional - Default: `[]`.
- **env** (array) - Optional - Default: `[]`.
- `setTimeoutSeconds` (default `30.0`).

#### Protocol
- **transport** (Transport) - Required - The transport instance.
- **clientInfo** (Implementation) - Required - Client information.
- **pinnedProtocolVersion** (?ProtocolVersion) - Optional - Default: `null`.

#### ResponseCache
- **store** (?string) - Optional - Default: `null`.
- **for** (?string) - Optional - Default: `null`.
- Constant: `MAX_TTL_MS = 86_400_000`.

#### OAuthConfig
- **clientId** (?string) - Optional - Client ID.
- **clientSecret** (?string) - Optional - Client secret.
- **scope** (?string) - Optional - Scope.
- **redirectUri** (?string) - Optional - Redirect URI.

### Request Example
No request body.

### Response
#### Success Response
No response body. Constructor initializes the client instance.

#### Response Example
No response body.
```

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

### AppResource handle() using Response::html()

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Uses Response::html() to read an HTML file from disk. Relative paths resolve via resource_path().

```php
class StaticApp extends AppResource
{
    public function handle(Request $request): Response
    {
        return Response::html('mcp/static-app.html');
    }
}
```

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

### GET $route

Source: https://github.com/laravel/mcp/blob/main/_autodocs/endpoints.md

Returns 405 Method Not Allowed with an Allow header indicating only POST is permitted.

```APIDOC
## [GET] $route

### Description
Returns 405 Method Not Allowed with an Allow header indicating only POST is permitted.

### Method
GET

### Endpoint
$route

### Response
#### Success Response (405)
- **Allow** (header) - Set to `POST`.

### Notes
- Always returns 405 with header `Allow: POST`.
```

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

### app.getHostCapabilities()

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Returns host capabilities.

```APIDOC
## app.getHostCapabilities()

### Description
Returns host capabilities.

### Method
Function call

### Example
```js
const caps = app.getHostCapabilities();
```
```

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

### getWebServer(string $route): ?Route

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/server.md

Introspection helper to get a web server by route.

```APIDOC
## getWebServer(string $route): ?Route

### Description
Introspection helper to get a web server by route.

### Parameters
- **route** (string) - Required - The route URI.

### Return
?Route

```

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

### getLocalServer(string $handle): ?callable

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/server.md

Introspection helper to get a local server by handle.

```APIDOC
## getLocalServer(string $handle): ?callable

### Description
Introspection helper to get a local server by handle.

### Parameters
- **handle** (string) - Required - The handle.

### Return
?callable

```

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

### AppMeta attribute with libraries

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Adds Tailwind via the #[AppMeta] attribute, making it available in the Blade view without extra setup.

```php
#[AppMeta(libraries: [Library::Tailwind])]
class StyledApp extends AppResource
{
    // Tailwind is available in the Blade view — no extra setup
}
```

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

### app.getHostInfo()

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Returns host information.

```APIDOC
## app.getHostInfo()

### Description
Returns host information.

### Method
Function call

### Example
```js
const info = app.getHostInfo();
```
```

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

### GET /.well-known/oauth-authorization-server

Source: https://github.com/laravel/mcp/blob/main/_autodocs/endpoints.md

Returns RFC 8414 authorization server metadata. This endpoint is registered by the Registrar and provides metadata about the authorization server.

```APIDOC
## [GET] /.well-known/oauth-authorization-server

### Description
Returns RFC 8414 authorization server metadata.

### Method
GET

### Endpoint
/.well-known/oauth-authorization-server

### Response
#### Success Response (200)
- **issuer** (string) - The issuer identifier.
- **authorization_endpoint** (string) - The authorization endpoint URL.
- **token_endpoint** (string) - The token endpoint URL.
- **registration_endpoint** (string) - The registration endpoint URL (only when registration route exists).
- **response_types_supported** (array of string) - Supported response types.
- **code_challenge_methods_supported** (array of string) - Supported code challenge methods.
- **scopes_supported** (array of string) - Supported scopes.
- **grant_types_supported** (array of string) - Supported grant types.
- **token_endpoint_auth_methods_supported** (array of string) - Supported token endpoint authentication methods.

#### Response Example
{
  "issuer": "https://example.com",
  "authorization_endpoint": "https://example.com/oauth/authorize",
  "token_endpoint": "https://example.com/oauth/token",
  "registration_endpoint": "https://example.com/oauth/register",
  "response_types_supported": ["code"],
  "code_challenge_methods_supported": ["S256"],
  "scopes_supported": ["mcp:use"],
  "grant_types_supported": ["authorization_code", "refresh_token"],
  "token_endpoint_auth_methods_supported": ["none", "client_secret_basic", "client_secret_post"]
}
```

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

### Csp::make()

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Fluent builder for CSP configuration. Controls external domains the iframe can access.

```APIDOC
## Csp::make()

### Description
Fluent builder for CSP configuration. Controls external domains the iframe can access.

### Methods
- **connectDomains(array $domains)** - Set connect-src domains (fetch, XHR, WebSocket).
- **resourceDomains(array $domains)** - Set img-src, script-src, font-src, media-src domains.
- **frameDomains(array $domains)** - Set frame-src domains (nested iframes).
- **baseUriDomains(array $domains)** - Set base-uri domains.

### Example
```php
Csp::make()
    ->connectDomains(['https://api.example.com'])
    ->resourceDomains(['https://cdn.example.com'])
    ->frameDomains(['https://embed.example.com'])
    ->baseUriDomains(['https://base.example.com']);
```
```

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

### Client::connect()

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/client.md

Runs the protocol handshake (discover/initialize) to establish a connection.

```APIDOC
## Client::connect()

### Description
Runs the protocol handshake (discover/initialize).

### Method
`Client::connect`

### Returns
`static` - The client instance.
```

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

### GET /.well-known/oauth-protected-resource

Source: https://github.com/laravel/mcp/blob/main/_autodocs/endpoints.md

Returns RFC 9728 resource metadata for the MCP server. This endpoint is registered by the Registrar and provides information about the protected resource.

```APIDOC
## [GET] /.well-known/oauth-protected-resource

### Description
Returns RFC 9728 resource metadata for the MCP server.

### Method
GET

### Endpoint
/.well-known/oauth-protected-resource

### Response
#### Success Response (200)
- **resource** (string) - The resource identifier.
- **authorization_servers** (array of string) - List of authorization server URLs.
- **scopes_supported** (array of string) - List of supported scopes.

#### Response Example
{
  "resource": "https://example.com/<path>",
  "authorization_servers": ["https://example.com"],
  "scopes_supported": ["mcp:use"]
}
```

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

### AppMeta fluent builder with libraries

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Adds Tailwind and Alpine libraries via the fluent builder in appMeta().

```php
public function appMeta(): AppMeta
{
    return AppMeta::make()
        ->libraries(Library::Tailwind, Library::Alpine);
}
```

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

### Binary Resource Serving with Response::blob()

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

PHP tool fetches an image by ID, base64-encodes its storage content, and returns it via Response::blob(). The tool validates the required 'id' parameter.

```php
#[RendersApp(resource: GalleryApp::class, visibility: [Visibility::App])]
class GetImage extends Tool
{
    protected string $description = 'Fetch an image by ID';

    public function handle(Request $request): Response
    {
        $request->validate(['id' => 'required|integer']);

        $image = Image::findOrFail($request->get('id'));
        $data = base64_encode(Storage::get($image->path));

        return Response::blob($data);
    }
}
```

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

### Streaming Argument Previews with onToolInputPartial

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

JavaScript client shows live previews of tool arguments as the model streams them, and handles tool results with error and malformed JSON handling. Uses onToolInputPartial and onToolResult callbacks.

```js
createMcpApp(async (app) => {
    app.onToolInputPartial((params) => {
        try {
            const partial = JSON.parse(params.arguments);
            if (partial.query) {
                document.getElementById("preview").textContent = partial.query;
            }
        } catch {
            // partial JSON — ignore until parseable
        }
    });

    app.onToolResult((params) => {
        if (params.result.isError) {
            document.getElementById("error").textContent =
                params.result.content[0]?.text ?? "Unknown error";
            return;
        }

        try {
            renderResults(JSON.parse(params.result.content[0]?.text ?? "{}"));
        } catch {
            document.getElementById("error").textContent = "Malformed tool result";
        }
    });
});
```

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

### app.getHostContext()

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Returns the current host context, including theme and style variables.

```APIDOC
## app.getHostContext()

### Description
Returns the current host context, including theme and style variables.

### Method
Function call

### Response
#### Success Response
- **theme** (string) - 'light' | 'dark'
- **styles.variables** (object) - CSS variable map from host
- **styles.css.fonts** (string) - Font CSS from host

#### Response Example
```js
const ctx = app.getHostContext();
ctx?.theme; // 'light' | 'dark'
ctx?.styles?.variables; // CSS variable map from host
ctx?.styles?.css?.fonts; // font CSS from host
```
```

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

### GET /.well-known/oauth-authorization-server/{path}

Source: https://github.com/laravel/mcp/blob/main/_autodocs/endpoints.md

Returns RFC 8414 authorization server metadata for nested paths. This endpoint is registered by the Registrar and provides metadata for specific sub-paths.

```APIDOC
## [GET] /.well-known/oauth-authorization-server/{path}

### Description
Returns RFC 8414 authorization server metadata for nested paths.

### Method
GET

### Endpoint
/.well-known/oauth-authorization-server/{path}

### Parameters
#### Path Parameters
- **path** (string) - Required - The nested path.

### Response
#### Success Response (200)
- **issuer** (string) - The issuer identifier.
- **authorization_endpoint** (string) - The authorization endpoint URL.
- **token_endpoint** (string) - The token endpoint URL.
- **registration_endpoint** (string) - The registration endpoint URL (only when registration route exists).
- **response_types_supported** (array of string) - Supported response types.
- **code_challenge_methods_supported** (array of string) - Supported code challenge methods.
- **scopes_supported** (array of string) - Supported scopes.
- **grant_types_supported** (array of string) - Supported grant types.
- **token_endpoint_auth_methods_supported** (array of string) - Supported token endpoint authentication methods.

#### Response Example
{
  "issuer": "https://example.com",
  "authorization_endpoint": "https://example.com/oauth/authorize",
  "token_endpoint": "https://example.com/oauth/token",
  "registration_endpoint": "https://example.com/oauth/register",
  "response_types_supported": ["code"],
  "code_challenge_methods_supported": ["S256"],
  "scopes_supported": ["mcp:use"],
  "grant_types_supported": ["authorization_code", "refresh_token"],
  "token_endpoint_auth_methods_supported": ["none", "client_secret_basic", "client_secret_post"]
}
```

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

### Static factory: local()

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/client.md

Creates a client over StdioTransport, spawning the given command with arguments and environment variables.

```php
public static function local(string $command, array $args = [], array $env = []): static
```

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

### GET /.well-known/oauth-protected-resource/{path}

Source: https://github.com/laravel/mcp/blob/main/_autodocs/endpoints.md

Returns RFC 9728 resource metadata for nested MCP paths. This endpoint is registered by the Registrar and provides resource metadata for specific sub-paths.

```APIDOC
## [GET] /.well-known/oauth-protected-resource/{path}

### Description
Returns RFC 9728 resource metadata for nested MCP paths.

### Method
GET

### Endpoint
/.well-known/oauth-protected-resource/{path}

### Parameters
#### Path Parameters
- **path** (string) - Required - The nested MCP path.

### Response
#### Success Response (200)
- **resource** (string) - The resource identifier.
- **authorization_servers** (array of string) - List of authorization server URLs.
- **scopes_supported** (array of string) - List of supported scopes.

#### Response Example
{
  "resource": "https://example.com/<path>",
  "authorization_servers": ["https://example.com"],
  "scopes_supported": ["mcp:use"]
}
```

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

### Tool-Resource flow diagram

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Shows the sequence from an LLM calling a tool to the host rendering the AppResource in a sandboxed iframe, with createMcpApp() connecting the iframe back to the server.

```text
LLM calls Tool
    └─► Tool response includes _meta.ui.resourceUri → "ui://dashboard-app"
            └─► Host fetches AppResource at that URI
                    └─► Host renders HTML in sandboxed iframe
                            └─► createMcpApp() connects the iframe back to the server
                                    └─► UI calls app-only tools to load/refresh data
```

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

### Client::serverInfo()

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/client.md

Returns server implementation information, connecting on demand.

```APIDOC
## Client::serverInfo()

### Description
Server implementation (connect-on-demand).

### Method
`Client::serverInfo`

### Returns
`?Implementation`
```

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

### resources()

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/testing.md

Returns all resources as a TestListResponse for assertions.

```APIDOC
## resources()

### Description
Returns all resources as a TestListResponse for assertions.

### Method
resources

### Signature
`resources(): TestListResponse`

### Returns
- **TestListResponse** - All resources
```

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

### Pause Offscreen Views with IntersectionObserver

Source: https://github.com/laravel/mcp/blob/main/resources/boost/skills/mcp-development/references/app.md

Conserve resources by pausing animations and polling when the view is not visible. Uses an IntersectionObserver to start or stop a 2-second polling interval based on visibility of the document element.

```JavaScript
createMcpApp(async (app) => {
    let pollInterval = null;

    function startPolling() {
        if (!pollInterval) {
            pollInterval = setInterval(fetchData, 2000);
        }
    }

    function stopPolling() {
        clearInterval(pollInterval);
        pollInterval = null;
    }

    const observer = new IntersectionObserver(([entry]) => {
        entry.isIntersecting ? startPolling() : stopPolling();
    });

    observer.observe(document.documentElement);
    startPolling();
});
```

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

### Client::prompts()

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/client.md

Returns a collection of prompts.

```APIDOC
## Client::prompts()

### Description
Returns `Collection<string, Prompt>`.

### Method
`Client::prompts`

### Parameters
- **$limit** (?int) - Optional - Maximum number of prompts to return.
- **$default** (?iterable) - Optional - Default collection on authorization failure.

### Returns
`Collection<string, Prompt>`
```

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

### MirroredParameters::all()

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/support.md

Returns the collection of MirroredParameter instances.

```APIDOC
## MirroredParameters::all()

### Description
Returns the collection of MirroredParameter instances.

### Method
all()

### Signature
public function all(): Collection

### Returns
- **Collection** - A collection of MirroredParameter objects.
```

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

### GET mcp/oauth/{client}/client-metadata.json

Source: https://github.com/laravel/mcp/blob/main/_autodocs/endpoints.md

Serves the client ID metadata document (RFC 9396) for the OAuth client. The response includes `Cache-Control: public, max-age=3600` and excludes `client_secret`, `client_secret_expires_at`, and `registration_access_token` keys if supplied in `$clientMetadata`.

```APIDOC
## [GET] mcp/oauth/{client}/client-metadata.json

### Description
Serves the client ID metadata document (RFC 9396) for the OAuth client. The response includes `Cache-Control: public, max-age=3600` and excludes `client_secret`, `client_secret_expires_at`, and `registration_access_token` keys if supplied in `$clientMetadata`.

### Method
GET

### Endpoint
mcp/oauth/{client}/client-metadata.json (or `$clientMetadataUri`)

### Parameters
#### Path Parameters
- **client** (string) - Required - The OAuth client identifier.

### Response
#### Success Response (200)
Returns the client metadata document.

#### Response Example
```json
{
  "client_name": "<app.name> MCP Client",
  "client_uri": "https://example.com",
  "grant_types": ["authorization_code", "refresh_token"],
  "response_types": ["code"],
  "client_id": "https://example.com/mcp/oauth/{client}/client-metadata.json",
  "redirect_uris": ["https://example.com/mcp/oauth/{client}/callback", "...(custom)"],
  "token_endpoint_auth_method": "none"
}
```

```

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

### Streaming example: yielding responses from a handler

Source: https://github.com/laravel/mcp/blob/main/_autodocs/api-reference/request-response.md

Returning an iterable of responses from a tool or prompt handler makes the server stream each item. Notifications embedded in the iterable are forwarded as JSON-RPC notifications; the rest are collected and sent as one result.

```php
public function handle(Request $request): iterable
{
    yield Response::notification('notifications/progress', ['progress' => 50]);
    yield Response::text('Half done');
    yield Response::text('Done');
}
```
Tokens:
Raw