Skip to main content
Glama

skycloak_export_cluster_events

Export a cluster's events as a document and return its contents for audits, troubleshooting, or retention.

Instructions

Export a cluster's events as a document and return its contents.

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

Input Schema

NameRequiredDescriptionDefault
cluster_idYesthe cluster ID

Output Schema

NameRequiredDescriptionDefault
documentYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare the safety profile (destructiveHint=false, openWorldHint=false) but also readOnlyHint=false and idempotentHint=false, which is notable for something framed as an export. The description adds that contents are returned directly, but never says whether an export artifact is persisted, what document format is produced, or what size/rate constraints apply — the very question raised by the non-read-only, non-idempotent hints.

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

Conciseness5/5

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

A single front-loaded sentence that states action, resource, and result with zero filler. Nothing in it needs to be cut or reordered.

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?

An output schema exists, so return values need not be explained. However, for a non-read-only, non-idempotent export tool, the description leaves open whether a document is created server-side and what format the caller receives, which is material to correct invocation.

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?

Only one parameter (cluster_id) exists and schema description coverage is 100%, so the schema already carries the parameter meaning. The description adds nothing about the cluster_id (e.g., where to obtain it or accepted formats), which is acceptable given the coverage but not value-adding.

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 gives a specific verb and resource ("Export a cluster's events") plus the immediate outcome ("return its contents"), which lets an agent distinguish it from skycloak_query_events. It does not name or differentiate itself from the export-related siblings (create_export, get_export), so it stops short of a 5.

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 explicit when-to-use or when-not-to-use guidance, and no reference to alternatives such as skycloak_query_events for reading events or skycloak_create_export/get_export for persisted exports. The phrase "return its contents" only implicitly signals a synchronous, one-shot export rather than a stored artifact.

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