Permission requests

Standaardgedrag (`deny-all`)

Als permission_approve in config/copilot.php op "deny-all" (de standaard) staat, worden permission requests bij Copilot::run() en Copilot::start() automatisch geweigerd. Voor toepassingen die vooral tekst genereren zijn permissies vaak niet nodig, dus dit is een veilige standaard.

// config/copilot.php
'permission_approve' => env('COPILOT_PERMISSION_APPROVE', 'deny-all'),

Mogelijke waarden

Waarde	Gedrag
`"deny-all"`	Alles automatisch weigeren (standaard)
`"approve-safety"`	Alleen `shell` en `write` weigeren, de rest automatisch toestaan
`"approve-all"`	Alles automatisch toestaan
`false`	Geen handler. `onPermissionRequest` is verplicht (zoals in de officiële SDK)

// .env
COPILOT_PERMISSION_APPROVE="approve-safety"

Als je prompts van gebruikers accepteert, zijn "approve-safety" en "approve-all" gevaarlijk. Gebruik dan altijd false of "deny-all". Zelfs met read-only permissies kan de code van je Laravel-project worden gelezen.

`PermissionHandler::approveAll()`

PermissionHandler::approveAll() staat alle requests automatisch toe.

use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Support\PermissionHandler;
use Revolution\Copilot\Types\SessionConfig;

$config = new SessionConfig(
    onPermissionRequest: PermissionHandler::approveAll(),
);

$response = Copilot::run(prompt: 'Hello', config: $config);

`PermissionHandler::approveSafety()`

PermissionHandler::approveSafety() weigert alleen permissies met een hoog risico (shell, write) en staat de rest automatisch toe.

use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Support\PermissionHandler;
use Revolution\Copilot\Types\SessionConfig;

$config = new SessionConfig(
    onPermissionRequest: PermissionHandler::approveSafety(),
);

$response = Copilot::run(prompt: 'Hello', config: $config);

Ook dit is niet gegarandeerd volledig veilig. Wil je strikte controle, implementeer dan een custom handler en beoordeel op basis van $request['kind'].

`PermissionHandler::denyAll()`

PermissionHandler::denyAll() weigert alles.

use Revolution\Copilot\Support\PermissionHandler;
use Revolution\Copilot\Types\SessionConfig;

$config = new SessionConfig(
    onPermissionRequest: PermissionHandler::denyAll(),
);

De Client direct gebruiken

Als je CopilotClient direct gebruikt, is het opgeven van onPermissionRequest verplicht, net als in de officiële SDK.

use Revolution\Copilot\Client;
use Revolution\Copilot\Support\PermissionHandler;

$client = new Client([
    'cli_path' => 'copilot',
    'cli_args' => [],
    'cwd' => base_path(),
    'log_level' => 'info',
    'env' => null,
]);
$client->start();

// onPermissionRequest is verplicht
$session = $client->createSession([
    'onPermissionRequest' => PermissionHandler::approveSafety(),
]);

// Weglaten geeft een InvalidArgumentException
// $session = $client->createSession([]); // Error!

Custom handler

Geef een closure door om toestaan of weigeren per requesttype te bepalen. $request en $invocation zijn arrays zoals hieronder.

use Illuminate\Support\Facades\Artisan;
use Revolution\Copilot\Contracts\CopilotSession;
use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Support\PermissionRequestResultKind;
use Revolution\Copilot\Types\SessionConfig;

use function Laravel\Prompts\{confirm, note, spin, text};

