Documentation in context
The sOU MCP server searches and reads public guides and code examples. It does not read private workspace data or upload HUDs.
sOU for developers · Model Context Protocol
Your AI tools. With sOU context.
Connect your AI assistant to the sOU MCP server. Use the documentation while developing HUDs, building your release pipeline and integrating external systems with sOU.
Public documentation · German & English · No API key required
- Develop HUDsSDK & complete examples
- Automate releasesCreator API for your pipeline
- Integrate dataWorkspace API & OpenAPI
Connect once. Find the right reference.
sOU documentation in your AI tools.
Add a remote server in an MCP-capable editor or AI assistant. Setup labels vary between tools; the connection details stay the same.
Server URL
https://www.getsou.app/mcp- Transport
- Streamable HTTP
- Authentication
- None for public documentation
- Tools
search&fetch
Add the server
Enter the URL in your tool’s MCP connections and select Streamable HTTP if prompted.
Search the documentation
Ask your assistant to search the topic first, then fetch the returned article or section ID.
Work from the sources
Check the linked guide and the SDK or API version it describes. Use the result for your code and tests.
Context and execution
MCP explains the path. Your integration executes it.
Upload HUD packages
Your CI/CD pipeline uses an organization-scoped Creator key for HUD uploads and status queries.
Connect saved data
Your service uses its own workspace key to read or write teams, players, matches and other permitted data.
Example 01 · HUD development
From HUD concept to local preview.
Give your assistant a concrete task and ask it to read relevant SDK examples through MCP. It can then work with sOU’s documented types, panels and views.
Example prompt
Use the sOU MCP server. Read the current guide and SDK examples. Create a native HUD with player name, HP and round time. Add a panel setting for its heading. Provide project files and tests for player changes, missing data and pauses. Check the required SDK version and link your sources.SDK setup and complete examples →
MCP: search arguments
{"query":"HudSession","language":"en"}Then call fetch with an exact returned ID. The response contains the complete article or section and its source link.
Web HUD: template and preview
./tools/sou-hud init web ./MyWebHud --id my-web-hud
./tools/sou-hud dev ./MyWebHudPrerequisite: the SDK bundle and package tool are set up as described in the guide. Preview uses sample data and does not require CS2. Blazor HUDs must be built with dotnet publish before previewing.
Example 02 · CI/CD & Creator API
Your HUD release as a pipeline step.
Use MCP context to help create a release job for your environment: build the HUD, validate its package, upload a new version and query its review status.
Example prompt
Read the Creator API and HUD packaging docs through sOU MCP. Create a CI job for my repository: build and validate the package, upload it using a Creator key from CI secrets, and inspect release ID, version, hash and review status. Use the existing HUD entry. Handle pending review and a lost upload response.
Prerequisites: an existing HUD entry, publisher permission for the organization and a Creator key with write access. Store the key as a CI secret; organization and HUD IDs are separate variables.
This example assumes Bash, curl, jq and an already built package. The package name must match your build; each update needs a new version number.
Creator API and review status →Shell step after packaging
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"Example 03 · Workspace API
Your tournament system. Your sOU data.
Connect your editorial tools, tournament system or internal dashboard to saved teams, players and matches. MCP provides the documentation; your service calls the Workspace API.
Example prompt
Use sOU MCP and the OpenAPI reference. Create an integration for my tournament system: read teams and players, prepare a new match and send revision-protected changes. Keep the workspace key server-side. Handle HTTP 409 and updates that must be explicitly applied during a running broadcast.
Start with a read key scoped to one workspace. Changes require a write key and the appropriate workspace role.
Explore the Workspace API → OpenAPI JSON ↗First read request · Bash
curl --fail-with-body \
-H "Authorization: Bearer $SOU_WORKSPACE_KEY" \
"https://www.getsou.app/api/v1/integration/workspaces/$SOU_WORKSPACE/teams"JSON for a new team
{
"expectedRevision": 0,
"data": {
"id": "team-alpha",
"name": "Team Alpha",
"shortName": "ALP"
}
}PUT /workspaces/{workspace}/teams/team-alpha
The path is relative to the integration base URL. expectedRevision: 0 is for creation only; read the current content and revision before updates. PUT replaces the full entity.
Questions about the sOU MCP server
Do I need an account or key?
Not for the public documentation MCP. The Creator and Workspace APIs each require their own key and permissions.
Can the MCP server publish HUDs itself?
The sOU MCP server only provides search and fetch for public documentation. Your pipeline or application performs uploads through the Creator API.
Which documentation can my assistant read?
The published sOU handbook in German and English, including SDK guides, types, data semantics and public API references. search returns articles or sections; fetch retrieves their content with source links.
Can I use the same key for both APIs?
Creator and workspace keys have separate scopes: an organization or a workspace. Create the right key type for your integration and keep it out of repositories, browser code and logs.
Context for your next step
Connect. Look it up. Build.
Bring sOU documentation into your AI tools and start with one of the three developer workflows.