list_clients

Retrieve and filter client details in a Keycloak realm by ID, visibility, or pagination. Use offsets and limits to manage large datasets efficiently.

Instructions

List clients in the realm.

Args:
    client_id: Filter by client ID (partial match)
    viewable_only: Only return viewable clients
    first: Pagination offset
    max: Maximum results size
    realm: Target realm (uses default if not specified)

Returns:
    List of client objects

Input Schema

Name	Required	Description	Default
`client_id`	No
`first`	No
`max`	No
`realm`	No
`viewable_only`	No

Input Schema (JSON Schema)

{
  "properties": {
    "client_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Client Id"
    },
    "first": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "First"
    },
    "max": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Max"
    },
    "realm": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Realm"
    },
    "viewable_only": {
      "default": false,
      "title": "Viewable Only",
      "type": "boolean"
    }
  },
  "title": "list_clientsArguments",
  "type": "object"
}

mcp-keycloak

list_clients

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from mcp-keycloak

Related Tools

MCP directory API