Laravel Loop

https://github.com/kirschbaum-development/laravel-loop
Admin
Laravel Loop is a powerful Model Context Protocol (MCP) server designed specifically for Laravel...
Tokens:66,301
Snippets:553
Trust Score:9.7
License:MIT
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install via Composer

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

Install the package using Composer.

```bash
composer require kirschbaum-development/laravel-loop
```

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

### Start MCP server via STDIO with artisan loop:mcp:start

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

Starts the Laravel Loop MCP server using the STDIO transport. Optional flags include --user-id, --user-model, --auth-guard, and --debug.

```bash
php artisan loop:mcp:start [--user-id=1 [--user-model=] [--auth-guard=] [--debug]
```

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

### loop:mcp:start example with user authentication

Source: https://github.com/kirschbaum-development/laravel-loop

Example invocation of the loop:mcp:start command with user ID 1, the App\Models\User model, and debug mode enabled.

```bash
php artisan loop:mcp:start --user-id=1 --user-model=App\\Models\\User --debug
```

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

### setup() method implementation

Source: https://github.com/kirschbaum-development/laravel-loop

Empty hook method invoked on scoped construction and by McpHandler::listTools(). Returns void.

```php
public function setup(): void {}
```

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

### tool() usage example

Source: https://github.com/kirschbaum-development/laravel-loop

Shows how to register a custom tool with parameters and a callback using the fluent interface.

```php
use Kirschbaum\Loop\Loop;
use Kirschbaum\Loop\Tools\CustomTool;

$loop = new Loop(app(\Kirschbaum\Loop\LoopTools::class));

$loop->tool(
    CustomTool::make(name: 'hello', description: 'Says hello')
        ->withStringParameter('name', 'A name', required: true)
        ->using(fn (string $name) => "Hello, $name!")
);
```

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

### setup()

Source: https://github.com/kirschbaum-development/laravel-loop

Hook method invoked on scoped construction and by McpHandler::listTools(). Intended for binding tools registered from external code. Current implementation is an empty body.

```APIDOC
## setup()

### Description
Hook method invoked on scoped construction and by McpHandler::listTools(). Intended for binding tools registered from external code. Current implementation is an empty body.

### Method
setup()

### Signature
public function setup(): void

### Parameters
_none_

### Returns
void
```

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

### Example: resolving default, redis, and custom drivers

Source: https://github.com/kirschbaum-development/laravel-loop

Shows how to use the manager to get the default driver (file), a named driver (redis), and register a custom driver via extend() for later reuse.

```php
use Kirschbaum\Loop\Services\SseDriverManager;

$manager = app(SseDriverManager::class);

$driver = $manager->driver();          // default driver (file, from loop.sse.driver)
$redis = $manager->driver('redis');    // redis driver

// register a custom driver for reuse later
$manager->extend('memcached', function ($app) {
    return new MemcachedDriver;
});
$custom = $manager->driver('memcached');
```

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

### loop:mcp:call usage examples

Source: https://github.com/kirschbaum-development/laravel-loop

Two example invocations: one authenticates with a user ID and prompts for tool selection, the other calls a specific tool with parameters. The first uses --user-id=1, the second uses --tool=user_list_models with --parameters="limit=5".

```bash
php artisan loop:mcp:call --user-id=1
```

```bash
php artisan loop:mcp:call --tool=user_list_models --parameters="limit=5"
```

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

### loop:mcp:generate-config example

Source: https://github.com/kirschbaum-development/laravel-loop

Example invocation of the command with a custom PHP binary path. Emits provider-specific MCP client configuration and returns Command::SUCCESS.

```bash
php artisan loop:mcp:generate-config --php-binary-path=/usr/bin/php8.3
```

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

### toolkit() usage example from service provider

Source: https://github.com/kirschbaum-development/laravel-loop

Typical usage from a service provider to register a Laravel model toolkit in read-only mode.

```php
use Illuminate\Support\ServiceProvider;
use Kirschbaum\Loop\Facades\Loop;
use Kirschbaum\Loop\Toolkits\LaravelModelToolkit;
use Kirschbaum\Loop\Enums\Mode;

class AppServiceProvider extends ServiceProvider
{
    public function boot()
    {
        Loop::toolkit(
            LaravelModelToolkit::make(
                models: [\App\Models\User::class, \App\Models\Order::class],
                mode: Mode::ReadOnly,
            )
        );
    }
}
```

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

### ErrorCode usage example

Source: https://github.com/kirschbaum-development/laravel-loop

Example of using ErrorCode::METHOD_NOT_FOUND with formatErrorResponse().

```php
use Kirschbaum\Loop\Enums\ErrorCode;

$response = $handler->formatErrorResponse(
    $requestId,
    ErrorCode::METHOD_NOT_FOUND,
    'Method not found',
);
```

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

### CustomTool::make() usage example

Source: https://github.com/kirschbaum-development/laravel-loop

Shows how to use the Makeable trait's make() method with named arguments. The example creates a CustomTool instance with name and description parameters.

```php
// CustomTool::make(name: 'x', description: 'y')
$tool = \Kirschbaum\Loop\Tools\CustomTool::make(
    name: 'custom_tool',
    description: 'This is a custom tool',
);
```

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

### Example: createSseResponse with SseService

Source: https://github.com/kirschbaum-development/laravel-loop

Example usage of SseService to create a StreamedResponse. Sends a comment, an event, and a ping.

