Erste Schritte - GitHub Copilot SDK für Laravel

Ihre erste Copilot-fähige Laravel-Anwendung erstellen

In dieser Anleitung erstellen Sie mit dem Laravel Copilot SDK einen Kommandozeilen-Assistenten. Wir beginnen mit dem Senden eines einzelnen Prompts und gehen dann zu Sessions, Events und Tools über.

Voraussetzungen

Bevor Sie beginnen, stellen Sie Folgendes sicher.

Die GitHub Copilot CLI ist installiert und authentifiziert
PHP 8.4+
Laravel 13.x

Prüfen Sie die Verfügbarkeit der CLI.

copilot --version

SDK installieren

Installieren Sie das Paket mit Composer.

composer require revolution/laravel-copilot-sdk

Veröffentlichen Sie bei Bedarf die Konfiguration.

php artisan vendor:publish --tag=copilot-config

Setzen Sie ggf. den CLI-Pfad in .env.

COPILOT_CLI_PATH=copilot

Erste Nachricht senden

Erstellen Sie einen Command und rufen Sie Copilot::run() auf.

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Revolution\Copilot\Facades\Copilot;

class CopilotDemo extends Command
{
    protected $signature = 'copilot:demo';
    protected $description = 'Demo Copilot SDK';

    public function handle()
    {
        $response = Copilot::run(prompt: 'What is 2 + 2?');

        $this->info($response->content());
    }
}

Führen Sie den Command aus.

php artisan copilot:demo

Kontext über Sessions halten

Wenn Sie mehrere Prompts in einer Konversation nutzen möchten, verwenden Sie Copilot::start().

use Revolution\Copilot\Contracts\CopilotSession;
use Revolution\Copilot\Facades\Copilot;

Copilot::start(function (CopilotSession $session) {
    $response = $session->sendAndWait(prompt: 'What is 2 + 2?');
    $this->info('Answer: '.$response->content());

    $response = $session->sendAndWait(prompt: 'Now multiply that by 3');
    $this->info('Answer: '.$response->content());
});

Session-Events verarbeiten

Registrieren Sie mit on() einen Event-Handler und behandeln Sie Assistenten-Nachrichten oder Fehler.

use Revolution\Copilot\Contracts\CopilotSession;
use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\SessionEvent;

Copilot::start(function (CopilotSession $session) {
    $session->on(function (SessionEvent $event): void {
        if ($event->isAssistantMessage()) {
            $this->info($event->content());
        } elseif ($event->failed()) {
            $this->error($event->errorMessage() ?? 'Unknown error');
        }
    });

    $session->sendAndWait(prompt: 'Tell me a short Laravel joke');
});

Benutzerdefinierte Tools hinzufügen

Definieren Sie Tools mit einem JSON-Schema und einem Handler.

use Illuminate\JsonSchema\JsonSchema;
use Revolution\Copilot\Contracts\CopilotSession;
use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\SessionConfig;
use Revolution\Copilot\Types\Tool;

$parameters = JsonSchema::object([
    'topic' => JsonSchema::string()
        ->description('Topic to look up')
        ->required(),
])->toArray();

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

                return [
                    'textResultForLlm' => "Fact for {$topic}",
                    'resultType' => 'success',
                    'sessionLog' => "lookup_fact: {$topic}",
                    'toolTelemetry' => [],
                ];
            },
        ),
    ],
);

