skycloak-mcp
skycloak-mcp
Skycloak(マネージド Keycloak)向けの公式 Model Context Protocol サーバーです。任意の MCP クライアント(Claude Desktop、Claude Code、Cursor)からクラスター、レルム、アプリケーション、SSO を管理できます。
ステータス: 早期リリースです。ツールのカバレッジは拡大中です。利用可能なものはチェンジログを参照してください。
クイックスタート
claude mcp add --transport http skycloak https://mcp.skycloak.ioAPIキーもクライアントIDも設定も不要です。ブラウザが開き、Skycloak にサインインするとツールが表示されます。ストリーミング可能な HTTP に対応した MCP クライアントなら、どれも同じように動作します: URL を渡すだけで、他には何も必要ありません。
その後、次のように依頼します:
"私の Keycloak クラスターのうち、アップグレードが遅れているものはどれ?"
"EU クラスターに、Google と GitHub サインインを使用する staging レルムを作成して。"
"先週、本番レルムに追加されたのは誰?"
"管理者イベントを Datadog webhook に転送する SIEM 転送先を設定して。"
Related MCP server: MCP Authentik
認証と安全性
ホステッド HTTP(OAuth、設定する認証情報は不要)。 クライアントをヘッダーなしで
https://mcp.skycloak.ioに向けます。サーバーは401を返し、/.well-known/oauth-protected-resourceにある RFC 9728 メタデータへのポインターを示します。クライアントは Skycloak のログインレルムに対してブラウザーの認可コードフローを実行し、受け取ったアクセストークンは、セッションが使用する短期間有効なワークスペーススコープの API キーと交換されます。このキーは 1 時間有効で、自動的に更新されます。クライアント設定には何も保存されません。ホステッド HTTP(API キー)。 Skycloak ダッシュボードでキーを作成し、
Authorization: Bearer <key>(またはAPI-Key: <key>)として送信します。各リクエストは独自の認証情報を保持し、その認証情報のワークスペースとしてのみ動作します。サーバーはセッション状態を保持しないため、リクエストが他の呼び出し元の状態を引き継ぐことはありません。キーは使用前に検証されません: Skycloak API が正規の権威であり、無効なキーは接続時ではなく、最初のツール呼び出し時に401として表面化します。ツールはロールに応じて変わります。 OAuth では、ツール一覧はセッションのスコープで許可されたものに絞り込まれるため、読み取り専用のワークスペースメンバーには、
403を返すであろう書き込みツールは表示されません。API キーの場合は、キーのスコープがサーバーから見えないため、全ツールが登録され、許可されていない呼び出しは API から403として表面化します。ローカル stdio。
skycloak-mcp initを実行し、ブラウザーで承認します(OAuth 2.0 デバイス認可フロー)。これにより、ワークスペーススコープの API キーが生成され、オペレーティングシステムのキーチェーンに保存され、デフォルトのワークスペースが自動的に検出されます(別のワークスペースを選ぶには--workspace <id>を渡します)。skycloak-mcp logoutは保存されたキーを削除します。ヘッドレス / CI。
SKYCLOAK_API_KEY環境変数を設定すると(キーは Skycloak ダッシュボードで作成)、ブラウザーを完全にスキップできます。これは常にキーチェーンよりも優先されます。書き込みはフラグではなく認証情報によって制御されます。
https://mcp.skycloak.ioのホステッドサーバーは書き込み可能で動作し、実際に変更できる範囲はキーのスコープとワークスペースのロールによって制限されます: 読み取り専用メンバーは、ツール一覧がどうであれ、何も変更できません。URL に?readonly=trueを追加すると、セッションで読み取り専用のツールサーフェスを強制できます。ローカルバイナリは逆で、--allow-writesを付けない限り書き込みツールは登録されません。クラスター認証情報はオプトインです。
get_cluster_credentialsはクラスターの Keycloak 管理者認証情報を返します。これはキーを保持するアシスタントが見ることになるため、initはデフォルトではそのスコープを要求しません。そのスコープを持つキーを使用してください: ダッシュボードで作成するか、stdio 経由でskycloak-mcp init --allow-credentialsを使ってサインインします。これがない場合、ツールは両方の方法を説明する 403 を返します。破壊的なツールには確認が必要です: たとえばレルムの削除には、明示的な
confirm=true引数が必要です。リクエストは Skycloak のプランに応じてレート制限されます。
429応答では、サーバーはRetry-Afterを表示します。
ツール
129 個のツール: 読み取り専用 58 個と書き込み 71 個です。読み取り専用ツールは常に利用できます。ホステッドサーバーでは書き込みツールも登録され、認証情報のスコープによって制御されます。ローカルバイナリは --allow-writes を付けて起動した場合のみ登録します。
ツール名には skycloak_ プレフィックスが付いていますが、以下の表では省略されています。したがって、list_clusters はクライアントでは skycloak_list_clusters になります。
エリア | 読み取り専用 | 書き込み ( |
クラスター |
|
|
エッジセキュリティ |
|
|
レルム |
|
|
アプリケーション |
|
|
IDプロバイダー |
|
|
ユーザー、ロール、グループ |
|
|
カスタムドメイン |
|
|
ブランディングとテーマ |
|
|
拡張機能 |
|
|
SMTP |
|
|
エクスポートとログ |
|
|
レルムのインポートとエクスポート |
|
|
SIEM |
|
|
Webhook |
|
|
規約: 破壊的なツール(delete_*、uninstall_extension、cancel_cluster_upgrade)には confirm=true が必要です。create_cluster は非同期です。get_cluster をポーリングしてクラスターが available になるまで待ちます。create_domain は顧客が作成する必要があるDNSレコードを返します。verify_domain はDNSチェックをトリガーします。set_theme_assignment はKeycloakテーマタイプごとにカスタムテーマを有効にします(空文字列でビルトインのデフォルトにリセット)。update_cluster_security はCAPTCHA設定を変更しません。レルムのインポート/エクスポートは1つのレルムの設定を移動し、クラスター全体のデータベースをダンプする create_export とは別のものです。どちらも非同期で、レルムアーカイブは常に暗号化されているため、エクスポート時に使用したパスワードが再インポート時に必要です。レルムは既存のエクスポート(source_export_id)から直接インポートするか、アップロードされたアーカイブ(create_realm_import_upload_url、PUT、次に upload_s3_key)からインポートできます。インポートはレルムを作成し、上書きではなく名前の衝突を拒否します。また、ユーザーと認証情報を伴うため confirm=true が必要です。
接続
ホスト型HTTPの場合、最も簡単な方法はOAuthで、資格情報はまったく必要ありません:
claude mcp add --transport http skycloak https://mcp.skycloak.io最初の呼び出しでブラウザが開き、Skycloakのログインページで承認すると、ツールが表示されます。複数のワークスペースに所属している場合は、使用するワークスペースの名前を指定します:
claude mcp add --transport http skycloak "https://mcp.skycloak.io?workspace=<workspace-id>"それ以外の場合は、SkycloakダッシュボードでAPIキーを作成し、MCPクライアントがベアラートークンとして送信するように設定します:
claude mcp add --transport http skycloak https://mcp.skycloak.io --header "Authorization: Bearer sk_sc_XXX"これにより、.claude.json に以下が追加されます:
{
"mcpServers": {
"skycloak": {
"type": "http",
"url": "https://mcp.skycloak.io",
"headers": {
"Authorization": "Bearer sk_sc_XXX"
}
}
}
}ローカルのstdioの場合、一度サインインしてから、クライアントを skycloak-mcp run に向けます:
skycloak-mcp init # one-time browser sign-in; stores a key in your keychainClaude Desktop / Cursor(ローカル、stdio):
{
"mcpServers": {
"skycloak": {
"command": "skycloak-mcp",
"args": ["run", "--transport", "stdio"]
}
}
}Claude Code:
claude mcp add skycloak -- skycloak-mcp run --transport stdioヘッドレス/CI(ブラウザなし)の場合は、init をスキップして代わりにキーを渡します。設定に "env": { "SKYCLOAK_API_KEY": "sk_sc_..." } を追加するか、claude mcp add skycloak --env SKYCLOAK_API_KEY=sk_sc_... -- skycloak-mcp run --transport stdio を実行します。
変更を加える場合にのみ --allow-writes を追加します(skycloak-mcp init --allow-writes でサインインするか、書き込みスコープのキーを使用します)。
ホスト型HTTPのURLに ?readonly=true を追加すると、そのHTTPセッションでは読み取り専用ツールのみが公開されます。?readonly=false を追加すると、書き込み可能なツールサーフェスを要求します。クエリパラメータのデフォルトは false ですが、書き込みツールはサーバーが --allow-writes で起動された場合にのみ登録されます。
?workspace=<uuid> を追加して、OAuth セッションが動作するワークスペースを選択します。これは複数のワークスペースに所属している場合にのみ必要です。単一のワークスペースの場合はサーバーが自動的に選択します。複数に所属していて名前を指定しない場合、接続は失敗し、そのリストを示すメッセージが表示されます。
HTTP トランスポートの実行
skycloak-mcp run --transport http --http-addr :8080これ自体に資格情報は必要ありません。呼び出し元がリクエストごとに資格情報を提供するため、デプロイ時に何も注入されません。GET /healthz と GET /readyz は認証なしで、プロセスが起動していることのみを報告します。これらのエンドポイントは意図的に Skycloak API をプローブしないため、上流の障害が原因で全てのレプリカのプローブが同時に失敗することはありません。サーバーはセッション状態を保持しないため、レプリカにセッションアフィニティは不要で、自由にスケールやロールアウトが可能です。SIGTERM は新しい接続を停止し、進行中の呼び出しをドレインします。
OAuth パスは SKYCLOAK_ISSUER と SKYCLOAK_DASHBOARD_URL が設定されている場合に有効になります(デフォルトで設定されています)。GET /.well-known/oauth-protected-resource は認証なしで提供され、レルムを認可サーバーとして指定します。その resource 値は、SKYCLOAK_PUBLIC_URL が設定されている場合はそこから、そうでない場合はリクエスト自身の Host とスキームから取得されます。そのため、ingress の背後にある単一ホストのデプロイメントでは追加の設定は不要です。スキームは X-Forwarded-Proto が存在する場合はその値を使用し、それ以外の場合はループバックホスト以外ではデフォルトで https になります。これは TLS が上流で終端され、http:// 識別子を公開するとクライアントが接続した URL と一致しないためです。ingress が Host を書き換える場合は SKYCLOAK_PUBLIC_URL を設定してください。ドキュメントには scopes_supported として openid profile email もリストされ、WWW-Authenticate チャレンジはそれらを scope パラメータとして繰り返すため、どちらかを読むクライアントはレルムにそれらを要求します。openid は必須です。トークン交換によりダッシュボードが Keycloak のユーザー情報エンドポイントを呼び出し、Keycloak は openid なしで付与されたトークンを拒否するためです。openid なしで到着したトークンは、成功できない交換に持ち込まれることなく、検証時に 401 とチャレンジで拒否されるため、以前の付与をまだ保持しているクライアントは再試行を停止して再サインインします。発行者またはダッシュボード変数のいずれかを空白にすると、OAuth は完全にオフになり、サーバーは API キーのみを要求するようになります。
起動時には、解決された配線(oauth=、issuer=、dashboard=、public_url=、endpoint=、allow_writes=)を含む1行がログに記録されるため、誤設定されたデプロイメントを再デプロイなしで特定できます。OAuth パスで拒否されたすべてのリクエストは、失敗したステージ(verify、exchange、scopes)、呼び出し元が受け取ったステータス、および根本的なエラーを名前付きで1行ログに記録します。検証失敗では、トークンを拒否したチェック(expired、wrong_issuer、bad_signature、unknown_key_id、wrong_token_type、no_openid_scope など)が追加されます。交換失敗では、ダッシュボードのステータスと呼び出されたホストが追加されます。呼び出し元は、トークンが検証された後にそのサブジェクトとして表示され、資格情報として表示されることはありません。アクセストークン、Authorization ヘッダー、および生成された API キーは決してログに記録されません。
設定
環境変数 | デフォルト |
| なし(stdio ではオプション。HTTP クライアントは代わりに |
|
|
| 現在の API バージョン |
|
|
|
|
|
|
| なし(各リクエストから派生。ingress が |
コマンド: init(ブラウザサインイン)、run(サーブ)、logout(保存されたキーを削除)。init は --workspace <id>、--allow-writes、--allow-credentials、--ttl-days(デフォルト 90)を受け入れます。
フラグ | デフォルト | 説明 |
|
|
|
|
| HTTP トランスポートの待受アドレス |
|
| stdio の変更ツールを有効にし、 |
開発
make build # build the server binary
make test # unit tests
make run # run on stdio for local testing
make inspector # MCP Inspector against the local binary
make lint # golangci-lint
make generate # regenerate the API client from the OpenAPI specinternal/apiclient にある API クライアントは、oapi-codegen を使用して Skycloak OpenAPI 仕様から生成されます。
API との同期を維持する
internal/apiclient のクライアントは internal/apiclient/openapi.yaml から oapi-codegen で生成されます。make generate を実行して更新してください。コミットされた生成コードが仕様から逸脱している場合、CI は失敗します。リクエストは 429/5xx で Retry-After を考慮したバックオフで再試行されます。
配布
各タグで GitHub バイナリと ghcr.io/sky-cloak/skycloak-mcp コンテナイメージとしてリリースされ、MCP レジストリ に io.skycloak/skycloak-mcp として公開されています。ほとんどの人はどちらも必要ありません。ホスト型サーバーはインストール不要です。
セキュリティ
脆弱性は非公開で報告してください。SECURITY.md を参照してください。
貢献者
Skycloak で Guilliano Molaire、Neville Omangi、Aphilas によって構築されました。リポジトリの履歴は公開時にスカッシュされたため、コミットログは誰が何を書いたかを反映していません。
ライセンス
Apache-2.0。internal/apiclient/openapi.yaml の OpenAPI 記述は Skycloak プラットフォーム API から生成されたもので、(c) Skycloak に帰属します。クライアントの生成と検証のためにここに含まれています。NOTICE を参照してください。
Available Tools
141 toolsskycloak_add_cluster_captcha_domainCInspect
Register a hostname for CAPTCHA protection on a cluster.
Inputs: hostname (required), cluster_id (required). Returns: hostname, created_at
skycloak_add_realm_user_to_groupCIdempotentInspect
Add a user to a realm group.
Inputs: realm (required), user_id (required), group_id (required), cluster_id (required). Returns: object
skycloak_assign_application_roleAIdempotentInspect
Grant a role to an application's service account. Provide role_client_id for a client role, or omit it for a realm role.
Inputs: realm (required), client_id (required), role_name (required), cluster_id (required), +1 more. Returns: object
skycloak_assign_realm_user_roleCIdempotentInspect
Assign a realm role to a user.
Inputs: realm (required), user_id (required), role_name (required), cluster_id (required). Returns: object
skycloak_cancel_cluster_upgradeADestructiveInspect
Cancel an in-progress cluster version upgrade. Set confirm=true to proceed.
Inputs: confirm (required), cluster_id (required). Returns: object
skycloak_create_applicationAInspect
Create an OIDC/SAML client (application) in a realm. Returns the client secret for confidential clients (store it; it is not retrievable later).
Inputs: name (required), realm (required), client_id (required), cluster_id (required), +4 more. Returns: client_id, client_secret
skycloak_create_application_roleAInspect
Define a new role on an application. This creates the role itself; use skycloak_assign_application_role to grant it to a user.
Inputs: name (required), realm (required), client_id (required), cluster_id (required), +1 more. Returns: id, name, client_id, composite, +2 more
skycloak_create_clusterAInspect
Provision a new Keycloak cluster. Asynchronous: the returned cluster starts in a provisioning state — poll skycloak_get_cluster until its status is 'available'. Requires --allow-writes.
Inputs: name (required), size (required), version (required), location (required), +7 more. Returns: id, url, name, size, +7 more
skycloak_create_domainBInspect
Add a custom domain to a cluster. Returns the DNS records the customer must create to verify and route the domain.
Inputs: domain (required), cluster_id (required), subdomain. Returns: id, domain, is_active, subdomain, +4 more
skycloak_create_domain_routeAInspect
Add a realm route to a custom domain. Never use the master realm; it is reserved for cluster management and the API rejects it.
Inputs: realm (required), domain_id (required), cluster_id (required), hide_realm_path, +1 more. Returns: id, realm, hide_realm_path, allow_admin_access
skycloak_create_exportAInspect
Start a database export for a cluster. Asynchronous: poll skycloak_get_export until the status is 'completed' to obtain the download URL. Including credentials requires an encryption_password.
Inputs: format (required), cluster_id (required), encryption_password, include_credentials. Returns: id, format, status, progress, +6 more
skycloak_create_identity_providerBInspect
Create an OIDC identity provider (SSO connection) in a realm.
Inputs: realm (required), cluster_id (required), provider_id (required), display_name (required), +5 more. Returns: object
skycloak_create_openfga_instanceAInspect
Create an OpenFGA instance bound to one realm of a cluster; a realm has at most one. Asynchronous: it starts in 'provisioning', so poll skycloak_get_openfga_instance until the status is 'ready' or 'failed'. The instance accepts only tokens from that realm that carry the instance's audience. Fails with 403 when the workspace's plan does not include OpenFGA or the workspace reached its instance limit, 409 when the realm already has an instance, and 422 when the realm is 'master', does not exist or is disabled.
Inputs: realm (required), cluster_id (required). Returns: id, realm, issuer, status, +6 more
skycloak_create_realmAInspect
Create a new Keycloak realm in a cluster. Requires the server to be started with --allow-writes and a write-scoped API key.
Inputs: name (required), cluster_id (required), display_name. Returns: name, enabled, cluster_id, cluster_name, +5 more
skycloak_create_realm_exportAInspect
Export a Keycloak realm to an encrypted archive. Asynchronous: poll skycloak_get_realm_export until status is 'completed'. The archive is always encrypted, so encryption_password is required, and the same password is needed to import it again. This is a realm export (one realm's configuration); skycloak_create_export is the separate whole-cluster database export.
Inputs: realm (required), cluster_id (required), encryption_password (required). Returns: id, realm, scope, status, +9 more
skycloak_create_realm_groupBInspect
Create a realm group, optionally nested under a parent group.
Inputs: name (required), realm (required), cluster_id (required), parent_id. Returns: id, name, path
skycloak_create_realm_importAInspect
Import a Keycloak realm into a cluster from an uploaded archive or an existing realm export. Asynchronous: poll skycloak_get_realm_import. Creates a new realm: preflight refuses a name collision rather than overwriting, so an existing realm of the same name fails with 409. It does import users and their credentials, so set confirm=true to proceed.
Inputs: confirm (required), cluster_id (required), password, upload_s3_key, +1 more. Returns: id, realm, status, progress, +7 more
skycloak_create_realm_import_upload_urlAInspect
Get a presigned URL to upload a realm archive to. PUT the archive to upload_url, then pass the returned s3_key to skycloak_create_realm_import as upload_s3_key. Not needed when importing an existing export: pass that export's ID as source_export_id instead.
Inputs: cluster_id (required). Returns: s3_key, upload_url
skycloak_create_realm_roleCInspect
Create a realm-scoped role.
Inputs: name (required), realm (required), cluster_id (required), description. Returns: name, composite, description
skycloak_create_realm_userBInspect
Create a realm user with an initial temporary password.
Inputs: email (required), realm (required), username (required), cluster_id (required), +4 more. Returns: id, email, enabled, username, +3 more
skycloak_create_siem_destinationCInspect
Create a SIEM destination. Credentials are write-only and are not returned.
Inputs: name (required), type (required), source (required), s3, +3 more. Returns: id, s3, http, name, +14 more
skycloak_create_webhook_subscriptionBInspect
Create a webhook subscription. Signing secrets and authorization headers are write-only.
Inputs: url (required), name (required), source (required), event_types (required), +5 more. Returns: id, url, name, source, +8 more
skycloak_delete_applicationADestructiveInspect
Delete an application (OIDC/SAML client) from a realm. Set confirm=true to proceed.
Inputs: realm (required), confirm (required), client_id (required), cluster_id (required). Returns: object
skycloak_delete_application_roleADestructiveInspect
Delete a role from an application. Every user and group holding it loses it. Set confirm=true to proceed.
Inputs: realm (required), confirm (required), client_id (required), role_name (required), +1 more. Returns: object
skycloak_delete_clusterADestructiveInspect
Permanently delete a Keycloak cluster and all of its realms and data. Irreversible. Set confirm=true to proceed.
Inputs: id (required), confirm (required). Returns: object
skycloak_delete_cluster_maintenance_windowADestructiveInspect
Delete a cluster-specific maintenance window so the cluster follows the workspace default. Set confirm=true to proceed.
Inputs: confirm (required), cluster_id (required). Returns: object
skycloak_delete_domainADestructiveInspect
Remove a custom domain from a cluster. Set confirm=true to proceed.
Inputs: confirm (required), domain_id (required), cluster_id (required). Returns: object
skycloak_delete_domain_routeCDestructiveInspect
Remove a realm route from a custom domain. Set confirm=true to proceed.
Inputs: confirm (required), route_id (required), domain_id (required), cluster_id (required). Returns: object
skycloak_delete_email_brandingADestructiveInspect
Revert email branding to defaults. Set confirm=true to proceed.
Inputs: realm (required), confirm (required), cluster_id (required). Returns: object
skycloak_delete_exportADestructiveInspect
Delete a database export archive. Set confirm=true to proceed.
Inputs: confirm (required), export_id (required), cluster_id (required). Returns: object
skycloak_delete_extensionBDestructiveInspect
Delete a custom extension from the workspace catalog. Set confirm=true to proceed.
Inputs: confirm (required), extension_id (required). Returns: object
skycloak_delete_identity_providerBDestructiveInspect
Delete an identity provider from a realm. Set confirm=true to proceed.
Inputs: realm (required), confirm (required), cluster_id (required), provider_id (required). Returns: object
skycloak_delete_login_brandingADestructiveInspect
Revert login branding to defaults. Set confirm=true to proceed.
Inputs: realm (required), confirm (required), cluster_id (required). Returns: object
skycloak_delete_openfga_instanceADestructiveInspect
Permanently delete an OpenFGA instance with its deployment, route and database. The authorization data in it cannot be recovered. Works without OpenFGA access. Removal is asynchronous: the instance shows 'deleting' until it leaves the list. Set confirm=true to proceed.
Inputs: confirm (required), cluster_id (required), instance_id (required). Returns: object
skycloak_delete_realmADestructiveInspect
Permanently delete a realm and all of its users, clients and configuration. This is irreversible. Set confirm=true to proceed.
Inputs: name (required), confirm (required), cluster_id (required). Returns: object
skycloak_delete_realm_groupADestructiveInspect
Delete a realm group. Set confirm=true to proceed.
Inputs: realm (required), confirm (required), group_id (required), cluster_id (required). Returns: object
skycloak_delete_realm_roleBDestructiveInspect
Delete a realm role. Set confirm=true to proceed.
Inputs: name (required), realm (required), confirm (required), cluster_id (required). Returns: object
skycloak_delete_realm_userBDestructiveInspect
Delete a realm user. Set confirm=true to proceed.
Inputs: realm (required), confirm (required), user_id (required), cluster_id (required). Returns: object
skycloak_delete_siem_destinationADestructiveInspect
Delete a SIEM destination. Set confirm=true to proceed.
Inputs: confirm (required), destination_id (required). Returns: object
skycloak_delete_smtpBDestructiveInspect
Remove a realm's SMTP configuration. Set confirm=true to proceed.
Inputs: realm (required), confirm (required), cluster_id (required). Returns: object
skycloak_delete_themeADestructiveInspect
Delete a custom theme. Set confirm=true to proceed. To change an existing theme's files, use skycloak_update_theme_content instead: deleting a theme that is still assigned returns 409, and re-uploading it gives a new ID.
Inputs: confirm (required), theme_id (required), cluster_id (required). Returns: object
skycloak_delete_webhook_subscriptionBDestructiveInspect
Delete a webhook subscription. Set confirm=true to proceed.
Inputs: confirm (required), webhook_id (required). Returns: object
skycloak_discover_oidcARead-onlyInspect
Resolve an OIDC issuer's discovery document to obtain its authorization, token, and userinfo endpoints. Use the result when creating an identity provider.
Inputs: issuer_url (required). Returns: issuer, jwks_uri, token_endpoint, scopes_supported, +2 more
skycloak_download_theme_contentARead-onlyInspect
Download a custom theme's content archive. Returns size and SHA-256 always, and the archive itself only when it is small enough to inline.
Inputs: theme_id (required), cluster_id (required). Returns: sha256, inlined, size_bytes
skycloak_export_cluster_eventsBInspect
Export a cluster's events as a document and return its contents.
Inputs: cluster_id (required). Returns: document
skycloak_get_applicationARead-onlyInspect
Get an application (OIDC/SAML client) by client ID.
Inputs: realm (required), client_id (required), cluster_id (required). Returns: Name, Type, Status, ClientID, +1 more
skycloak_get_application_roleARead-onlyInspect
Get one role defined on an application, with its description and Keycloak identifiers.
Inputs: realm (required), client_id (required), role_name (required), cluster_id (required). Returns: id, name, client_id, composite, +2 more
skycloak_get_client_theme_assignmentBRead-onlyInspect
Get a client's login-theme override (empty means the realm default).
Inputs: realm (required), client_id (required), cluster_id (required). Returns: login
skycloak_get_clusterBRead-onlyInspect
Get full details for a single Keycloak cluster by its ID.
Inputs: id (required). Returns: id, url, name, size, +7 more
skycloak_get_cluster_credentialsARead-onlyInspect
Get a cluster's Keycloak automation client credentials for OAuth2 client_credentials. Needs a key with the clusters:credentials:read scope, which is not granted by default.
Inputs: cluster_id (required). Returns: client_id, token_url, client_secret
skycloak_get_cluster_insightsBRead-onlyInspect
Get cluster analytics as a JSON document. type is one of: overview, authentication, events, performance, security.
Inputs: cluster_id (required), type. Returns: json
skycloak_get_cluster_maintenance_windowARead-onlyInspect
Get a cluster-specific maintenance window. A 404 means the cluster follows the workspace default.
Inputs: cluster_id (required). Returns: enabled, timezone, end_local, start_local, +1 more
skycloak_get_cluster_securityARead-onlyInspect
Get a cluster's edge-security configuration: IP allow-listing, rate limiting, WAF, geo-blocking, and bot management.
Inputs: cluster_id (required). Returns: waf, geo_blocking, rate_limiting, bot_management, +1 more
skycloak_get_cluster_upgrade_pathBRead-onlyInspect
Get the recommended version-upgrade path for a cluster.
Inputs: cluster_id (required). Returns: steps
skycloak_get_domainBRead-onlyInspect
Get a custom domain by ID, including its DNS records and verification/SSL status.
Inputs: domain_id (required), cluster_id (required). Returns: id, domain, is_active, subdomain, +4 more
skycloak_get_domain_routeCRead-onlyInspect
Get a single realm route on a custom domain.
Inputs: route_id (required), domain_id (required), cluster_id (required). Returns: id, realm, hide_realm_path, allow_admin_access
skycloak_get_email_brandingARead-onlyInspect
Get the email-template branding (colors, logo, footer) for a realm.
Inputs: realm (required), cluster_id (required). Returns: status, primary_color, footer_company_name, header_logo_light_url
skycloak_get_exportARead-onlyInspect
Get a database export job by ID, including its status, progress, and (once completed) the time-limited download URL.
Inputs: export_id (required), cluster_id (required). Returns: id, format, status, progress, +6 more
skycloak_get_identity_providerCRead-onlyInspect
Get an identity provider by provider ID.
Inputs: realm (required), cluster_id (required), provider_id (required). Returns: Type, Enabled, ProviderID, DisplayName
skycloak_get_login_brandingBRead-onlyInspect
Get the login-page branding (colors, logo, toggles) for a realm.
Inputs: realm (required), cluster_id (required). Returns: status, logo_url, primary_color, background_color, +2 more
skycloak_get_logsARead-onlyInspect
Read recent Keycloak server logs for a cluster, optionally filtered by level and a search string.
Inputs: cluster_id (required), level, limit, search. Returns: logs, count
skycloak_get_openfga_instanceARead-onlyInspect
Get one OpenFGA instance of a cluster, including its status and the API URL, token issuer and audience to call it with.
Inputs: cluster_id (required), instance_id (required). Returns: id, realm, issuer, status, +6 more
skycloak_get_realmCRead-onlyInspect
Get a realm by name.
Inputs: realm (required), cluster_id (required). Returns: id, name, enabled, display_name, +6 more
skycloak_get_realm_exportARead-onlyInspect
Get a realm export job by ID. Poll this after skycloak_create_realm_export until status is 'completed'; the download URL only appears then and expires 24 hours later.
Inputs: export_id (required). Returns: id, realm, scope, status, +9 more
skycloak_get_realm_groupCRead-onlyInspect
Get a realm group by ID.
Inputs: realm (required), group_id (required), cluster_id (required). Returns: id, name, path
skycloak_get_realm_importARead-onlyInspect
Get a realm import job by ID. Poll this after skycloak_create_realm_import until status is 'completed' or 'failed'.
Inputs: import_id (required). Returns: id, realm, status, progress, +7 more
skycloak_get_realm_roleCRead-onlyInspect
Get a realm role by name.
Inputs: name (required), realm (required), cluster_id (required). Returns: name, composite, description
skycloak_get_realm_userBRead-onlyInspect
Get a realm user by ID.
Inputs: realm (required), user_id (required), cluster_id (required). Returns: id, email, enabled, username, +3 more
skycloak_get_security_logsBRead-onlyInspect
Read recent security (WAF) logs for a cluster — blocked requests, attack types, source IPs.
Inputs: cluster_id (required), limit, search. Returns: logs, count
skycloak_get_siem_destinationBRead-onlyInspect
Get a SIEM destination by ID.
Inputs: destination_id (required). Returns: id, s3, http, name, +14 more
skycloak_get_smtpARead-onlyInspect
Get a realm's SMTP configuration (secret values are never returned).
Inputs: realm (required), cluster_id (required). Returns: host, port, status, auth_type, +4 more
skycloak_get_themeARead-onlyInspect
Get a custom theme by ID. restart_required is true when the theme's content was replaced under its exact name (see skycloak_get_theme_settings) and Keycloak has not restarted since, so the previous content may still be live; use skycloak_restart_cluster_instances to apply it.
Inputs: theme_id (required), cluster_id (required). Returns: id, name, status, version, +3 more
skycloak_get_theme_assignmentARead-onlyInspect
Get the active custom theme per Keycloak theme type (login, account, admin, email) for a realm.
Inputs: realm (required), cluster_id (required). Returns: admin, email, login, account
skycloak_get_theme_settingsARead-onlyInspect
Get the workspace's theme naming policy: whether exact_theme_names is on. When on, every theme in the workspace is served from a folder named exactly like the theme, and that name never changes across content replaces. When off (the default), the served folder changes on each content replace, unless the theme was created by a platform migration.
Returns: exact_theme_names
skycloak_get_webhook_subscriptionBRead-onlyInspect
Get a webhook subscription by ID.
Inputs: webhook_id (required). Returns: id, url, name, source, +8 more
skycloak_install_extensionAInspect
Install a catalog extension on a cluster. Installation is asynchronous; poll skycloak_list_cluster_extensions until the status settles. Provide required parameters keyed by parameter name.
Inputs: cluster_id (required), extension_id (required), parameters. Returns: source, status, extension_id, extension_name, +3 more
skycloak_list_application_rolesCRead-onlyInspect
List the roles assigned to an application's service account.
Inputs: realm (required), client_id (required), cluster_id (required). Returns: count, roles
skycloak_list_applicationsBRead-onlyInspect
List the OIDC/SAML clients (applications) in a realm.
Inputs: realm (required), cluster_id (required). Returns: count, applications
skycloak_list_application_sessionsARead-onlyInspect
List active user sessions for an application.
Inputs: realm (required), client_id (required), cluster_id (required). Returns: count, sessions
skycloak_list_cluster_captcha_domainsBRead-onlyInspect
List hostnames registered for CAPTCHA protection on a cluster.
Inputs: cluster_id (required). Returns: count, domains, max_allowed
skycloak_list_cluster_extensionsARead-onlyInspect
List the extensions currently installed on a cluster, with their installed version, the version available for the cluster's Keycloak, and upgrade status.
Inputs: cluster_id (required). Returns: count, extensions
skycloak_list_cluster_featuresARead-onlyInspect
List the Keycloak feature flags available to tenant clusters.
Returns: features
skycloak_list_cluster_locationsARead-onlyInspect
List the deployment regions available to the workspace.
Returns: locations
skycloak_list_clustersARead-onlyInspect
List the Keycloak clusters in your Skycloak workspace, with their status, type, size, version and location.
Inputs: limit, offset. Returns: count, clusters
skycloak_list_cluster_typesARead-onlyInspect
List the cluster types the workspace can provision.
Returns: types
skycloak_list_cluster_upgradesBRead-onlyInspect
List the version-upgrade history for a cluster.
Inputs: cluster_id (required). Returns: upgrades
skycloak_list_cluster_versionsCRead-onlyInspect
List the Keycloak versions available for a cluster type.
Inputs: type (required). Returns: versions
skycloak_list_domain_routesCRead-onlyInspect
List the realm routes configured on a custom domain.
Inputs: domain_id (required), cluster_id (required). Returns: routes
skycloak_list_domainsBRead-onlyInspect
List the custom domains configured on a cluster.
Inputs: cluster_id (required). Returns: count, domains
skycloak_list_exportsARead-onlyInspect
List the database export jobs for a cluster, with their status and expiry.
Inputs: cluster_id (required). Returns: count, exports
skycloak_list_extensionsARead-onlyInspect
List the extension catalog available to the workspace (marketplace extensions that can be installed on a cluster).
Returns: count, extensions
skycloak_list_identity_providersARead-onlyInspect
List the identity providers (SSO connections) in a realm. Omit realm to cover every realm, and cluster_id to cover every cluster, so one call can answer an SSO question across the whole fleet.
Inputs: realm, cluster_id. Returns: count, unreachable, identity_providers
skycloak_list_identity_provider_templatesARead-onlyInspect
List the pre-configured identity-provider templates. Use a template id when creating a provider.
Returns: templates
skycloak_list_openfga_instancesARead-onlyInspect
List the OpenFGA instances bound to a cluster's realms, with each one's status (provisioning, ready, failed or deleting). Works on every plan, so a workspace that lost OpenFGA access still sees what it has.
Inputs: cluster_id (required). Returns: count, instances
skycloak_list_realm_group_membersARead-onlyInspect
List the users that belong to a realm group.
Inputs: realm (required), group_id (required), cluster_id (required). Returns: count, users
skycloak_list_realm_groupsBRead-onlyInspect
List the top-level groups in a realm.
Inputs: realm (required), cluster_id (required). Returns: count, groups
skycloak_list_realm_rolesCRead-onlyInspect
List the realm-scoped roles in a realm.
Inputs: realm (required), cluster_id (required). Returns: count, roles
skycloak_list_realmsARead-onlyInspect
List the Keycloak realms in a Skycloak cluster.
Inputs: cluster_id. Returns: count, realms, unreachable
skycloak_list_realm_usersCRead-onlyInspect
List the users in a realm.
Inputs: realm (required), cluster_id (required). Returns: count, users
skycloak_list_siem_destinationsARead-onlyInspect
List SIEM destinations configured for the workspace.
Returns: count, destinations
skycloak_list_themesARead-onlyInspect
List the custom themes uploaded to a cluster, with their IDs, status, and theme types. restart_required is true on a theme whose replaced content is not live yet; see skycloak_get_theme_settings and skycloak_restart_cluster_instances.
Inputs: cluster_id (required). Returns: count, themes
skycloak_list_user_groupsCRead-onlyInspect
List the groups a user belongs to.
Inputs: realm (required), user_id (required), cluster_id (required). Returns: count, groups
skycloak_list_user_rolesARead-onlyInspect
List the realm roles assigned to a user.
Inputs: realm (required), user_id (required), cluster_id (required). Returns: count, roles
skycloak_list_webhook_event_typesBRead-onlyInspect
List webhook event types. Optionally filter by source: platform or keycloak.
Inputs: source. Returns: count, event_types
skycloak_list_webhook_subscriptionsARead-onlyInspect
List webhook subscriptions. Optionally filter by source, cluster_id, and enabled.
Inputs: source, enabled, cluster_id. Returns: count, subscriptions
skycloak_query_eventsARead-onlyInspect
Query Keycloak user and admin events for a cluster (logins, token grants, admin operations). Filter user events with types/error, admin events with operation_types, and either with realm, start_time/end_time, and offset. Note search only matches username, client_id, realm_name and ip_address; it does not match the event type, so use types or operation_types for that. Limit is capped at 100 per call, so page with offset for anything larger.
Inputs: cluster_id (required), error, limit, order, +9 more. Returns: count, events
skycloak_remove_application_roleBDestructiveIdempotentInspect
Remove a role from an application's service account.
Inputs: realm (required), client_id (required), role_name (required), cluster_id (required), +1 more. Returns: object
skycloak_remove_cluster_captcha_domainADestructiveInspect
Remove a hostname from CAPTCHA protection on a cluster. Set confirm=true to proceed.
Inputs: confirm (required), hostname (required), cluster_id (required). Returns: object
skycloak_remove_realm_user_from_groupCDestructiveIdempotentInspect
Remove a user from a realm group.
Inputs: realm (required), user_id (required), group_id (required), cluster_id (required). Returns: object
skycloak_remove_realm_user_roleCDestructiveIdempotentInspect
Remove a realm role from a user.
Inputs: realm (required), user_id (required), role_name (required), cluster_id (required). Returns: object
skycloak_restart_cluster_instancesADestructiveInspect
Restart a cluster's Keycloak instances, disrupting live traffic on it. Use this after skycloak_update_theme_settings turns exact_theme_names on: a theme whose content was replaced under its exact name only serves the new content once Keycloak restarts (see restart_required on skycloak_get_theme / skycloak_list_themes). Applies immediately unless the workspace latches disruptive changes to the maintenance window, in which case the result reports deferred=true and, when known, next_window (RFC3339). Returns a conflict when the cluster cannot restart right now: already busy with a restart or other update, not in an available state, or the operator has no environment variable slot left. Set confirm=true to proceed.
Inputs: confirm (required), cluster_id (required). Returns: impact, deferred, next_window
skycloak_rotate_application_secretBDestructiveInspect
Regenerate an application's client secret and return the new value (shown only once).
Inputs: realm (required), client_id (required), cluster_id (required). Returns: client_secret
skycloak_set_client_theme_assignmentAIdempotentInspect
Set a client's login-theme override. Pass a theme ID, or an empty string to reset to the realm default.
Inputs: realm (required), client_id (required), cluster_id (required), login. Returns: login
skycloak_set_cluster_maintenance_windowBIdempotentInspect
Create or replace a cluster-specific maintenance window.
Inputs: enabled (required), timezone (required), end_local (required), cluster_id (required), +2 more. Returns: enabled, timezone, end_local, start_local, +1 more
skycloak_set_theme_assignmentAIdempotentInspect
Assign custom themes to a realm per Keycloak theme type. Pass a theme ID to activate it, or an empty string to reset that type to Keycloak's built-in default. Only the provided fields are changed.
Inputs: realm (required), cluster_id (required), admin, email, +2 more. Returns: admin, email, login, account
skycloak_test_identity_providerAInspect
Test connectivity to an identity provider, optionally overriding the client credentials for this test only.
Inputs: realm (required), cluster_id (required), provider_id (required), client_id, +1 more. Returns: message, success
skycloak_test_siem_destinationBInspect
Send a test event to a SIEM destination.
Inputs: destination_id (required). Returns: message, success
skycloak_test_smtpBInspect
Send a test email through a realm's configured SMTP server to verify delivery.
Inputs: email (required), realm (required), cluster_id (required). Returns: message, success
skycloak_test_webhook_subscriptionCInspect
Send a test event to a webhook subscription.
Inputs: webhook_id (required), event_type. Returns: success, delivery_id, duration_ms, attempted_at, +3 more
skycloak_uninstall_extensionADestructiveInspect
Uninstall an extension from a cluster. Set confirm=true to proceed.
Inputs: confirm (required), cluster_id (required), extension_id (required). Returns: object
skycloak_update_applicationCIdempotentInspect
Update an application's name, description, or redirect URIs.
Inputs: realm (required), client_id (required), cluster_id (required), name, +2 more. Returns: Name, Type, Status, ClientID, +1 more
skycloak_update_application_roleAIdempotentInspect
Rename an application role or change its description. Fields you omit keep their current value.
Inputs: realm (required), client_id (required), role_name (required), cluster_id (required), +2 more. Returns: id, name, client_id, composite, +2 more
skycloak_update_clusterAIdempotentInspect
Update a cluster's version (to trigger an upgrade) or size.
Inputs: cluster_id (required), size, version, auto_upgrade_enabled. Returns: ID, URL, Name, Size, +7 more
skycloak_update_cluster_securityAIdempotentInspect
Update a cluster's edge-security configuration. Only the sections you provide are changed; CAPTCHA settings are preserved. Supports IP allow-listing, rate limiting, WAF, geo-blocking, and bot management.
Inputs: cluster_id (required), waf, geo_blocking, rate_limiting, +2 more. Returns: waf, geo_blocking, rate_limiting, bot_management, +1 more
skycloak_update_domain_routeBIdempotentInspect
Update a domain route's admin access and CORS origins.
Inputs: route_id (required), domain_id (required), cluster_id (required), allow_admin_access, +1 more. Returns: id, realm, hide_realm_path, allow_admin_access
skycloak_update_extensionBIdempotentInspect
Update a custom extension's name or description.
Inputs: extension_id (required), name, description. Returns: id, name, source, version, +3 more
skycloak_update_identity_providerBIdempotentInspect
Update an identity provider's display name and enabled state.
Inputs: realm (required), cluster_id (required), provider_id (required), enabled, +1 more. Returns: Type, Enabled, ProviderID, DisplayName
skycloak_update_realmBIdempotentInspect
Update a realm's display name and enabled state.
Inputs: realm (required), cluster_id (required), enabled, display_name. Returns: id, name, enabled, display_name, +6 more
skycloak_update_realm_groupCIdempotentInspect
Rename a realm group.
Inputs: name (required), realm (required), group_id (required), cluster_id (required). Returns: id, name, path
skycloak_update_realm_roleBIdempotentInspect
Rename a realm role or change its description.
Inputs: name (required), realm (required), cluster_id (required), new_name, +1 more. Returns: name, composite, description
skycloak_update_realm_userBIdempotentInspect
Update a realm user's profile (email, name, enabled, email_verified).
Inputs: realm (required), user_id (required), cluster_id (required), email, +4 more. Returns: id, email, enabled, username, +3 more
skycloak_update_siem_destinationBIdempotentInspect
Update a SIEM destination. Only provided fields are changed; credentials remain write-only.
Inputs: destination_id (required), s3, http, name, +4 more. Returns: id, s3, http, name, +14 more
skycloak_update_themeAIdempotentInspect
Update a theme's name, description, or version. Metadata only: use skycloak_update_theme_content to replace the theme's archive.
Inputs: theme_id (required), cluster_id (required), name, version, +1 more. Returns: id, name, status, version, +3 more
skycloak_update_theme_contentADestructiveIdempotentInspect
Replace an existing theme's archive with a new one, in place. The theme keeps its ID, its name and every realm and application assignment, and the new content deploys immediately, so this is the way to edit a theme: deleting and re-uploading detaches it and leaves the sign-in page unbranded in between. Pass the ZIP or Keycloakify JAR base64-encoded in content_base64. Set confirm=true to proceed: the archive being replaced is not recoverable afterwards. The replacement must still contain every theme type the theme provides today, or the API rejects it; a theme created by a platform migration has pinned content and answers 409. When the workspace has exact_theme_names on (see skycloak_get_theme_settings), this sets restart_required=true on the theme until skycloak_restart_cluster_instances applies it.
Inputs: confirm (required), theme_id (required), cluster_id (required), content_base64 (required), +2 more. Returns: id, name, status, version, +3 more
skycloak_update_theme_settingsADestructiveIdempotentInspect
Turn the workspace's exact_theme_names policy on or off. The caller's API key must have been minted for a workspace owner or admin; any other role, including a cluster admin, gets 403 even with themes:write. Turning it on moves every existing theme in the workspace to its exact served name in the background, not blocking this call; a theme that cannot move right away (its cluster is busy updating, say) moves on its next content replace instead. Turning it off changes nothing immediately: each theme keeps its current served folder until its next content replace, after which the folder changes on every replace again. A theme replaced under its exact name sets restart_required=true on skycloak_get_theme and skycloak_list_themes until Keycloak restarts; use skycloak_restart_cluster_instances to apply it. Set confirm=true to proceed.
Inputs: confirm (required), exact_theme_names (required). Returns: exact_theme_names
skycloak_update_webhook_subscriptionCIdempotentInspect
Update a webhook subscription. Use clear_authorization_header, clear_cluster_id, or clear_realm_id to remove nullable fields.
Inputs: webhook_id (required), url, name, source, +9 more. Returns: id, url, name, source, +8 more
skycloak_upgrade_extensionAIdempotentInspect
Upgrade an installed extension to the latest available version. Asynchronous.
Inputs: cluster_id (required), extension_id (required). Returns: source, status, extension_id, extension_name, +3 more
skycloak_upsert_email_brandingAIdempotentInspect
Create or update email-template branding: color, light and dark logos, company URL and footer text. Fields you omit keep their current value.
Inputs: realm (required), cluster_id (required), company_url, footer_text, +4 more. Returns: status, primary_color, footer_company_name, header_logo_light_url
skycloak_upsert_login_brandingAIdempotentInspect
Create or update login-page branding: colors, logo, favicon, font, terms and privacy links, the registration, remember-me, forgot-password and Powered by Skycloak toggles. Fields you omit keep their current value.
Inputs: realm (required), cluster_id (required), font_url, logo_url, +9 more. Returns: status, logo_url, primary_color, background_color, +2 more
skycloak_upsert_smtpBIdempotentInspect
Create or update a realm's SMTP configuration (basic auth).
Inputs: host (required), port (required), realm (required), cluster_id (required), +5 more. Returns: host, port, status, auth_type, +4 more
skycloak_verify_domainBIdempotentInspect
Trigger DNS verification for a custom domain and return its updated status.
Inputs: domain_id (required), cluster_id (required). Returns: id, domain, is_active, subdomain, +4 more
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 141 tools
The tool set covers many distinct Keycloak resources, and most descriptions explicitly distinguish similar operations (e.g. cluster export vs realm export). However, with 141 tools there are several clusters of near-neighbors—theme metadata vs theme content vs theme assignment, cluster logs vs security logs vs event queries, and multiple role-listing tools—that an agent could easily misselect without careful reading.
Every tool uses the same skycloak_ prefix and snake_case verb_noun convention, such as skycloak_create_realm, skycloak_list_realm_users, and skycloak_delete_webhook_subscription. Verb choices vary semantically (create/update/upsert/add/remove), but the overall pattern is highly predictable.
141 tools is far beyond a practical surface for an agent, even for a broad Keycloak management platform. The domain is large, but this count creates excessive selection burden and strongly suggests many operations should be consolidated or grouped.
Coverage is extensive across clusters, realms, users, groups, roles, applications, identity providers, domains, branding, themes, extensions, webhooks, SIEM, OpenFGA, exports/imports, SMTP, security, and observability. Minor gaps remain, such as user credential/password reset operations, group-role assignment, and session revocation, but core lifecycle workflows are well represented.
Maintenance
Related MCP Connectors
An MCP server that provides an API to LLMs to manage their JumpCloud resources.
Official Microsoft MCP Server to query Microsoft Entra data using natural language
An MCP server that let you interact with Cycloid.io Internal Development Portal and Platform
Governed MCP gateway: one endpoint for your tools, with credential custody and audit log.
Related MCP Servers
AlicenseBqualityDmaintenanceMCP server for interacting with Keyshade's secrets management platform, enabling secure retrieval and management of secrets via natural language.449Mozilla Public 2.0- AlicenseNot gradedqualityBmaintenanceMCP server for Authentik identity management, enabling natural language management of users, groups, applications, flows, policies, providers, and more.116 npm16MIT
- AlicenseNot gradedqualityDmaintenanceA Model Context Protocol (MCP) server that provides a natural language interface for managing Keycloak identity and access management through its REST API.MIT
- AlicenseNot gradedqualityBmaintenanceMCP server for managing Ory Kratos identities, sessions, and authentication flows, enabling AI assistants to perform identity management tasks via natural language.13 npm1MIT