Skip to main content
Glama

skycloak_get_cluster_insights

Read-only

Retrieve a cluster’s analytics as JSON for overview, authentication, events, performance, or security insights by cluster ID. Use it to inspect Keycloak cluster health and activity.

Instructions

Get cluster analytics as a JSON document. type is one of: overview, authentication, events, performance, security.

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": {
      "cluster_id": "<cluster_id>"
    },
    "name": "skycloak_get_cluster_insights"
  }
}

Input Schema

NameRequiredDescriptionDefault
typeNoinsight document: overview, authentication, events, performance, or security (case-insensitive); defaults to overview
cluster_idYesthe cluster ID

Output Schema

NameRequiredDescriptionDefault
jsonYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/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 without the description's help. The description contributes that the payload is a JSON document and which document kinds exist, but says nothing about size, freshness, or what happens when a category has no data. That is acceptable given the existing output schema, but it is not rich context.

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 the core purpose front-loaded before the type list. The one inefficiency is that the type enumeration duplicates the schema's own enum-style description, spending words on information the agent already has.

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?

With an output schema, full parameter coverage, and read-only annotations, most of the burden is carried elsewhere and the description is sufficient to invoke the tool correctly. The remaining gap is routing: nothing tells an agent whether the 'security' type here duplicates or complements skycloak_get_cluster_security.

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%, so both parameters are already fully documented, including the case-insensitive default of 'overview'. The description's enumeration of the same five type values largely restates the schema rather than adding meaning, which is the baseline-3 case for high coverage.

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 cluster analytics as a JSON document') and enumerates the insight categories, so an agent knows exactly what comes back. It stops short of distinguishing this tool from close siblings such as skycloak_get_cluster_security, whose 'security' insight overlaps with the 'security' type offered here.

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

Usage Guidelines3/5

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

Usage is only implied by the verb and the list of insight types; there is no statement of when to prefer this over skycloak_get_cluster or skycloak_get_cluster_security, and no prerequisites or exclusions. An agent can infer it is the analytics aggregator, but must guess at the boundary with sibling tools.

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