Zum Inhalt springen
KeuralDocs
Entwickler

Plugin- und MCP-Server-Integration

So verbinden Sie einen eigenen MCP-Server mit Keural und erstellen ein Plugin-Paket für die Desktop-App.

Die Plugins von Keural sind MCP-Server (Model Context Protocol). Diese Seite beschreibt die Spezifikation für Entwickler, die einen eigenen MCP-Server mit Keural verbinden oder ein Plugin-Paket für die Desktop-App erstellen.

Transportarten

PlattformTransportVerwendung
Web und MobilHTTP (Streamable HTTP) · SSEÜber das Internet erreichbare entfernte MCP-Server
Desktop-AppSTDIO · HTTPAuf diesem Computer laufende Server, HTTP-Server im Firmennetz
  • In Web-Unterhaltungen werden nur entfernte HTTP- oder SSE-Server verwendet. STDIO-Server laufen in der Desktop-App.
  • Endet die Serveradresse auf /mcp, handelt es sich meist um einen Streamable-HTTP-Server. Wählen Sie dann als Transport HTTP.
  • HTTP in der Desktop-App ist für Adressen im Firmennetz gedacht. Öffentliche Internetadressen registrieren Sie im Web mit HTTP.

Eingabewerte für eigene Server

Die Eingabefelder unter Einstellungen → Plugins → + Eigenen MCP hinzufügen sind:

FeldInhalt
NamePflichtfeld
BeschreibungOptional
TransportSiehe Tabelle oben
KategorieEinordnung in der Liste
Server-URLPflicht bei HTTP oder SSE. Beispiel: https://example.com/mcp
StartbefehlPflicht bei STDIO. Beispiel: npx
ArgumenteSTDIO-Argumente (JSON-Array). Beispiel: ["-y", "@scope/server"]
Dieses Plugin für die Websuche verwendenIst die Option aktiv, nutzt die Websuche dieses Plugin statt der Standardsuche.
AuthentifizierungKeine · API-Schlüssel
Headername · Wert des API-SchlüsselsBei API-Schlüssel. Beispiel: Headername Authorization, Wert Bearer …

Wählen Sie einen API-Schlüssel, sendet Keural bei jeder Anfrage den Header <Headername>: <Wert> mit.

OAuth-Authentifizierung

Plugins, die ein Organisationsadministrator mit OAuth registriert hat, verlangen, dass der Benutzer auf Verbinden klickt und sich anmeldet.

ElementWert
Serverermittlung/.well-known/oauth-protected-resource (mit Pfad, danach ohne Pfad), dann /.well-known/oauth-authorization-server
Client-RegistrierungDynamische Client-Registrierung (DCR)
Redirect-URIhttps://api.keural.ai/api/user-connectors/oauth/callback
Anfrage-HeaderAuthorization: Bearer <Zugriffstoken>

Das Anmeldefenster öffnet sich als Pop-up. Nach Abschluss der Anmeldung wird die Plugin-Liste aktualisiert.

Werkzeugberechtigungen

Legen Sie für jedes Werkzeug des Plugins fest, wie es ausgeführt wird.

BerechtigungVerhalten
Immer erlaubenWird ohne Rückfrage ausgeführt.
Freigabe erforderlichZeigt vor der Ausführung eine Freigabekarte an. Auf der Karte werden auch die Argumente des Werkzeugs angezeigt.
BlockiertDer Agent verwendet dieses Werkzeug nicht.

Plugin-Paket für den Desktop

Die Desktop-App installiert Plugins über Plugin-ZIP-Datei… oder Plugin-Ordner…. Das Paket muss das Manifest plugin.json enthalten.

{
  "id": "my-plugin",
  "name": "My Plugin",
  "version": "1.0.0",
  "description": "Abfrage interner Systeme",
  "mcpServers": {
    "my-server": {
      "command": "node",
      "args": ["server.js"],
      "env": { "API_BASE": "https://intranet.example.com" }
    }
  }
}
FeldPflichtInhalt
idJaKleine lateinische Buchstaben, Ziffern und Bindestriche
nameNeinAnzeigename. Fehlt er, wird id verwendet.
versionNeinStandard 1.0.0
descriptionNeinBeschreibung
minAppVersionNeinMindestversion der App
mcpServersNeinDefinitionen der MCP-Server. Je Server command, args und env.
requestsNeinAngeforderte Berechtigungen (capabilities, commands, connectors, secrets, permissions). Array aus Zeichenketten

Ein im Web registriertes STDIO-Plugin installieren Sie in der Desktop-App über Auf diesem PC installieren. Danach geben Sie Authentifizierungstoken und Umgebungsvariablen manuell ein.

Auf dieser Seite