```php
use Kirschbaum\Loop\Services\SseService;

$sse = app(SseService::class);

return $sse->createSseResponse(function () use ($sse) {
    $sse->sendComment('stream opened');
    $sse->sendEvent(['status' => 'ok'], 'message');
    $sse->sendPing();
});
```

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

### GET /{streamable_http.path}

Source: https://github.com/kirschbaum-development/laravel-loop

Legacy SSE-compat GET on the streamable endpoint. Requires Accept: text/event-stream and streams SSE events.

```APIDOC
## [GET] /{streamable_http.path}

### Description
Legacy SSE-compat GET on the streamable endpoint. Requires Accept: text/event-stream and streams SSE events.

### Method
GET

### Endpoint
/{streamable_http.path} (default /mcp)

### Response
#### Success Response (200)
Streams SSE: an `endpoint` event, then `: heartbeat` comments every 15 s until disconnect.

#### Error Response (406)
- **jsonrpc** (string) - JSON-RPC version
- **id** (null) - Always null
- **error** (object) - Error object with code and message

### Response Example
```
event: endpoint
data: {"status":"connected","transport_protocol":"http_sse_deprecated_2024_11_05","message":"SSE connection established for server-initiated messages."}
```

### Error Example
```json
{"jsonrpc":"2.0","id":null,"error":{"code":-32000,"message":"Not Acceptable: Client must include \"Accept: text/event-stream\" for this endpoint."}}
```
```

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

### Call a tool via MCP

Source: https://github.com/kirschbaum-development/laravel-loop

Invokes the 'hello' tool with an argument 'name' set to 'Ada' through the /mcp endpoint. No authorization header is included in this example.

```bash
curl -X POST http://your-app.test/mcp \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"hello","arguments":{"name":"Ada"}}}'
```

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

### listTools method signature

Source: https://github.com/kirschbaum-development/laravel-loop

Lists available tools. Invokes $this->loop->setup(), builds each Prism tool, and maps each to a structure with name, description, and inputSchema. Returns array{tools: array<array-key, mixed>}.

```php
public function listTools(): array
```

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

### LaravelFactoriesToolkit usage example

Source: https://github.com/kirschbaum-development/laravel-loop

Example of using LaravelFactoriesToolkit with the Loop facade. Provides factory-related tools for creating test data, including DescribeModelFactoryTool and CreateModelFactoryTool. Use LaravelFactoriesToolkit::make() since there is no explicit constructor.

```php
use Kirschbaum\Loop\Facades\Loop;
use Kirschbaum\Loop\Toolkits\LaravelFactoriesToolkit;

Loop::toolkit(LaravelFactoriesToolkit::make());
```

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

### php artisan loop:mcp:start

Source: https://github.com/kirschbaum-development/laravel-loop

Starts the MCP server over STDIO transport. This command serves the Laravel application tools to MCP clients.

```APIDOC
## php artisan loop:mcp:start

### Description
Starts the MCP server over STDIO transport. This command serves the Laravel application tools to MCP clients.

### Method
`php artisan loop:mcp:start`

### Parameters
None.

### Example
```bash
php artisan loop:mcp:start
```
```

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

### Example: register and send a message to a client

Source: https://github.com/kirschbaum-development/laravel-loop

Shows how to resolve the SseSessionManager from the container, register a client connection, and send a JSON-RPC message to it. The sendToClient call returns a boolean.

```php
use Kirschbaum\Loop\Services\SseSessionManager;

$manager = app(SseSessionManager::class);

$manager->registerConnection('abc123');
$sent = $manager->sendToClient('abc123', ['jsonrpc' => '2.0', 'id' => 1, 'result' => []]);
```

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

### Driver resolution and usage example

Source: https://github.com/kirschbaum-development/laravel-loop

Shows how to resolve an SSE driver via SseDriverManager and use it to register a session, check existence, send a message, and retrieve messages. Uses the 'redis' driver as an example.

```php
use Kirschbaum\Loop\Services\SseDriverManager;

$manager = app(SseDriverManager::class);

$driver = $manager->driver('redis');
$driver->registerSession('abc456');

if ($driver->sessionExists('abc456')) {
    $driver->sendMessage('abc456', ['jsonrpc' => '2.0', 'id' => 1, 'result' => ['success' => true]]);
    $messages = $driver->getMessages('abc456');
}
```

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

### loop:mcp:start command signature

Source: https://github.com/kirschbaum-development/laravel-loop

Shows the available options for the loop:mcp:start artisan command. Use --user-id, --user-model, --auth-guard to configure authentication, and --debug to enable debug mode.

```bash
loop:mcp:start
  {--user-id= : The user ID to authenticate the requests with}
  {--user-model= : The model to use to authenticate the requests with}
  {--auth-guard= : The Auth guard to use to authenticate the requests with}
  {--debug : Enable debug mode}
```

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

### Example: register a tool and clear the registry

Source: https://github.com/kirschbaum-development/laravel-loop

Creates a new LoopTools instance, registers a tool, clears the registry, and dumps whether the tool collection is empty (true).

```php
use Kirschbaum\Loop\LoopTools;

$registry = new LoopTools;
$registry->registerTool($toolInstance);
$registry->clear();

dump($registry->getTools()->isEmpty()); // true
```

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

### Custom tool contract implementation (HelloTool)

Source: https://github.com/kirschbaum-development/laravel-loop

Example implementation of the `Tool` contract. Uses the `Makeable` trait for the factory, builds a Prism tool with a required string parameter, and returns 'hello' as the tool name.

