Skip to main content
Glama

skycloak_update_webhook_subscription

Idempotent

Update a webhook subscription by changing its URL, name, source, enabled state, event types, or signing details, and remove nullable fields using clear flags.

Instructions

Update a webhook subscription. Use clear_authorization_header, clear_cluster_id, or clear_realm_id to remove nullable fields.

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": {
      "webhook_id": "<webhook_id>"
    },
    "name": "skycloak_update_webhook_subscription"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlNo
nameNo
sourceNonew event source: keycloak or platform (case-insensitive)
enabledNo
realm_idNo
cluster_idNo
webhook_idYesthe webhook subscription ID
event_typesNo
clear_realm_idNo
signing_secretNo
clear_cluster_idNo
authorization_headerNo
clear_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

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, and destructiveHint=false. The description adds real value by explaining the clear_* flags as the mechanism for removing nullable fields, but it omits the crucial partial-update semantics (whether null/omitted fields preserve or erase existing values) and any authorization requirements.

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 short sentences with no wasted words, and the null-clearing hint is useful and front-loaded after the purpose statement. Brevity here borders on under-specification given the tool's complexity, but nothing is redundant.

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

Completeness2/5

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

For a 13-parameter update tool where every field is nullable, the description must clarify how nulls and clear_* flags interact with existing values, and it does not. Output schema existence excuses return-value explanation, but the update-semantics gap is significant.

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 15% across 13 parameters, so the description must compensate, yet it only explains three clear_* flags. It says nothing about url, name, enabled, event_types, signing_secret, authorization_header, or the general null-vs-clear pairing that dominates the schema.

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?

States a specific verb and resource ("Update a webhook subscription"), so the operation is unambiguous. It does not differentiate from siblings like skycloak_create_webhook_subscription or skycloak_get_webhook_subscription, leaving the agent to rely on the name alone.

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?

No guidance on when to use this versus create/delete/get/test siblings, and no mention of prerequisites such as the subscription needing to exist or which fields can be updated after creation. Usage is only implied by the verb "Update".

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