Artisan::command('copilot:chat', function () {
    $config = new SessionConfig(
        onPermissionRequest: function (array $request, array $invocation) {
            $confirm = confirm(
                label: 'Do you accept the requested permissions?',
            );
            if ($confirm) {
                return PermissionRequestResultKind::approveOnce();
            } else {
                return PermissionRequestResultKind::reject();
            }
        },
    );

    Copilot::start(function (CopilotSession $session) use ($config) {
        while (true) {
            $prompt = text(
                label: 'Enter your prompt',
                placeholder: 'Ask me anything...',
                required: true,
                hint: 'Ctrl+C to exit',
            );

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

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

`$request`

De velden buiten kind en toolCallId verschillen afhankelijk van kind.

kind: "shell" | "write" | "mcp" | "read" | "url" | "custom-tool" | "memory" | "hook"

[
  "kind" => "shell",
  "toolCallId" => "toolu_...",
  "fullCommandText" => "...",
  "intention" => "Run copilot:ping to test permission request",
  "commands" => [
    [
      "identifier" => "bash",
      "readOnly" => false,
    ]
  ]
  "possiblePaths" => [],
  "possibleUrls" => [],
  "hasWriteFileRedirection" => false,
  "canOfferSessionApproval" => false,
]

Als $request['managedApprovalRequired'] true is, kan dit verzoek door de Managed Settings van de organisatie niet automatisch worden goedgekeurd. PermissionHandler::approveAll() retourneert in dat geval no-result en laat de afhandeling over aan de standaardflow van de Copilot CLI.

`$invocation`

[
  "sessionId" => "...",
  // Alleen optioneel aanwezig in nieuwere CLI-runtimes
  "promptRequest" => [
    "kind" => "read",
    "managedApprovalRequired" => false,
  ],
]

Promptcontext (`promptRequest`)

In nieuwere CLI-runtimes kan $invocation['promptRequest'] de context bevatten van de prompt die aan de gebruiker wordt getoond. In een eigen handler kun je aan de hand van deze waarde bepalen of een menselijke reactie nodig is. PermissionHandler::approveAll() geeft voorrang aan promptRequest['managedApprovalRequired'] als aan alle volgende voorwaarden is voldaan:

promptRequest['kind'] is een van commands / read / write / url / workflow
promptRequest['managedApprovalRequired'] is een boolean

Zo kan het verzoek automatisch worden goedgekeurd als de prompt geen menselijke reactie vereist, ook als $request['managedApprovalRequired'] als marker uit het beleid blijft staan. De ruwe marker in $request blijft behouden. Bij oudere CLI’s zonder promptRequest, niet-ondersteunde types of als er geen geldige boolean-waarde is, wordt zoals voorheen op basis van $request['managedApprovalRequired'] beslist.

use Revolution\Copilot\Support\PermissionRequestResultKind;

onPermissionRequest: function (array $request, array $invocation) {
    $prompt = $invocation['promptRequest'] ?? null;

    if (is_array($prompt) && ($prompt['managedApprovalRequired'] ?? null) === true) {
        // Er is een menselijke reactie nodig, dus laat dit over aan de standaardflow van de CLI
        return PermissionRequestResultKind::noResult();
    }

    return PermissionRequestResultKind::approveOnce();
},

Response

Het resultaat van de permissiebeslissing retourneer je als array. Met de klasse PermissionRequestResultKind wordt dit beter leesbaar.

return PermissionRequestResultKind::approveOnce();
return PermissionRequestResultKind::reject();

Protocoldetails

In Protocol v3 (de huidige standaard) worden permission requests niet als JSON-RPC-requests maar als session-events (permission.requested) afgeleverd. De SDK verwerkt dit intern en antwoordt via de RPC session.permissions.handlePendingPermissionRequest. Het gebruik van SessionConfig verandert niet. Als je een handler doorgeeft aan onPermissionRequest, vangt de SDK de protocolverschillen op.

PermissionRequestResultKind

Je kunt ook direct de vorm ['kind' => 'approve-once'] retourneren, maar met PermissionRequestResultKind wordt het duidelijker.

use Revolution\Copilot\Support\PermissionRequestResultKind;

$confirm = confirm(
    label: 'Do you accept the requested permissions?',
);

if ($confirm) {
    return PermissionRequestResultKind::approveOnce();
} else {
    return PermissionRequestResultKind::reject();
}

Beschikbare methodes

Methode	Waarde	Beschrijving
`approveOnce()`	`approve-once`	Alleen deze request toestaan
`approveForSession()`	`approve-for-session`	Alle soortgelijke requests tijdens deze session toestaan
`approveForLocation()`	`approve-for-location`	Alle soortgelijke requests vanaf deze locatie (bestandspad e.d.) toestaan
`reject()`	`reject`	De request weigeren
`userNotAvailable()`	`user-not-available`	De gebruiker kan niet reageren (bijv. in een niet-interactieve omgeving)
`noResult()`	`no-result`	De handler kan geen resultaat geven (de RPC-aanroep wordt overgeslagen)

Wil je Laravel\Prompts\select gebruiken, dan kun je de opties ophalen met PermissionRequestResultKind::select().

use Revolution\Copilot\Support\PermissionRequestResultKind;
use function Laravel\Prompts\select;

$select = select(
    label: 'Do you accept the requested permissions?',
    options: PermissionRequestResultKind::select(),
);

return ['kind' => $select];

no-result

Als de handler geen resultaat kan geven (bijvoorbeeld in een niet-interactieve omgeving), kun je no-result retourneren. Bij no-result wordt de RPC-aanroep overgeslagen en geldt de standaardweigering aan de kant van de Copilot CLI.

return PermissionRequestResultKind::noResult();
// of ['kind' => 'no-result']

Raadpleeg de GitHub-repository voor de meest actuele informatie.

GitHub Copilot

SDK

AI SDK

VOICEVOX

Starter kits

Feeds en RSS

Middleware

Permission requests