Copilot::start(function (CopilotSession $session) {
    $response = $session->sendAndWait(
        prompt: 'Use lookup_fact to tell me something about Laravel.'
    );

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

Interaktiven Assistenten bauen

Wenn Sie Sessions, Events und Tools kombinieren, können Sie einen interaktiven Artisan-Command erstellen.

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\JsonSchema\JsonSchema;
use Revolution\Copilot\Contracts\CopilotSession;
use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\SessionConfig;
use Revolution\Copilot\Types\SessionEvent;
use Revolution\Copilot\Types\Tool;
use Revolution\Copilot\Types\ToolResultObject;

use function Laravel\Prompts\error;
use function Laravel\Prompts\info;
use function Laravel\Prompts\note;
use function Laravel\Prompts\spin;
use function Laravel\Prompts\text;

class CopilotAssistant extends Command
{
    protected $signature = 'copilot:assistant';
    protected $description = 'Interactive Copilot assistant';

    public function handle()
    {
        $facts = [
            'PHP' => 'A popular general-purpose scripting language for web development.',
            'Laravel' => 'A web application framework with expressive, elegant syntax.',
            'Composer' => 'Dependency manager for PHP.',
        ];

        $parameters = JsonSchema::object([
            'topic' => JsonSchema::string()
                ->description('Topic to look up')
                ->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) use ($facts) {
                        $topic = $params['topic'] ?? '';
                        $fact = $facts[$topic] ?? "No fact available for {$topic}.";

                        return new ToolResultObject(
                            textResultForLlm: $fact,
                            resultType: 'success',
                            sessionLog: "lookup_fact: {$topic}",
                            toolTelemetry: [],
                        );
                    },
                ),
            ],
        );

        Copilot::start(function (CopilotSession $session) {
            info('Copilot assistant');
            info("Session: {$session->id()}");
            info("Try: Use lookup_fact to tell me about Laravel");

            $session->on(function (SessionEvent $event): void {
                if ($event->isAssistantMessage()) {
                    note($event->content());
                } elseif ($event->failed()) {
                    error($event->errorMessage() ?? 'Unknown error');
                }
            });

            while (true) {
                $prompt = text(
                    label: 'You',
                    placeholder: 'Ask me anything...',
                    required: true,
                    hint: 'Ctrl+C to exit',
                );

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

                echo "\n";
            }
        }, config: $config);
    }
}

Führen Sie den Command aus.

php artisan copilot:assistant

So funktionieren Tools

Beim Definieren eines Tools geben Sie folgende drei Aspekte an.

Was das Tool tut.
Welche Parameter es entgegennimmt.
Welcher Handler-Code ausgeführt werden soll.

Copilot entscheidet anhand der Nutzereingabe über den Tool-Aufruf, und das SDK führt den Handler aus und liefert das Ergebnis zurück.

Weitere Funktionen zum Ausprobieren

Wasserzeichen für die Bildgenerierung festlegen

Die Bildgenerierung muss pro Session aktiviert werden. Mit der experimentellen Option watermark können Sie anfordern, dass generierte oder bearbeitete Bilder mit dem Label „Made with AI“ versehen werden.

use Revolution\Copilot\Types\ImageGenerationConfig;
use Revolution\Copilot\Types\SessionConfig;

$config = new SessionConfig(
    imageGeneration: new ImageGenerationConfig(
        enabled: true,
        watermark: true,
    ),
);

watermark überschreibt für diese Session die Einstellung des Benutzers. Wird die Option weggelassen, gilt die Benutzereinstellung (Standard: false). Geben Sie sie nach einem Cold Resume erneut an. Diese Option aktiviert weder die Bildgenerierung noch erzwingt sie Unternehmensrichtlinien.

MCP-Server anbinden

use Revolution\Copilot\Types\SessionConfig;

$config = new SessionConfig(
    mcpServers: [
        'github' => [
            'type' => 'http',
            'url' => 'https://api.githubcopilot.com/mcp/',
        ],
    ],
);

Benutzerdefinierten Agenten erstellen

use Revolution\Copilot\Types\SessionConfig;

$config = new SessionConfig(
    customAgents: [
        [
            'name' => 'pr-reviewer',
            'displayName' => 'PR Reviewer',
            'description' => 'Reviews pull requests for best practices',
            'prompt' => 'You are an expert code reviewer. Focus on security, performance, and maintainability.',
        ],
    ],
);

System-Nachricht anpassen

use Revolution\Copilot\Types\SessionConfig;
use Revolution\Copilot\Types\SystemMessageConfig;

$config = new SessionConfig(
    systemMessage: new SystemMessageConfig(
        content: 'You are a helpful assistant for our engineering team. Always be concise.',
    ),
);

Mit einem externen CLI-Server verbinden

Starten Sie die Copilot CLI im Server-Modus.