```php
use Kirschbaum\Loop\Contracts\Tool;
use Prism\Prism\Tool as PrismTool;

class HelloTool implements Tool
{
    use \Kirschbaum\Loop\Concerns\Makeable;

    public function build(): PrismTool
    {
        return app(PrismTool::class)
            ->as($this->getName())
            ->for('Says hello to the user')
            ->withStringParameter('name', 'The name of the user to say hello to.', required: true)
            ->using(fn (string $name) => "Hello, $name!");
    }

    public function getName(): string
    {
        return 'hello';
    }
}
```

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

### Add Laravel Loop MCP server to Claude Code via STDIO

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

Use these commands to register the Laravel Loop MCP server with Claude Code using the STDIO transport. The first command is the basic setup; the second adds an authenticated user; the third enables debug mode.

```bash
claude mcp add laravel-loop-mcp php /your/full/path/to/laravel/artisan loop:mcp:start

# with an authenticated user
claude mcp add laravel-loop-mcp php /your/full/path/to/laravel/artisan loop:mcp:start --user-id=1 --user-model=App\Models\User

# with debug mode
claude mcp add laravel-loop-mcp php /your/full/path/to/laravel/artisan loop:mcp:start --debug
```

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

### LaravelModelToolkit usage example

Source: https://github.com/kirschbaum-development/laravel-loop

Example of using LaravelModelToolkit with the Loop facade. Passes an array of model classes and sets mode to Mode::ReadOnly. The toolkit builds DescribeModelTool, ListModelsTool, and FindModelTool for each model.

```php
use Kirschbaum\Loop\Facades\Loop;
use Kirschbaum\Loop\Toolkits\LaravelModelToolkit;
use Kirschbaum\Loop\Enums\Mode;

Loop::toolkit(
    LaravelModelToolkit::make(
        models: [\App\Models\User::class, \App\Models\Post::class],
        mode: Mode::ReadOnly,
    )
);
```

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

### GET /{sse.path}

Source: https://github.com/kirschbaum-development/laravel-loop

HTTP+SSE connect endpoint for the legacy SSE transport. Establishes an SSE connection for server-initiated messages.

```APIDOC
## [GET] /{sse.path}

### Description
HTTP+SSE connect endpoint for the legacy SSE transport. Establishes an SSE connection for server-initiated messages.

### Method
GET

### Endpoint
/{sse.path} (default /mcp/sse)

### Response
#### Success Response (200)
SSE connection established.

### Response Example
```
event: endpoint
data: {"status":"connected","transport_protocol":"http_sse_deprecated_2024_11_05","message":"SSE connection established for server-initiated messages."}
```
```

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

### GET /{sse.path} — connect

Source: https://github.com/kirschbaum-development/laravel-loop

Creates an SSE session and returns a stream of events. The first event is an 'endpoint' event with the message POST URL, followed by 'message' events for each delivered message and a 'ping' event every 30 seconds.

```APIDOC
## [GET] /{sse.path}

### Description
Creates an SSE session and returns a stream of events. The first event is an 'endpoint' event with the message POST URL, followed by 'message' events for each delivered message and a 'ping' event every 30 seconds.

### Method
GET

### Endpoint
/{sse.path}

### Parameters
No parameters.

### Response
#### Success Response (200)
- **Content-Type**: text/event-stream
- **Body**: First event is `endpoint` with the message POST URL, then `message` events for each delivered message, and a `ping` event every 30 seconds.

#### Request Example
```
event: endpoint
data: "/mcp/sse/message/?sessionId=<uniqid>"
```
```

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

### Custom toolkit implementation (GreetingToolkit)

Source: https://github.com/kirschbaum-development/laravel-loop

Example implementation of the `Toolkit` contract. Uses the `Makeable` trait and returns a `ToolCollection` containing `HelloTool` and `GoodbyeTool` instances.

```php
use Kirschbaum\Loop\Collections\ToolCollection;
use Kirschbaum\Loop\Contracts\Toolkit;

class GreetingToolkit implements Toolkit
{
    use \Kirschbaum\Loop\Concerns\Makeable;

    public function getTools(): ToolCollection
    {
        return new ToolCollection([
            HelloTool::make(),
            GoodbyeTool::make(),
        ]);
    }
}
```

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

### Register StripeTool read-only with default description

Source: https://github.com/kirschbaum-development/laravel-loop

Example of registering the StripeTool with no arguments, using the default API key from config and the default Mode::ReadOnly.

```php
use Kirschbaum\Loop\Tools\StripeTool;

Loop::tool(StripeTool::make());
```

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

### Example: handling a tools/list request

Source: https://github.com/kirschbaum-development/laravel-loop

Shows how to use McpHandler to handle a JSON-RPC request. The result contains jsonrpc '2.0', id 1, and result with tools list.

```php
use Kirschbaum\Loop\McpHandler;

$handler = app(McpHandler::class);

$result = $handler->handle([
    'jsonrpc' => '2.0',
    'id' => 1,
    'method' => 'tools/list',
    'params' => new \stdClass,
]);

// $result['jsonrpc'] === '2.0', $result['id'] === 1, $result['result']['tools'] = [...]
```

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

### Custom SSE driver implementation (InMemoryDriver)

Source: https://github.com/kirschbaum-development/laravel-loop

Example skeleton implementation of the `SseDriverInterface` contract. Each method body is left as a placeholder comment; implement the logic for in-memory session storage.

