Fastly API – OpenAPI-Spezifikation
Dieses Repository enthält eine umfassende, inoffizielle OpenAPI 3.0-Spezifikation für die Fastly API , die durch Reverse Engineering der öffentlich verfügbaren API-Dokumentation erstellt wurde. Im Vergleich zur offiziellen Webdokumentation bietet es eine deutlich erweiterte Dokumentation mit detaillierten Beschreibungen, Beispielen und strukturierten Schemata, die sowohl für menschliche Entwickler als auch für KI-Agenten optimiert sind.
Schlüsselkomponenten
Dieses Projekt bietet drei wichtige Ressourcen für die Arbeit mit der Fastly-API:
- Vollständige OpenAPI-Spezifikation (
fastly-openapi.yaml ) – Ein umfassendes OpenAPI 3.0-Schema für alle Fastly API-Endpunkte - KI-optimierte Spezifikation (
fastly-openapi-mcp.yaml ) – Eine optimierte Teilmenge, die für die Nutzung durch KI-Agenten optimiert ist - Model Context Protocol Server (
fastly-mcp-server/ ) – Eine MCP-Serverimplementierung, die KI-Modellen die Interaktion mit Fastly über ein standardisiertes Protokoll ermöglicht
MCP-Server für KI-Integration
Das Repository enthält einen vollständigen Model Context Protocol (MCP) -Server für Fastly, verfügbar auf NPM:
# Install globally
npm install -g fastly-mcp-server
# Or run directly
npx fastly-mcp-server run
Dieser MCP-Server ermöglicht KI-Assistenten und -Agenten:
- Interagieren Sie mit Fastly-Diensten über natürliche Sprache
- Verwalten Sie CDN-Konfigurationen, Caching-Einstellungen und Sicherheitsfunktionen
- Führen Sie eine Inhaltsbereinigung, eine Statistikerfassung und eine Dienstbereitstellung durch
- Greifen Sie über eine standardisierte Schnittstelle auf alle wichtigen Fastly-Funktionen zu
Ausführliche Anwendungsbeispiele und Konfigurationsoptionen finden Sie im Verzeichnis fastly-mcp-server .
Haftungsausschluss
Dies ist eine inoffizielle Spezifikation und wird von Fastly weder empfohlen noch unterstützt oder garantiert. Sie kann unvollständig sein oder Ungenauigkeiten enthalten. Die Spezifikation wird „wie besehen“ und ohne jegliche Gewährleistung bereitgestellt.
Merkmale
- Umfassendes OpenAPI 3.0-Schema für die CDN-API von Fastly
- Verbesserte Dokumentation , die die offizielle Webdokumentation in Klarheit und Detailliertheit übertrifft
- KI-optimierte Schemata, die speziell für die Nutzung durch große Sprachmodelle und KI-Agenten entwickelt wurden
- Detaillierte Endpunktbeschreibungen mit Betriebskontext und Beispielen
- Vollständige Schemadefinitionen für alle Anfrage- und Antwortobjekte
- Unterstützung für alle wichtigen Fastly-API-Funktionen:
- Dienstverwaltung
- Domänenkonfiguration
- Backend-Verwaltung
- VCL-Manipulation
- Cache-Steuerelemente
- Bereinigungsvorgänge
- Edge-Wörterbücher
- WAF-Sicherheit
- Protokollierungsendpunkte
- Statistiken und Metriken
- Compute@Edge
Technische Daten
Dieses Repository enthält zwei OpenAPI-Spezifikationen:
fastly-openapi.yaml
Die vollständige Spezifikation der Fastly API mit allen Endpunkten, Parametern und Schemata. Diese Spezifikation:
- Bietet eine ausführlichere und strukturiertere Dokumentation als die offiziellen Webdokumente
- Enthält detaillierte Beschreibungen, die den Nutzungskontext erklären, nicht nur die Parameter
- Enthält konsistente Beispiele für alle Operationen und Datenschemata
- Ist nützlich für eine umfassende API-Dokumentation und Client-Generierung
fastly-openapi-mcp.yaml
Eine optimierte Teilmenge der API, die speziell für die Interaktion mit KI-Agenten optimiert ist. Diese Spezifikation:
- Enthält nur die am häufigsten verwendeten Endpunkte für gängige Fastly-Aufgaben
- Konzentriert sich auf die Kernaufgaben, die für das tägliche Management erforderlich sind
- Enthält detaillierte Beschreibungen und Beispiele, die für das KI-Verständnis optimiert sind
- Priorisiert Endpunkte, die in Konversationsschnittstellen am nützlichsten sind
- Folgt einer aufgabenbasierten Organisation, die den üblichen Benutzer-Workflows entspricht
- Reduziert den Token-Verbrauch für KI-Kontexte und maximiert gleichzeitig den Nutzen
Die MCP-Version eignet sich ideal für die Integration mit KI-Assistenten und Tools, die über natürliche Sprachschnittstellen mit Fastly interagieren müssen.
Verwendung
Dokumentation anzeigen
Sie können aus diesen Spezifikationen interaktive Dokumentationen erstellen, indem Sie Tools wie die folgenden verwenden:
Beispiele:
# For the complete API
npx @redocly/cli preview-docs fastly-openapi.yaml
# For the AI-optimized subset
npx @redocly/cli preview-docs fastly-openapi-mcp.yaml
Validierung
So validieren Sie die Spezifikationen:
# For the complete API
npx @stoplight/spectral-cli lint fastly-openapi.yaml
# Or use swagger-cli
npx swagger-cli validate fastly-openapi.yaml
# For the AI-optimized subset
npx @stoplight/spectral-cli lint fastly-openapi-mcp.yaml
Codegenerierung
Diese Spezifikationen können mit OpenAPI-Codegeneratoren verwendet werden, um Clientbibliotheken in verschiedenen Programmiersprachen zu erstellen:
# For the complete API
npx @openapitools/openapi-generator-cli generate -i fastly-openapi.yaml -g javascript -o ./client
# For the AI-optimized subset
npx @openapitools/openapi-generator-cli generate -i fastly-openapi-mcp.yaml -g javascript -o ./client-mcp
Agentenbereitschaft
Beide Spezifikationen sind „agentenbereit“ – optimiert für den Einsatz mit KI-Agenten und -Tools. Sie folgen Best Practices für Maschinenlesbarkeit:
- Detaillierte Operationsbeschreibungen mit höherer Informationsdichte als offizielle Dokumente
- Konsistente Benennungsmuster für alle zugehörigen Endpunkte
- Vollständige Schemadokumentation mit ausführlichen Eigenschaftsbeschreibungen
- Beispiele für alle Operationen und Schemakomponenten
- Richtig strukturierte Referenzen und Beziehungen zwischen Komponenten
Die MCP-Version steigert die Agentenbereitschaft noch weiter durch:
- Kuratierte Auswahl hochwertiger Endpunkte für allgemeine Aufgaben
- Aufgabenorientierte Organisation, die auf die Absichten der Benutzer ausgerichtet ist
- Verbesserte Beschreibungen mit Fokus auf Gesprächskontexten
- Entfernung spezialisierter Endpunkte, die im Alltagsgebrauch selten vorkommen
- Optimiert für reduzierten Token-Verbrauch in KI-Kontexten
Spezifische Anwendungsfälle für die MCP-Spezifikation finden Sie in subset.md , wo allgemeine Konversationsaufgaben und die entsprechenden API-Workflows beschrieben werden.
MCP-Servernutzung
So verwenden Sie den MCP-Server mit Ihrer KI-Assistentenkonfiguration:
Brötchen (empfohlen)
{
"mcpServers": {
"fastly api": {
"command": "bunx",
"args": ["fastly-mcp-server@latest", "run"],
"env": {
"API_KEY_APIKEYAUTH": "your-fastly-api-key"
}
}
}
}
Node.js
{
"mcpServers": {
"fastly": {
"command": "npx",
"args": ["-y", "fastly-mcp-server@latest", "run"],
"env": {
"API_KEY_APIKEYAUTH": "your-fastly-api-key"
}
}
}
}
Hinweis : Bun ist aufgrund seiner überlegenen Leistung und Startzeit die bevorzugte Laufzeit für den Fastly-MCP-Server.
Weitere Einzelheiten zur Konfiguration und Verwendung finden Sie in der Fastly-MCP-Server-Dokumentation .
Ressourcen