Skip to main content
Glama
Sign In
mcp-keycloak

mcp-keycloak

by idoyudha
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

list_client_roles

Retrieve a list of roles assigned to a specific client in Keycloak. Use pagination and search filters to narrow results.

Instructions

List roles for a specific client.

Args:
    client_id: Client database ID
    first: Pagination offset
    max: Maximum results size
    search: Search string
    realm: Target realm (uses default if not specified)

Returns:
    List of client roles

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": {
      "client_id": "<client_id>"
    },
    "name": "list_client_roles"
  }
}

Input Schema

NameRequiredDescriptionDefault
client_idYes
firstNo
maxNo
searchNo
realmNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior2/5

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

No annotations provided, and description only mentions 'Returns: List of client roles' without disclosing pagination behavior, ordering, or side effects. Implicitly read-only, but not explicit.

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?

Description is concise with a clear docstring structure (Args/Returns). The main sentence is direct, and parameter descriptions are efficient, though some repetition exists with the schema.

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?

Given the output schema exists, the description adequately covers the tool's purpose and parameters. Missing error conditions or prerequisites, but for a list operation this is acceptable.

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 0%, so burden is on description. It provides basic meanings for each parameter (e.g., 'Pagination offset', 'Search string'), but lacks examples, constraints, or format details.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states 'List roles for a specific client', specifying the verb (list) and resource (roles), which distinguishes it from sibling tools like create_client_role or list_realm_roles.

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 tool vs alternatives such as list_realm_roles or search tools; no context on prerequisites or when not to use.

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