```php
use Kirschbaum\Loop\Contracts\SseDriverInterface;

class InMemoryDriver implements SseDriverInterface
{
    public function registerSession(string $sessionId): bool { /* ... */ }
    public function sessionExists(string $sessionId): bool { /* ... */ }
    public function sendMessage(string $sessionId, array $data): bool { /* ... */ }
    public function getMessages(string $sessionId, int $lastMessageId = -1): array { /* ... */ }
    public function removeSession(string $sessionId): bool { /* ... */ }
    public function getActiveSessions(): array { /* ... */ }
}
```

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

### SSE endpoint event

Source: https://github.com/kirschbaum-development/laravel-loop

Streamed by GET /{path} on success. An 'endpoint' event is sent, followed by ': heartbeat' comments every 15 seconds until disconnect.

```text
event: endpoint
data: {"status":"connected","transport_protocol":"http_sse_deprecated_2024_11_05","message":"SSE connection established for server-initiated messages."}
```

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

### Register StripeTool with ReadWrite mode

Source: https://github.com/kirschbaum-development/laravel-loop

Example of registering the StripeTool with an explicit API key and Mode::ReadWrite to allow POST/PUT/DELETE requests. Uses the Loop facade.

```php
use Kirschbaum\Loop\Tools\StripeTool;
use Kirschbaum\Loop\Enums\Mode;
use Kirschbaum\Loop\Facades\Loop;

Loop::tool(
    StripeTool::make(
        apiKey: config('services.stripe.secret'),
        mode: Mode::ReadWrite, // allow POST/PUT/DELETE
    )
);
```

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

### Register LaravelModelToolkit via Loop facade

Source: https://github.com/kirschbaum-development/laravel-loop

Registers the model toolkit with the Loop facade, passing an array of model classes. This is the only code example on the page; the shared concerns are described in prose without code.

```php
use Kirschbaum\Loop\Facades\Loop;
use Kirschbaum\Loop\Toolkits\LaravelModelToolkit;

Loop::toolkit(
    LaravelModelToolkit::make(models: [\App\Models\Product::class])
);
```

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

### Route registration for streamable HTTP and SSE endpoints

Source: https://github.com/kirschbaum-development/laravel-loop

Defines the POST and GET routes for the streamable HTTP and SSE endpoints, applying the enabled-guard middleware first, then user-configured middleware (default `['auth:sanctum']`).

```plaintext
POST /{streamable_http.path}              → McpController          [middleware: StreamableHttpEnabledMiddleware, ...loop.streamable_http.middleware]
GET  /{sse.path}                           → McpSSEController::connect
POST /{sse.path}/message                   → McpSSEController::message
                                            [middleware: LegacySseEnabledMiddleware, ...loop.sse.middleware]
```

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

### GET /mcp/sse

Source: https://github.com/kirschbaum-development/laravel-loop

Establishes an SSE connection, creates a session, and streams messages to the client. Sends an endpoint event with the POST URL, a debug event, and periodic ping events.

```APIDOC
## [GET] /mcp/sse

### Description
Establishes an SSE connection, creates a session, and streams messages to the client. Sends an endpoint event with the POST URL, a debug event, and periodic ping events.

### Method
GET

### Endpoint
/mcp/sse

### Response
#### Success Response (200)
- **StreamedResponse** - SSE stream with events: `endpoint`, `debug`, `ping`, and message events.

### Request Example
No request example provided.

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

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

### Build Toolkit with Multiple Tools

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

Create a toolkit that returns a collection of tools using the Toolkit contract.

```php
use Kirschbaum\Loop\Collections\ToolCollection;
use Kirschbaum\Loop\Contracts\Toolkit;

class LaravelFactoriesToolkit implements Toolkit
{
    use \Kirschbaum\Loop\Concerns\Makeable;

    public function getTools(): ToolCollection
    {
        return new ToolCollection([
            HelloTool::make(),
            GoodbyeTool::make(),
        ]);
    }
}
```

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

### toolkit() method implementation

Source: https://github.com/kirschbaum-development/laravel-loop

Registers every tool from the toolkit in the backing registry and returns $this for fluent chaining.

```php
public function toolkit(Toolkit $toolkit): static
{
    $this->loopTools->registerToolkit($toolkit);

    return $this;
}
```

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

### Publish Configuration File

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

Publish the package configuration file using the loop-config tag.

```bash
php artisan vendor:publish --tag="loop-config"
```

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

### Using Loop Facade to Register a Tool

Source: https://github.com/kirschbaum-development/laravel-loop

Shows how to use the Loop facade to register a custom tool. The tool method accepts a CustomTool instance created with the make method, passing a name and description.

```php
use Kirschbaum\Loop\Facades\Loop;

Loop::tool(CustomTool::make(name: 'my_tool', description: 'Does work'));
```

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

### Implement Tool Contract

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

Implement the Tool contract to create a custom tool class that returns a Prism Tool instance.

```php
use Kirschbaum\Loop\Contracts\Tool;

class HelloTool implements Tool
{
    use \Kirschbaum\Loop\Concerns\Makeable;

    public function build(): \Prism\Prism\Tool
    {
        return app(\Prism\Prism\Tool::class)
            ->as($this->getName())
            ->for('Says hello to the user')
            ->withStringParameter('name', 'The name of the user to say hello to.', required: true)
            ->using(fn (string $name) => "Hello, $name!");
    }