copilot --headless --port 4321

Konfigurieren Sie anschließend die Ziel-URL in .env.

COPILOT_URL=tcp://127.0.0.1:4321

Wenn COPILOT_URL gesetzt ist, startet das SDK keinen neuen CLI-Prozess, sondern verbindet sich mit dem bestehenden Server.

Telemetrie und Observability

Konfigurieren Sie die Telemetrie in config/copilot.php.

'telemetry' => [
    'otlpEndpoint' => 'http://localhost:4318',
],

Oder setzen Sie sie direkt.

use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\TelemetryConfig;

Copilot::useStdio([
    'telemetry' => new TelemetryConfig(
        otlpEndpoint: 'http://localhost:4318',
    ),
]);

Weiterführendes

Nächste Schritte

Authentifizierung

Wählen Sie die passende Authentifizierungsmethode für lokale Umgebungen und CI aus.

SessionConfig

Konfigurieren Sie Modelle, Hooks, MCP-Server und das Laufzeitverhalten.

SessionEvent

Verstehen Sie Laravel-spezifische Event-Helper und die Lebenszyklusverarbeitung.

Berechtigungsanfragen

Überprüfen Sie den Berechtigungsablauf zur Ausführung von Tools mit expliziter Zustimmung.

Tools

Rufen Sie aus Copilot Ihren Anwendungscode auf.

MCP

Binden Sie vorgefertigte Tools eines MCP-Servers an.

Damit haben Sie die zentralen Abläufe des Laravel Copilot SDK vom Einzel-Prompt bis zur Tool-integrierten Session einmal komplett durchlaufen.

Referenz: Laravel Copilot SDK README, Laravel Copilot SDK Getting Started, GitHub Copilot SDK

GitHub Copilot

SDK

AI SDK

VOICEVOX

Starter Kits

Feeds und RSS

Middleware

Erste Schritte - GitHub Copilot SDK für Laravel

Ihre erste Copilot-fähige Laravel-Anwendung erstellen

Voraussetzungen

SDK installieren

Erste Nachricht senden

Kontext über Sessions halten

Session-Events verarbeiten

Benutzerdefinierte Tools hinzufügen

Interaktiven Assistenten bauen

So funktionieren Tools

Weitere Funktionen zum Ausprobieren

Wasserzeichen für die Bildgenerierung festlegen

MCP-Server anbinden

Benutzerdefinierten Agenten erstellen

System-Nachricht anpassen

Mit einem externen CLI-Server verbinden

Telemetrie und Observability

Weiterführendes

Nächste Schritte

Authentifizierung

SessionConfig

SessionEvent

Berechtigungsanfragen

Tools

MCP

​Ihre erste Copilot-fähige Laravel-Anwendung erstellen

​Voraussetzungen

​SDK installieren

​Erste Nachricht senden

​Kontext über Sessions halten

​Session-Events verarbeiten

​Benutzerdefinierte Tools hinzufügen

​Interaktiven Assistenten bauen

​So funktionieren Tools

​Weitere Funktionen zum Ausprobieren

​Wasserzeichen für die Bildgenerierung festlegen

​MCP-Server anbinden

​Benutzerdefinierten Agenten erstellen

​System-Nachricht anpassen

​Mit einem externen CLI-Server verbinden

​Telemetrie und Observability

​Weiterführendes

​Nächste Schritte

Authentifizierung

SessionConfig

SessionEvent

Berechtigungsanfragen

Tools

MCP

Ihre erste Copilot-fähige Laravel-Anwendung erstellen

Voraussetzungen

SDK installieren

Erste Nachricht senden

Kontext über Sessions halten

Session-Events verarbeiten

Benutzerdefinierte Tools hinzufügen

Interaktiven Assistenten bauen

So funktionieren Tools

Weitere Funktionen zum Ausprobieren

Wasserzeichen für die Bildgenerierung festlegen

MCP-Server anbinden

Benutzerdefinierten Agenten erstellen

System-Nachricht anpassen

Mit einem externen CLI-Server verbinden

Telemetrie und Observability

Weiterführendes

Nächste Schritte