Skip to main content
Glama

skycloak_get_application_role

Read-only

Retrieves a single application role, including its description and Keycloak identifiers, using cluster ID, realm, client ID, and role name.

Instructions

Get one role defined on an application, with its description and Keycloak identifiers.

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>",
      "realm": "<realm>",
      "client_id": "<client_id>",
      "role_name": "<role_name>"
    },
    "name": "skycloak_get_application_role"
  }
}

Input Schema

NameRequiredDescriptionDefault
realmYesthe Keycloak realm name
client_idYesthe application's OAuth client ID
role_nameYesthe role name
cluster_idYesthe cluster ID

Output Schema

NameRequiredDescriptionDefault
idNo
nameYes
client_idYes
compositeYes
client_uuidNo
descriptionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/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 agent knows this is a safe, non-external read; the description's added value is telling the caller what comes back (role description plus Keycloak identifiers). It says nothing about error behavior when the role or client does not exist, and notably the idempotentHint=false annotation on a pure read is unexplained, which an agent may find confusing.

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 sentence with the resource scoping ('defined on an application') front-loaded and no filler. Every clause earns its place by naming either the target or the returned fields.

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, so return structure need not be described, and all four parameters are fully documented in the schema. For a simple single-entity read this is close to complete; the only shortfall is the absence of any routing guidance among the many role-related siblings.

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%, with each of the four required parameters documented in the schema itself (realm, client_id, role_name, cluster_id). The description adds no format hints, naming conventions, or constraints beyond that, so the baseline 3 applies.

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: 'Get one role defined on an application.' The phrase 'defined on an application' implicitly separates it from realm-role siblings, and it names the payload returned (description and Keycloak identifiers). It does not explicitly call out the contrast with skycloak_get_realm_role or skycloak_list_application_roles, 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 Guidelines3/5

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

The singular 'one role' implies a lookup-by-identity operation rather than enumeration, which lets an agent infer it should be used when the role name is already known. However, there is no explicit when-to-use statement, no mention of skycloak_list_application_roles as the alternative for discovery, and no prerequisites such as required permissions.

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