    public function getName(): string
    {
        return 'hello';
    }
}
```

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

### formatErrorResponse usage example

Source: https://github.com/kirschbaum-development/laravel-loop

Example of calling formatErrorResponse with a JSON-RPC request id, an ErrorCode enum value, and an error message. The $data parameter is omitted, defaulting to null.

```php
$response = $handler->formatErrorResponse(
    $message['id'] ?? null,
    \Kirschbaum\Loop\Enums\ErrorCode::METHOD_NOT_FOUND,
    'Method not found',
);
```

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

### Enable Streamable HTTP and SSE transports via .env

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

Set these environment variables to enable the Streamable HTTP transport (LOOP_STREAMABLE_HTTP_ENABLED=true) and the deprecated SSE transport (LOOP_SSE_ENABLED=true). Only one needs to be enabled.

```bash
# streamable http
LOOP_STREAMABLE_HTTP_ENABLED=true

# sse
LOOP_SSE_ENABLED=true
```

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

### tool() method implementation

Source: https://github.com/kirschbaum-development/laravel-loop

Registers a single tool in the backing LoopTools registry and returns $this for fluent chaining.

```php
public function tool(Tool $tool): static
{
    $this->loopTools->registerTool($tool);

    return $this;
}
```

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

### getPrismTool() method implementation

Source: https://github.com/kirschbaum-development/laravel-loop

Returns a Prism Tool built from the named tool. Throws if no tool with that name exists because the lookup returns null and build() fails.

```php
public function getPrismTool(string $name): PrismTool
{
    return $this->loopTools
        ->getTools()
        ->getTool($name)
        ->build();
}
```

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

### initialize(array $clientInfo, array $capabilities, string $protocolVersion): array

Source: https://github.com/kirschbaum-development/laravel-loop

Initializes the MCP session with client information, capabilities, and protocol version. Returns the server's protocol version, server info, capabilities, and optional instructions.

```APIDOC
## initialize(array $clientInfo, array $capabilities, string $protocolVersion): array

### Description
Initializes the MCP session with client information, capabilities, and protocol version. Returns the server's protocol version, server info, capabilities, and optional instructions.

### Method
initialize

### Parameters
- **$clientInfo** (array) - Required - MCP client info from request params
- **$capabilities** (array) - Required - Client capabilities from request params
- **$protocolVersion** (string) - Required - Requested protocol version

### Response
Returns a result array `{ protocolVersion, serverInfo, capabilities, instructions? }`. If `$protocolVersion` is not in `SUPPORTED_PROTOCOL_VERSIONS`, it is replaced with `LATEST_PROTOCOL_VERSION` (`2024-11-05`). The `instructions` key is only added when `$config['instructions']` is non-null.
```

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

### Register Tools in Service Provider

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

Register tools in the AppServiceProvider using the Loop facade and FilamentToolkit.

```php
use Illuminate\Support\ServiceProvider;
use Kirschbaum\Loop\Facades\Loop;
use Kirschbaum\Loop\Toolkits;
use Kirschbaum\Loop\Tools;

Loop::toolkit(Kirschbaum\Loop\Filament\FilamentToolkit::make());
```

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

### Define Custom Tool with Loop::tool

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

Define a custom tool using the Loop::tool method with string and number parameters.

```php
use Kirschbaum\Loop\Facades\Loop;
use Kirschbaum\Loop\Tools\CustomTool;

Loop::tool(
    CustomTool::make(
        name: 'custom_tool',
        description: 'This is a custom tool',
    )
        ->withStringParameter(name: 'name', description: 'The name of the user', required: true)
        ->withNumberParameter(name: 'age', description: 'The age of the user')
        ->using(function (string $name, ?int $age = null) {
            return sprintf('Hello, %s! You are %d years old.', $name, $age ?? 'unknown');
        }),
    );
```

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

### 406 Not Acceptable error response

Source: https://github.com/kirschbaum-development/laravel-loop

Returned by GET /{path} when the client does not include 'Accept: text/event-stream'. The error code is -32000.

```json
{"jsonrpc":"2.0","id":null,"error":{"code":-32000,"message":"Not Acceptable: Client must include \"Accept: text/event-stream\" for this endpoint."}}
```

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

### getPrismTools() method implementation

Source: https://github.com/kirschbaum-development/laravel-loop

Returns a base collection of Prism Tool instances built from each registered tool.

```php
public function getPrismTools(): Collection
{
    return $this->loopTools
        ->getTools()
        ->toBase()
        ->map(fn (Tool $tool) => $tool->build());
}
```

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

### toolkit(Toolkit $toolkit): static

Source: https://github.com/kirschbaum-development/laravel-loop

Registers every tool from the toolkit in the backing registry. Returns $this for fluent chaining.

```APIDOC
## toolkit(Toolkit $toolkit): static

### Description
Registers every tool from the toolkit in the backing registry. Returns $this for fluent chaining.

### Method
toolkit()

### Signature
public function toolkit(Toolkit $toolkit): static

### Parameters
- **$toolkit** (Kirschbaum\Loop\Contracts\Toolkit) - Required - Toolkit whose tools are all registered

### Returns
$this (fluent)

### Request Example
```php
use Illuminate\Support\ServiceProvider;
use Kirschbaum\Loop\Facades\Loop;
use Kirschbaum\Loop\Toolkits\LaravelModelToolkit;
use Kirschbaum\Loop\Enums\Mode;

class AppServiceProvider extends ServiceProvider
{
    public function boot()
    {
        Loop::toolkit(
            LaravelModelToolkit::make(
                models: [\App\Models\User::class, \App\Models\Order::class],
                mode: Mode::ReadOnly,
            )
        );
    }
}
```
```

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

### CustomTool build() method

Source: https://github.com/kirschbaum-development/laravel-loop

Returns the internal Prism\Prism\Tool instance.

```php
public function build(): PrismTool
{
    return $this->prismTool;
}
```

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

### LogsMessages trait usage in a service class

Source: https://github.com/kirschbaum-development/laravel-loop

Shows how to use the LogsMessages trait in a custom service class. The example logs an info-level message with context and an error-level message with an exception.

```php
class MyService
{
    use \Kirschbaum\Loop\Concerns\LogsMessages;

