Skip to main content
Glama

skycloak_create_webhook_subscription

Create a webhook subscription that delivers Keycloak or platform events to a URL using a signing secret and optional authorization header for verified, authenticated delivery.

Instructions

Create a webhook subscription. Signing secrets and authorization headers are write-only.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>",
      "url": "<url>",
      "source": "<source>",
      "event_types": "<event_types>",
      "signing_secret": "<signing_secret>"
    },
    "name": "skycloak_create_webhook_subscription"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlYes
nameYes
sourceYesevent source: keycloak or platform (case-insensitive)
enabledNo
realm_idNo
cluster_idNo
event_typesYes
signing_secretYes
authorization_headerNo

Output Schema

NameRequiredDescriptionDefault
idYes
urlYes
nameYes
sourceYes
enabledYes
realm_idNo
cluster_idNo
created_atYes
updated_atYes
event_typesYes
has_signing_secretYes
has_authorization_headerYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare this is a non-destructive, non-idempotent write, so the safety profile is covered. The description adds one genuinely useful behavioral fact beyond them: signing secrets and authorization headers are write-only, meaning they are accepted but never returned. It says nothing about authentication requirements, whether duplicate subscriptions are allowed, or what happens if the URL is unreachable.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with the action and followed by the one non-obvious constraint. No filler, though the brevity reflects under-specification as much as economy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a create tool with 9 parameters, 5 required, and near-zero schema coverage, the description is thin: it never explains the required-field set, the event_types format, or the realm/cluster scoping. An output schema exists so return values need not be described, which keeps this from being a larger gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 11% (only 'source' is documented), so the description carries the burden but does almost none of it. The write-only note implicitly explains signing_secret and authorization_header, but name, url, realm_id, cluster_id, enabled, and event_types remain undefined, including whether realm_id and cluster_id are mutually exclusive.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Create a webhook subscription" states a specific verb and resource, which cleanly separates it from the delete/get/list/update webhook siblings. It stops short of naming those siblings or the conditions that select them, so it is clear but not fully differentiated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance, no mention of prerequisites such as needing a realm or cluster context first, and no pointer to skycloak_list_webhook_event_types for valid event_types. The agent must infer all of this from the name and schema.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools