Dokumentation im Kontext
Der sOU MCP Server sucht und liest öffentliche Anleitungen samt Codebeispielen. Er liest keine privaten Workspace-Daten und lädt keine HUDs hoch.
sOU für Entwickler · Model Context Protocol
Verbinde deinen KI-Assistenten mit dem sOU MCP Server. Nutze die Dokumentation direkt bei der HUD-Entwicklung, beim Aufbau deiner Release-Pipeline und bei der Anbindung externer Systeme an sOU.
Öffentliche Dokumentation · Deutsch & Englisch · Ohne API-Schlüssel
Einmal verbinden. Gezielt nachschlagen.
Füge in einem MCP-fähigen Editor oder KI-Assistenten einen entfernten Server hinzu. Die Einrichtung heißt je nach Werkzeug anders; die Verbindungsdaten bleiben dieselben.
Server-URL
https://www.getsou.app/mcpsearch & fetchTrage die URL in die MCP-Verbindungen deines Werkzeugs ein und wähle bei Bedarf Streamable HTTP.
Bitte den Assistenten, zuerst nach dem Thema zu suchen und dann die zurückgegebene Artikel- oder Abschnittskennung abzurufen.
Prüfe die verlinkte Anleitung und den passenden SDK- oder API-Stand. Nutze das Ergebnis für deinen Code und deine Tests.
Kontext und Ausführung
Der sOU MCP Server sucht und liest öffentliche Anleitungen samt Codebeispielen. Er liest keine privaten Workspace-Daten und lädt keine HUDs hoch.
Deine CI/CD-Pipeline nutzt einen organisationsgebundenen Creator-Schlüssel für HUD-Uploads und Statusabfragen.
Dein Dienst liest oder schreibt mit einem eigenen Workspace-Schlüssel Teams, Spieler, Matches und weitere freigegebene Daten.
Beispiel 01 · HUD-Entwicklung
Gib deinem Assistenten eine konkrete Aufgabe und lass ihn die passenden SDK-Beispiele über MCP lesen. So arbeitet er mit den dokumentierten Typen, Panels und Ansichten von sOU.
Beispielprompt
Nutze den sOU MCP Server. Lies die aktuelle Anleitung und die SDK-Beispiele. Erstelle ein natives HUD mit Spielername, HP und Rundenzeit. Biete die Überschrift als Panel-Einstellung an. Gib mir die Projektdateien und Tests für Spielerwechsel, fehlende Daten und Pausen. Prüfe den benötigten SDK-Stand und verlinke deine Quellen.SDK-Einstieg und vollständige Beispiele →
MCP: Argumente für search
{"query":"HudSession","language":"en"}Danach fetch mit einer exakt zurückgegebenen Kennung aufrufen. Die Antwort enthält den vollständigen Artikel oder Abschnitt mit Quellenlink.
Web-HUD: Vorlage und Vorschau
./tools/sou-hud init web ./MyWebHud --id my-web-hud
./tools/sou-hud dev ./MyWebHudVoraussetzung: SDK-Bundle und Paketwerkzeug nach Anleitung eingerichtet. Die Vorschau arbeitet mit Beispieldaten und benötigt kein laufendes CS2. Blazor-HUDs werden vor der Vorschau veröffentlicht.
Beispiel 02 · CI/CD & Creator-API
Lass dir mit dem MCP-Kontext einen Release-Job für deine Umgebung erstellen: HUD bauen, Paket prüfen, eine neue Version hochladen und den Prüfstatus abfragen.
Beispielprompt
Lies über sOU MCP die Creator-API und den HUD-Paketbau. Erstelle einen CI-Job für mein Repository: Paket bauen und validieren, mit einem Creator-Schlüssel aus CI-Secrets hochladen und Release-ID, Version, Hash und Prüfstatus auswerten. Verwende den vorhandenen HUD-Eintrag. Plane den Umgang mit ausstehender Prüfung und einer verlorenen Uploadantwort.
Voraussetzungen: bestehender HUD-Eintrag, Publisher-Recht für die Organisation und Creator-Schlüssel mit Schreibzugriff. Hinterlege den Schlüssel als CI-Secret; Organisation und HUD-Kennung sind separate Variablen.
Das Beispiel setzt Bash, curl, jq und ein bereits gebautes Paket voraus. Der Paketname muss zum Build passen; jedes Update braucht eine neue Versionsnummer.
Creator-API und Prüfstatus →Shell-Schritt nach dem Paketbau
set -euo pipefail
./tools/sou-hud validate ./dist/my-hud.souhud
curl --fail-with-body \
-H "Authorization: Bearer $SOU_CREATOR_KEY" \
-H 'Content-Type: application/octet-stream' \
--data-binary @./dist/my-hud.souhud \
"https://www.getsou.app/api/v1/integration/organizations/$SOU_ORGANIZATION/huds/$SOU_HUD/releases" \
> release.json
SOU_RELEASE_ID=$(jq -er '.id' release.json)
curl --fail-with-body \
-H "Authorization: Bearer $SOU_CREATOR_KEY" \
"https://www.getsou.app/api/v1/integration/organizations/$SOU_ORGANIZATION/huds/$SOU_HUD/releases/$SOU_RELEASE_ID"Beispiel 03 · Workspace-API
Verbinde dein Redaktionswerkzeug, Turniersystem oder internes Dashboard mit gespeicherten Teams, Spielern und Matches. Der MCP liefert die Anleitung; dein Dienst spricht die Workspace-API an.
Beispielprompt
Nutze sOU MCP und die OpenAPI-Referenz. Erstelle eine Anbindung für mein Turniersystem: Teams und Spieler lesen, ein neues Match vorbereiten und Änderungen revisionsgeschützt übertragen. Speichere den Workspace-Schlüssel serverseitig. Berücksichtige HTTP 409 und Änderungen, die während eines laufenden Casts erst übernommen werden müssen.
Zum Einstieg genügt ein Leseschlüssel für genau einen Workspace. Für Änderungen brauchst du einen Schreibschlüssel und die passende Workspace-Rolle.
Workspace-API kennenlernen → OpenAPI JSON ↗Erster Leseaufruf · Bash
curl --fail-with-body \
-H "Authorization: Bearer $SOU_WORKSPACE_KEY" \
"https://www.getsou.app/api/v1/integration/workspaces/$SOU_WORKSPACE/teams"JSON für ein neues Team
{
"expectedRevision": 0,
"data": {
"id": "team-alpha",
"name": "Team Alpha",
"shortName": "ALP"
}
}PUT /workspaces/{workspace}/teams/team-alpha
Der Pfad ist relativ zur Integrationsbasis. expectedRevision: 0 gilt nur für eine Neuanlage; bei Änderungen zuerst den aktuellen Inhalt und die Revision lesen. Ein PUT ersetzt die vollständige Entität.
Für den öffentlichen Doku-MCP nicht. Creator- und Workspace-API benötigen jeweils ihren eigenen Schlüssel und die passenden Rechte.
Der sOU MCP Server bietet ausschließlich search und fetch für öffentliche Dokumentation. Den Upload übernimmt deine Pipeline oder Anwendung über die Creator-API.
Das veröffentlichte sOU-Handbuch in Deutsch und Englisch, einschließlich SDK-Anleitungen, Typen, Datenbedeutung und öffentlicher API-Referenzen. search liefert Artikel oder Abschnitte; fetch ruft deren Inhalt mit Quellenlink ab.
Creator- und Workspace-Schlüssel sind getrennt gebunden: an eine Organisation beziehungsweise an einen Workspace. Erstelle für deine Integration die passende Schlüsselart und halte sie aus Repository, Browsercode und Logs heraus.
Kontext für deinen nächsten Schritt
Bring die sOU-Dokumentation in dein KI-Werkzeug und starte mit einem der drei Entwicklerabläufe.