Skip to main content
Glama

skycloak_get_webhook_subscription

Read-only

Retrieve a webhook subscription by its ID to inspect Skycloak webhook configuration and verify endpoint details.

Instructions

Get a webhook subscription by ID.

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_get_webhook_subscription"
  }
}

Input Schema

NameRequiredDescriptionDefault
webhook_idYesthe webhook subscription ID

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.1/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds nothing beyond that – no note on what happens when the ID does not exist, no mention of the idempotentHint=false flag, and no behavioral context at all beyond the one-line purpose. It does not contradict the annotations.

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?

A single short sentence that is front-loaded and contains no filler. It is arguably under-specified rather than bloated, but nothing needs trimming.

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

Completeness4/5

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

An output schema exists, annotations declare the read-only safety profile, and the lone parameter is fully described in the schema. For a simple single-ID lookup this is close to sufficient; only the missing guidance on lookup failure or sibling selection keeps it from being complete.

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

Parameters3/5

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

Schema description coverage is 100% for the single webhook_id parameter, so the schema fully documents the input. The description only repeats the same information ('by ID') and adds no format, validation, or sourcing guidance for the ID. Baseline 3 applies when the schema carries the parameter burden.

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?

The description states a specific verb and resource (get a webhook subscription) and qualifies it with 'by ID', which implicitly separates it from list_webhook_subscriptions and the create/update/delete siblings. It stops short of naming any sibling explicitly, 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 statement of when to use this tool versus skycloak_list_webhook_subscriptions or any other sibling, and no prerequisites or error conditions are given. The only usage signal an agent can infer is that a known ID is required, which comes from the name and schema rather than the description.

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