    public function run(): void
    {
        $this->log('Processing started', ['user_id' => 5]);
        $this->log('Processing failed', ['exception' => $e], 'error');
    }
}
```

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

### LoopTools constructor initializes ToolCollection

Source: https://github.com/kirschbaum-development/laravel-loop

Takes no parameters and initializes an empty ToolCollection.

```php
public function __construct()
{
    $this->tools = new ToolCollection;
}
```

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

### getMessages(string $clientId, int $lastMessageId = -1): array

Source: https://github.com/kirschbaum-development/laravel-loop

Retrieves messages for a client session, optionally starting from a specific message ID. Delegates to the underlying SSE driver.

```APIDOC
## getMessages(string $clientId, int $lastMessageId = -1): array

### Description
Delegates to `driver()->getMessages($clientId, $lastMessageId)`. Returns `array<mixed>` of messages.

### Method
getMessages

### Parameters
- **$clientId** (string) - Required - Client session ID
- **$lastMessageId** (int) - Optional - ID of the last delivered message (default: -1)

### Response
- **array<mixed>** - List of messages
```

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

### Configure authentication middleware for MCP endpoints

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

PHP configuration for securing the Streamable HTTP and SSE MCP endpoints using Sanctum middleware. Recommended when exposing endpoints publicly.

```php
[
    'streamable_http' => [
        'middleware' => ['auth:sanctum'],
    ],
    
    'sse' => [
        'middleware' => ['auth:sanctum'],
    ],
]
```

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

### CustomTool::__construct

Source: https://github.com/kirschbaum-development/laravel-loop

Creates a new CustomTool instance with a name and description, building an internal PrismTool.

```APIDOC
## CustomTool::__construct

### Description
Creates a new CustomTool instance with a name and description, building an internal PrismTool.

### Method
Constructor

### Signature
```php
public function __construct(
    public readonly string $name,
    public readonly string $description,
)
```

### Parameters
- **$name** (string) - Required - Tool name (used as the MCP tool name)
- **$description** (string) - Required - Tool description exposed to the client

### Notes
The constructor builds an internal `PrismTool` via `app(PrismTool::class)->as($this->getName())->for($this->description)`.
```

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

### Configure Laravel Loop MCP server in JSON config file (STDIO)

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

JSON configuration for MCP clients that use a config file (e.g., Cursor, Claude). Specifies the artisan command and arguments for the STDIO transport, including an optional --user-id.

```json
{
  "mcpServers": {
    "laravel-loop-mcp": {
      "command": "php",
      "args": [
        "/your/full/path/to/laravel/artisan",
        "loop:mcp:start",
        "--user-id=1"
      ]
    }
  }
}
```

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

### getPrismTools(): Collection

Source: https://github.com/kirschbaum-development/laravel-loop

Returns a base collection of Prism Tool instances, one per registered tool, built via each tool's build().

```APIDOC
## getPrismTools(): Collection

### Description
Returns a base collection of Prism Tool instances, one per registered tool, built via each tool's build().

### Method
getPrismTools()

### Signature
public function getPrismTools(): Collection

### Parameters
_none_

### Returns
Illuminate\Support\Collection (base collection) of Prism\Prism\Tool instances
```

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

### Configure SSE MCP server in JSON config file

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

JSON configuration for MCP clients that use a config file, pointing to the SSE endpoint URL.

```json
{
  "mcpServers": {
    "laravel-loop-mcp": {
      "url": "http://your-url.test/mcp/sse",
    }
  }
}
```

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

### initialize method signature

Source: https://github.com/kirschbaum-development/laravel-loop

Initializes the MCP session. Returns a result array with protocolVersion, serverInfo, capabilities, and optional instructions. If the requested protocol version is not supported, it is replaced with LATEST_PROTOCOL_VERSION (2024-11-05).

```php
public function initialize(array $clientInfo, array $capabilities, string $protocolVersion): array
```

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

### Generate MCP client configuration with artisan loop:mcp:generate-config

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

Run this artisan command to interactively generate the MCP client configuration for your Laravel Loop server.

```bash
php artisan loop:mcp:generate-config
```

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

### POST /mcp - initialize

Source: https://github.com/kirschbaum-development/laravel-loop

Initializes an MCP session over streamable HTTP. Sends a JSON-RPC initialize request to the MCP endpoint.

```APIDOC
## [POST] /mcp

### Description
Initializes an MCP session over streamable HTTP.

### Method
POST

### Endpoint
/mcp

### Request Example
```bash
curl -X POST http://your-app.test/mcp \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"clientInfo":{"name":"Test Client"},"capabilities":{},"protocolVersion":"2024-11-05"}}'
```
```

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

### CustomTool constructor

Source: https://github.com/kirschbaum-development/laravel-loop

Defines the constructor for CustomTool, which takes a name and description and builds an internal PrismTool via app(PrismTool::class)->as($this->getName())->for($this->description).

```php
public function __construct(
    public readonly string $name,
    public readonly string $description,
)
```

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

### build method signature

Source: https://github.com/kirschbaum-development/laravel-loop

Returns a Prism\Prism\Tool named 'stripe_tool' with declared string parameters for method, path, body, contentType, and query.

```php
public function build(): PrismTool
```

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

### getPrismTool(string $name): PrismTool

Source: https://github.com/kirschbaum-development/laravel-loop

Returns a Prism Tool built from the named tool. Throws if no tool with that name exists.

```APIDOC
## getPrismTool(string $name): PrismTool

