ServerRpc-Übersicht
Geltungsbereich: ServerRpc (serverweite Operationen, die an den Client gebunden sind)
Eine Übersicht über RPC und die Liste aller RPC-Seiten finden Sie unter RPC.
Diese Seite fasst die ServerRpc-Methoden nach Kategorie zusammen. Anwendungsbeispiele finden Sie auf den Funktionsseiten, die im Index RPC aufgeführt sind.
Mit ping() und connect() prüfen bzw. starten Sie die Verbindung, und mit registerExtensionLaunchProvider() registrieren Sie einen Startprovider für Erweiterungen. Über models() erhalten Sie die Modellliste, die Token-Preiseinheiten und den integrierten Katalog, über tools() die Liste der verfügbaren Tools. account() behandelt Kontingent, Authentifizierungsstatus, die Liste der angemeldeten Benutzer sowie Anmeldung und Abmeldung.
providersConfig()->addModel() ist ein experimenteller RPC, der der gespeicherten Provider-Konfiguration des Servers ein Modell hinzufügt. Ist der Provider noch nicht gespeichert, legt die CLI ihn an, und providerAdded teilt Ihnen das mit. Die Änderung ist dauerhaft, wirkt sich aber nicht auf laufende Sessions aus.
Anwendungsbeispiele für providersConfig finden Sie unter Einstellungen und verwaltete Einstellungen.
Aufgezeichnete Trajektorien klassifizieren (experimental)
taskAnalytics()->classifyTrajectory() klassifiziert aufgezeichnete Copilot-Events oder ATIF-Daten, ohne eine Session zu erstellen. Archivierte Tools werden nicht ausgeführt, und weder dem Gesprächsverlauf noch der Klassifizierungstelemetrie wird etwas hinzugefügt. Übergeben Sie events in ihrer ursprünglichen Reihenfolge. Sie können außerdem classifiers, maxConcurrentRequests, judge und previousResult angeben. Mit validateOnly: true überspringt die Runtime die Inferenz und gibt nur das Ergebnis der lokalen Validierung zurück.
Anwendungsbeispiele finden Sie unter Sessions, Host und Umgebung.
MCP, Konnektoren und Secrets
mcp() bietet Auflisten, Hinzufügen, Aktualisieren und Entfernen von MCP-Konfigurationen, Aktivierung, Erkennung, Registry-Suche sowie Installationsplanung und -anwendung. Mit connectors() können Sie Konnektor-Funktionen, Konten und den Katalog prüfen. Serverseitige Konnektor-Operationen konzentrieren sich auf das Auflisten und Aktualisieren pro Konto. Das experimentelle secrets()->addFilterValues() registriert von Ihrem Host erzeugte dynamische Secrets im Redaction-Filter der CLI. Die CLI maskiert diese Werte anschließend in Session-Logs und Exporten.
Anwendungsbeispiele für secrets finden Sie unter MCP und Konnektoren.
Skills, Plugins, Agents, Instructions und Extensions
Über jede Gruppe können Sie Elemente erkennen, verfügbare Pfade abrufen, Einstellungen ändern und neu laden. commands() liefert die Liste der integrierten Befehle, hooks() die Hook-Erkennung vor dem Start einer Session. Skills und Plugins unterstützen Aktivieren, Deaktivieren und Installationsverwaltung, und Agents können außerdem Informationen zu integrierten Agents zurückgeben. Extensions erkennt, aktiviert und deaktiviert dauerhaft gespeicherte Erweiterungen. lsp() listet die serverweiten Einstellungen der Language Server auf.
Anwendungsbeispiele finden Sie unter Skills, Plugins, Agents, Instructions und Extensions.
Katalog und Installation
Mit catalog() suchen Sie Kandidaten, erhalten offizielle Produktempfehlungen, wählen Kandidaten aus und rufen Feeds ab. Über die APIs für Skills, Plugins und MCP prüfen Sie Installationspläne, wenden sie an, fragen ihren Status ab oder brechen sie ab. Planen und Anwenden sind getrennte Operationen. Konkrete Installationsbeispiele finden Sie in den jeweiligen Abschnitten weiter unten.
Sessions, Host und Laufzeitumgebung
sessions() behandelt das Durchsuchen dauerhaft gespeicherter Sessions, das Lesen von Events, das Prüfen von Größen, das Löschen und Bereinigen sowie das Forken. Außerdem können Sie Workspaces erstellen und laden und Remote Control verwenden. host() startet den Host, veröffentlicht Sessions, listet sie auf und hebt ihre Veröffentlichung auf, behandelt die Authentifizierung, ändert die Zulassungsrichtlinie für Sessions und gibt den Host frei. Die High-Level-API für den AHP-Host finden Sie unter AHP Host. runtime() behandelt den Lebenszyklus der Runtime.
sessions()->hasEvents() prüft, ob ein lokal gespeichertes Event-Log existiert, ohne die Session zu öffnen. Anwendungsbeispiele finden Sie unter Sessions, Host und Umgebung.
Cloud-Agent-Tasks (experimental)
cloudTasks() erstellt, löscht und ruft Tasks des Cloud-Coding-Agents ab, liest Session-Logs und Replays, ändert den Freigabestatus und ermittelt die Session, die zu einer Task-ID geöffnet werden soll. Jede Methode akzeptiert den passenden Params-Typ oder ein Array und gibt ein typisiertes DTO zurück. Ist ok im Erstellungsergebnis false, finden Sie in reason und message den Grund, aus dem der Dienst die Anfrage abgelehnt hat, und in statusCode, errorMessage und errorPayloadJson die Fehlerinformationen einer ausgeführten HTTP-Anfrage.
Anwendungsbeispiele finden Sie unter Sessions, Host und Umgebung.
Git, Umgebungen, Sandbox und Richtlinien
Über git() erhalten Sie Informationen zu Branches, Arbeitsverzeichnissen und Git-Remotes; mit gitHubRepository() und gitHubOwners() können Sie GitHub-Repositorys und -Besitzer erkunden. environments() behandelt Mission-Control-Umgebungen, sandbox() und sandboxProxyCa() die Sandbox-Unterstützung und die Proxy-CA, contentExclusion() die Prüfung von Ausschlussrichtlinien und managedSettings() sowie userSettings() die Einstellungen. Mit settings() entfernen Sie einzelne Schlüssel aus einer Einstellungsdatei und maskieren Werte für die Anzeige.
gitHubRepository()->getById() ermittelt Owner und Name aus einer GitHub-Repository-ID, und lookupBranchPullRequest() durchsucht die angegebenen Repositorys in Prioritätsreihenfolge nach einem Pull Request vom angegebenen Head-Owner und Branch. Beide übernehmen authInfo unverändert. Das Ergebnis von getById() enthält Owner und Name in repository oder null, wenn das Repository nicht gefunden wird. Der status der Pull-Request-Suche ist found, no-token, no-pr oder lookup-failed. Unbekannte Werte bleiben als Strings erhalten und lösen daher keine Exception aus. pullRequest ist ein assoziatives Array, wenn ein Pull Request gefunden wurde, andernfalls null.
Anwendungsbeispiele für gitHubRepository finden Sie unter Git und GitHub.
gitHubFetch() bietet authentifizierte GitHub-API-Anfragen und benannte Operationen, gitHubRelease() die Suche nach Releases, Snapshots, Asset-Downloads und Fortschrittsabfragen. Bei Fetch wählt sessionId die Authentifizierung einer Session aus. Ohne Angabe wird die Authentifizierung des Prozesses verwendet. Geben Sie authOwnerId an, um eine vom Host verwaltete Authentifizierungsbindung zu verwenden. Bei Release wählt authInfo von der Runtime verwaltete Anmeldedaten aus, und öffentliche Releases können anonym gesucht und heruntergeladen werden. Löschen Sie den heruntergeladenen path nach der Verwendung selbst.
allocateRequestId(), request() und executeOperation() von Fetch sowie abandonRequest(), getSnapshot() und downloadAsset() von Release können nicht aus Extensions aufgerufen werden. Das Laravel SDK stellt derzeit das cancel-RPC keiner der beiden Gruppen bereit, daher können Sie laufende Operationen nicht über das SDK abbrechen. abandonRequest() verwirft eine nicht verwendete Release-Request-ID und stoppt keine laufende Operation.
fetch() ist eine experimentelle API für allgemeine HTTP-Anfragen über den gemeinsamen Netzwerktransport. Erstellen Sie mit create() ein Handle, das der Verbindung gehört, und rufen Sie dann send() mit dem erforderlichen responseMode auf. Mit stream lesen Sie den Body mit read() in Teilen. Mit text erhalten Sie den gesamten Body als UTF-8-Text. Mit file schreibt die Runtime den Body nach destinationPath auf dem Runtime-Host. Verwerfen Sie ein nicht mehr benötigtes Handle mit cancel(). Sie können die API für Anfragen ohne Anmeldeinformationen und zum Streamen von Dateien verwenden.
Lokale Modelle, HTTP-Inferenz und Dateisystem
azureMl() liefert Informationen zum lokalen GPU-Speicher, den Modellkatalog, Auflösung und Download sowie Statusabfrage, Abbruch und Löschen. Außerdem kann es die Provider-Konfiguration für Azure-ML-Modelle mithilfe eines Family-Leases registrieren, entfernen und wiederherstellen. llmInference() ist eine experimentelle API, die HTTP-Anfragen der Modellschicht an die Client-Seite weiterleitet. sessionFs() registriert einen Callback-Provider für Dateisystem/SQLite für Sessions.
localModels() ist eine experimentelle, verbindungsbezogene API für die Verwaltung lokaler Modelle. Sie konfiguriert die Verwaltung, prüft und beobachtet den Zustand, aktualisiert den Katalog, bereitet Modelle vor, lädt sie herunter, aktualisiert, repariert und löscht sie, bricht Jobs ab und verwirft Hinweise. configure(), inspect() und watch() geben typisierte Ergebnisse zurück, die eine LocalModelsView und LocalModelsEvent[] enthalten. An watch() können Sie ein CancellationToken übergeben. Das Abbrechen des Tokens sendet eine JSON-RPC-Abbruchbenachrichtigung und hält die Verbindung offen. configure() sendet sessionId nicht, wenn der Wert null ist.
Netzwerk-Callbacks (experimental)
network()->setProvider() teilt der Runtime mit, welche Callbacks für Proxy-Auflösung und Kerberos-Authentifizierung am Client registriert sind. Die Option network des Client registriert sie automatisch, daher müssen Sie diesen RPC normalerweise nicht direkt aufrufen. Die Callback-Felder von NetworkSetProviderRequest geben an, dass der entsprechende Handler registriert ist. Der RPC gibt keinen Wert zurück. Die Runtime muss den RPC network.setProvider unterstützen. Andernfalls löst der Client beim Start eine Exception aus, die Sie auffordert, die Runtime zu aktualisieren.
Anwendungsbeispiele finden Sie unter HTTP-Inferenz und Dateisystem.
Interne und experimentelle RPCs
Die folgenden RPCs sind im offiziellen SDK als intern markiert, Laravel stellt sie jedoch als @experimental bereit. Sie können sich künftig ändern oder entfernt werden, und die Aufruferbeschränkungen der Runtime gelten weiterhin. Damit können Sie Einträge der Agent-Registry anlegen, auflisten und entfernen, eine Authentifizierungs-URL im Browser öffnen, abgelaufene große Tool-Ausgaben bereinigen und Warnungen zu Sandbox-Pfadfreigaben abrufen. Listenergebnisse enthalten keine Verbindungsanmeldedaten.
Anwendungsbeispiele finden Sie unter Modelle, Tools und Konten, Sessions, Host und Umgebung und Skills, Plugins, Agents, Instructions und Extensions.Zuletzt geändert am 19. November 2026