OpenAPI für KI-Agenten

Ein OpenAPI-Dokument beschreibt eine HTTP-API in maschinenlesbarer Form: ihre Endpunkte, die Parameter, die jeder annimmt, den Aufbau jeder Antwort und die Art der Authentifizierung. Ein Agent kann daraus lernen, wie er eine API aufruft, die er noch nie gesehen hat.

Verzeichnete Dienste mit OpenAPI-Beschreibung: 23
Websites mit einer echten ai-plugin.json: 75 von 1.504

Von der API-Beschreibung zu Tools

Agenten-Frameworks und mehrere Assistenzplattformen können die Operationen eines OpenAPI-Dokuments in Tools umwandeln: Die Kennung der Operation wird zum Namen des Tools, ihre Zusammenfassung und Beschreibung sagen dem Modell, wann es das Tool verwenden soll, und ihr Parameterschema wird zur Eingabe des Tools. Das Modell füllt dann die Parameter aus, und die Plattform stellt die HTTP-Anfrage.

Das Plugin-Manifest

Das Manifest /.well-known/ai-plugin.json wurde 2023 mit dem Plugin-System von ChatGPT eingeführt: Es nannte den Dienst, beschrieb ihn für das Modell und verwies auf ein OpenAPI-Dokument. Dieses Plugin-System wurde inzwischen abgelöst, doch manche Websites stellen die Datei weiterhin bereit, und sie gibt nach wie vor an, wo ihre API-Beschreibung liegt.

OpenAPI und MCP

OpenAPI beschreibt jede beliebige HTTP-API, gleich wer sie aufruft. MCP ist ein Protokoll für Assistenten: Der Server listet seine Tools auf, wenn sich der Client verbindet, und der Client ruft sie auf. Viele MCP-Server sind eine dünne Schicht über einer API, die auch eine OpenAPI-Beschreibung hat, und es gibt Tools, die das eine aus dem anderen erzeugen.

Was eine Beschreibung agentenfreundlich macht

Klare Kennungen und Beschreibungen der Operationen, geschrieben für jemanden, der die API nie gesehen hat; Beispiele; Aufzählungen (Enums) für zulässige Werte; dokumentierte Fehler; ein deklariertes Authentifizierungsschema, nicht nur im Fließtext erklärt; und kleine Operationen, die jeweils genau eine Sache tun. Eine veröffentlichte, stabile URL für das Dokument ermöglicht es Agenten und Verzeichnissen, es zu finden.

Dienste mit OpenAPI-Beschreibung · Dienste mit öffentlicher API · Verzeichnis durchsuchen →

Mehr: Was ist ein MCP-Server? · Was ist llms.txt? · Wie KI-Assistenten Reisen finden und buchen · Wie Einträge geprüft werden · MCP-Transporte: stdio, Streamable HTTP und SSE · Remote oder lokal: welcher MCP-Server sich eignet · So fügen Sie einem KI-Assistenten einen MCP-Server hinzu · Was ist die offizielle MCP Registry? · Was in eine llms.txt-Datei gehört · Wie KI-Assistenten Reiseverfügbarkeit finden · Bevor Sie einen MCP-Server verbinden: eine Checkliste