### Description
Returns a Prism Tool built from the named tool. Throws if no tool with that name exists.

### Method
getPrismTool()

### Signature
public function getPrismTool(string $name): PrismTool

### Parameters
- **$name** (string) - Required - Tool name (the value returned by Tool::getName())

### Returns
Prism\Prism\Tool
```

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

### CustomTool::getName

Source: https://github.com/kirschbaum-development/laravel-loop

Returns the configured tool name.

```APIDOC
## CustomTool::getName

### Description
Returns the configured tool name.

### Method
getName

### Signature
```php
public function getName(): string
```

### Return Value
- **string** - The configured tool name.
```

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

### CustomTool::build

Source: https://github.com/kirschbaum-development/laravel-loop

Returns the internal Prism\Prism\Tool instance.

```APIDOC
## CustomTool::build

### Description
Returns the internal Prism\Prism\Tool instance.

### Method
build

### Signature
```php
public function build(): PrismTool
```

### Return Value
- **PrismTool** - The internal Prism\Prism\Tool instance.
```

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

### Create and register a CustomTool with parameters and handler

Source: https://github.com/kirschbaum-development/laravel-loop

Builds a custom tool for the Loop package using Kirschbaum\Loop\Tools\CustomTool, adds string and number parameters, defines a handler closure, and registers it with Loop::tool(). Call parameter builders before using() if the handler depends on the declared parameters; the source does not enforce order.

```php
use Kirschbaum\Loop\Tools\CustomTool;

$tool = CustomTool::make(
    name: 'custom_tool',
    description: 'This is a custom tool',
)
    ->withStringParameter(name: 'name', description: 'The name of the user', required: true)
    ->withNumberParameter(name: 'age', description: 'The age of the user')
    ->using(function (string $name, ?int $age = null) {
        return sprintf('Hello, %s! You are %d years old.', $name, $age ?? 0);
    });

Loop::tool($tool);
```

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

### context() method implementation

Source: https://github.com/kirschbaum-development/laravel-loop

Appends context text with a newline separator and returns $this for fluent chaining. The accumulated context is stored but not currently read by other public methods.

```php
public function context(string $context): static
{
    $this->context .= "\n\n".$context;

    return $this;
}
```

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

### Manually call MCP tools with php artisan loop:mcp:call

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

Run this Artisan command to manually invoke MCP tools and verify their output, which helps debug unexpected results when building tools. Useful when debugging from the MCP client is difficult. Check application logs for details on any errors.

```bash
php artisan loop:mcp:call
```

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

### Error handling with getTool()

Source: https://github.com/kirschbaum-development/laravel-loop

Checks if a tool is registered before building it, throwing a RuntimeException if not found.

```php
$listTools = $tools->getTool('list_models');

if ($listTools === null) {
    throw new \RuntimeException('Tool not registered');
}

$prismTool = $listTools->build();
```

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

### Expose tools with Loop::toolkit and Loop::tool

Source: https://github.com/kirschbaum-development/laravel-loop

Register a model toolkit and a custom tool in a service provider. The custom tool uses a fluent builder with a required string parameter and a closure handler.

```php
use Kirschbaum\Loop\Facades\Loop;
use Kirschbaum\Loop\Toolkits\LaravelModelToolkit;
use Kirschbaum\Loop\Tools\CustomTool;

Loop::toolkit(LaravelModelToolkit::make(models: [\App\Models\User::class]));

Loop::tool(
    CustomTool::make(name: 'hello', description: 'Says hello')
        ->withStringParameter('name', 'A name', required: true)
        ->using(fn (string $name) => "Hello, $name!")
);
```

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

### Proxy SSE through mcp-remote package

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/README.md

JSON configuration to proxy the MCP server through the mcp-remote package, requiring Node.js > 20. Useful for clients that do not support direct SSE connections.

```json
{
  "mcpServers": {
    "laravel-loop-mcp": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://your-remote-url.com/mcp",
        "--header",
        "Authorization: Bearer ${AUTH_TOKEN}"
      ]
    }
  }
}
```

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

### sendPing(): void

Source: https://github.com/kirschbaum-development/laravel-loop

Sends a ping event with the current timestamp as data. Useful for keeping the connection alive.

```APIDOC
## sendPing(): void

### Description
Sends a ping event with the current timestamp as data. Useful for keeping the connection alive.

### Method
sendPing

### Parameters
None

### Response
Returns void.
```

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

### McpSSEController constructor

Source: https://github.com/kirschbaum-development/laravel-loop

Injects McpHandler, SseService, and SseSessionManager dependencies for the legacy HTTP+SSE endpoint.

```php
public function __construct(
    protected McpHandler $mcpHandler,
    protected SseService $sse,
    protected SseSessionManager $sessionManager
)
```

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

### Enable MCP SSE Transport in .env

Source: https://github.com/kirschbaum-development/laravel-loop/blob/main/docs/mcp-sse-transport.md

Add these environment variables to enable the SSE transport. LOOP_SSE_PATH defaults to /mcp/sse and LOOP_SSE_DRIVER defaults to file, with options 'file' or 'redis'.

```plaintext
LOOP_SSE_ENABLED=true
LOOP_SSE_PATH=/mcp/sse  # This is the default, can be changed if needed
LOOP_SSE_DRIVER=file    # Default driver, options: "file" or "redis"
```

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

### tool(Tool $tool): static

Source: https://github.com/kirschbaum-development/laravel-loop

Registers a single tool in the backing LoopTools registry. Returns $this for fluent chaining.

```APIDOC
## tool(Tool $tool): static

