> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Tools

> Definieer en verwerk custom tools met de Laravel Copilot SDK, inclusief permissie-instellingen, aanroepmetadata en MCP-resultaatconversie.

## Tools

De ingebouwde tools van de Copilot CLI zijn standaard ingeschakeld. Wat je hier kunt opgeven zijn custom tools.

## Basisgebruik

Geef de tooldefinities op via `tools` in de SessionConfig.

`Tool::define()` is een helper vergelijkbaar met `defineTool` in versies voor andere talen.
Voor parameters kun je het JsonSchema gebruiken dat Laravel zelf gebruikt in Laravel MCP. Je kunt ook rechtstreeks een array opgeven zonder JsonSchema.

```php theme={null}
use Illuminate\Support\Facades\Artisan;
use Illuminate\JsonSchema\JsonSchema;
use Revolution\Copilot\Contracts\CopilotSession;
use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\SessionConfig;
use Revolution\Copilot\Types\Tool;
use Revolution\Copilot\Types\ToolResultObject;

use function Laravel\Prompts\{info, note, spin, warning};

Artisan::command('copilot:tools', function () {
    $facts = [
        'PHP' => 'A popular general-purpose scripting language that is especially suited to web development.',
        'Laravel' => 'A web application framework with expressive, elegant syntax.',
    ];

    $parameters = JsonSchema::object(
        properties: [
            'topic' => JsonSchema::string()
                ->description('Topic to look up (e.g., "PHP", "Laravel")')
                ->required(),
        ],
    )->toArray();

    $config = new SessionConfig(
        tools: [
            Tool::define(
                name: 'lookup_fact',
                description: 'Returns a fun fact about a given topic.',
                parameters: $parameters,
                handler: function (array $params, array $invocation) use ($facts): array {
                    $topic = $params['topic'] ?? '';

                    $fact = $facts[$topic] ?? null;

                    if (! $fact) {
                        return new ToolResultObject(
                            textResultForLlm: "No fact stored for {$topic}.",
                            resultType: 'failure',
                            sessionLog: "lookup_fact: missing topic {$topic}",
                            toolTelemetry: [],
                        );
                    }

                    return new ToolResultObject(
                        textResultForLlm: $fact,
                        resultType: 'success',
                        sessionLog: "lookup_fact: served {$topic}",
                        toolTelemetry: [],
                    );
                },
                overridesBuiltInTool: false,
                skipPermission: false, // bij true wordt de tool uitgevoerd zonder permissieprompt
                defer: 'auto', // Bepaalt of de tool lazy wordt geladen (lazy loading via tool-zoekopdrachten) in plaats van altijd vooraf te worden geladen. Bij `"auto"` wordt de tool lazy geladen en zichtbaar gemaakt via tool-zoekopdrachten. Bij `"never"` wordt de tool altijd vooraf geladen. Optioneel. De standaardwaarde is `"auto"`.
            ),
        ],
    );

    Copilot::start(function (CopilotSession $session) {
        info('Starting Copilot with tools: '.$session->id());

        $prompt = 'You can call the lookup_fact tool. Use lookup_fact to tell me something about Laravel.';

        warning($prompt);

        $response = spin(
            callback: fn () => $session->sendAndWait($prompt),
            message: 'Copilot thinking...',
        );

        note($response->content());
    }, config: $config);
});
```

## skipPermission

Als je `skipPermission: true` opgeeft, kan die tool worden uitgevoerd zonder permissieprompt.

```php theme={null}
Tool::define(
    name: 'read_only_lookup',
    description: 'Read-only data lookup.',
    parameters: $parameters,
    handler: fn ($params) => ['result' => 'data'],
    skipPermission: true,
),
```

## \$invocation

Het tweede argument `$invocation` van de toolhandler bevat de volgende velden.

```php theme={null}
[
    'sessionId'  => '...',
    'toolCallId' => '...',
    'toolName'   => 'lookup_fact',
    'arguments'  => [...], // toolargumenten (zelfde inhoud als $params)
    // Alleen aanwezig als OpenTelemetry is ingeschakeld
    'traceparent' => '...', // W3C Trace Context traceparent
    'tracestate'  => '...', // W3C Trace Context tracestate
]
```

## Protocoldetails

In Protocol v3 (de huidige standaard) worden toolaanroepen niet als JSON-RPC-requests verstuurd, maar als sessie-events (`external_tool.requested`) gebroadcast. De SDK verwerkt dit event intern en antwoordt met de RPC `session.tools.handlePendingToolCall`.

**Het gebruik van `SessionConfig` verandert niet.** Je geeft alleen definities door via `tools`; de SDK vangt de protocolverschillen op.

## MCP CallToolResult converteren

Gebruik `McpCallToolResult::convert()` om het toolresultaat van een MCP-server (`CallToolResult`) te converteren naar het `ToolResultObject` van de Copilot SDK.
Het resultaat van een MCP-tool is een array van `content`-blokken zoals text, image en resource, maar de Copilot SDK verwacht het `ToolResultObject`-formaat, dus conversie is nodig.

```php theme={null}
use Revolution\Copilot\Support\McpCallToolResult;

// MCP CallToolResult-formaat
$mcpResult = [
    'content' => [
        ['type' => 'text', 'text' => 'File contents here'],
        ['type' => 'image', 'data' => 'base64...', 'mimeType' => 'image/png'],
    ],
    'isError' => false,
];

// Converteren naar het ToolResultObject-formaat van de Copilot SDK
$toolResult = McpCallToolResult::convert($mcpResult);
// $toolResult->textResultForLlm => 'File contents here'
// $toolResult->resultType => 'success'
// $toolResult->binaryResultsForLlm => [['data' => 'base64...', 'mimeType' => 'image/png', 'type' => 'image']]
```

<Info>
  Zie de [GitHub-repository](https://github.com/invokable/laravel-copilot-sdk) voor de meest recente informatie.
</Info>


## Related topics

- [Laravel AI SDK](/nl/ai-sdk.md)
- [Laravel MCP](/nl/mcp.md)
- [Streaming events](/nl/packages/laravel-copilot-sdk/streaming-events.md)
- [Session hooks](/nl/packages/laravel-copilot-sdk/hooks.md)
- [Amazon Bedrock-driver voor de Laravel AI SDK](/nl/packages/laravel-amazon-bedrock.md)