### Description
Registers a single tool in the backing LoopTools registry. Returns $this for fluent chaining.

### Method
tool()

### Signature
public function tool(Tool $tool): static

### Parameters
- **$tool** (Kirschbaum\Loop\Contracts\Tool) - Required - Tool to register

### Returns
$this (fluent)

### Request Example
```php
use Kirschbaum\Loop\Loop;
use Kirschbaum\Loop\Tools\CustomTool;

$loop = new Loop(app(\Kirschbaum\Loop\LoopTools::class));

$loop->tool(
    CustomTool::make(name: 'hello', description: 'Says hello')
        ->withStringParameter('name', 'A name', required: true)
        ->using(fn (string $name) => "Hello, $name!")
);
```
```

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

### listTools(): array

Source: https://github.com/kirschbaum-development/laravel-loop

Lists all available tools provided by the Loop. Returns an array with a 'tools' key containing tool definitions.

```APIDOC
## listTools(): array

### Description
Lists all available tools provided by the Loop. Returns an array with a 'tools' key containing tool definitions.

### Method
listTools

### Response
Returns `array{tools: array<array-key, mixed>}`. Each tool is mapped to `{ name, description, inputSchema: { type: 'object', properties, required, additionalProperties: false } }`.
```

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

### Default tool description string

Source: https://github.com/kirschbaum-development/laravel-loop

The default public $description value used when no description is provided to the constructor.

```text
'make a call to the stripe api. You can use this tool to fetch any stripe related data. Please double check with the user for any non-GET requests.'
```

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

### MCP JSON-RPC methods

Source: https://github.com/kirschbaum-development/laravel-loop

The MCP handler dispatches JSON-RPC methods for initialization, ping, resource listing, tool calling, and prompt listing. Notifications are also supported.

```APIDOC
## MCP JSON-RPC methods

### Description
The MCP handler dispatches JSON-RPC methods for initialization, ping, resource listing, tool calling, and prompt listing. Notifications are also supported.

### Methods

#### initialize
- **Params**: clientInfo, capabilities, protocolVersion
- **Result**: {protocolVersion, serverInfo, capabilities, instructions?}

#### ping
- **Params**: none
- **Result**: []

#### resources/list
- **Params**: none
- **Result**: {resources: []}

#### resources/templates/list
- **Params**: none
- **Result**: {resourceTemplates: []}

#### resources/read
- **Params**: none
- **Result**: Error: LoopMcpException('Resource not found')

#### tools/list
- **Params**: none
- **Result**: {tools: [{name, description, inputSchema}]}

#### tools/call
- **Params**: name (required), arguments
- **Result**: {content:[{type:'text',text}]} or the same with isError:true

#### prompts/list
- **Params**: none
- **Result**: {prompts: []}

#### prompts/get
- **Params**: none
- **Result**: Error: LoopMcpException('Prompt not found')

#### any other
- **Params**: none
- **Result**: Error: LoopMcpException($method)

### Notifications
Methods whose name starts with `notification` are treated as notifications and return `{success: true}`.

### Protocol Versions
Supported: `2024-11-05` (latest, default) and `2024-10-07`. If the client sends another version, `2024-11-05` is used.
```

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

### loop:mcp:generate-config signature

Source: https://github.com/kirschbaum-development/laravel-loop

Shows the command signature for the interactive MCP configuration generator. The --url option defaults to config("app.url") and --php-binary-path defaults to `php`.

```bash
loop:mcp:generate-config
  {--url= : The base URL of your application (optional, defaults to config("app.url"))}
  {--php-binary-path= : The PHP binary path to (optional, defaults to `php`)}
```

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

### StripeTool constructor signature

Source: https://github.com/kirschbaum-development/laravel-loop

Constructor for the StripeTool class. Accepts an optional API key, description, and mode. The mode defaults to Mode::ReadOnly, which rejects non-GET requests with bodies.

```php
public function __construct(
    public readonly ?string $apiKey = null,
    ?string $description = null,
    public readonly Mode $mode = Mode::ReadOnly,
)
```

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

### Loop Facade Class Definition

Source: https://github.com/kirschbaum-development/laravel-loop

Defines the Loop facade that proxies static calls to the underlying Loop instance. The getFacadeAccessor method returns the Loop class name for Laravel's service container.

```php
namespace Kirschbaum\Loop\Facades;

use Illuminate\Support\Facades\Facade;

/** @mixin \Kirschbaum\Loop\Loop */
class Loop extends Facade
{
    protected static function getFacadeAccessor(): string
    {
        return \Kirschbaum\Loop\Loop::class;
    }
}
```

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

### DescribeModelTool constructor

Source: https://github.com/kirschbaum-development/laravel-loop

Constructor for DescribeModelTool, which describes an Eloquent model. Takes the model class, label, and plural label.

```php
public function __construct(
    private string $modelClass,
    private string $label,
    private string $pluralLabel
)
```

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

### clear(): void

Source: https://github.com/kirschbaum-development/laravel-loop

Resets both the tool collection and the toolkits array to empty. Returns void.

```php
public function clear(): void
{
    $this->tools = new ToolCollection;
    $this->toolkits = [];
}
```
Tokens:
Raw