mcp-keycloak

Instructions

Create a new realm role.

Args:
    name: Role name
    description: Role description
    composite: Whether this is a composite role
    client_role: Whether this is a client role
    realm: Target realm (uses default if not specified)

Returns:
    Status message

Implementation Reference

• src/tools/role_tools.py:54-81 (handler)

  The main handler function for the 'create_realm_role' tool. It uses the KeycloakClient to POST a new role to the /roles endpoint, decorated with @mcp.tool() for registration.

  @mcp.tool()
  async def create_realm_role(
      name: str,
      description: Optional[str] = None,
      composite: bool = False,
      client_role: bool = False,
      realm: Optional[str] = None,
  ) -> Dict[str, str]:
      """
      Create a new realm role.
  
      Args:
          name: Role name
          description: Role description
          composite: Whether this is a composite role
          client_role: Whether this is a client role
          realm: Target realm (uses default if not specified)
  
      Returns:
          Status message
      """
      role_data = {"name": name, "composite": composite, "clientRole": client_role}
  
      if description:
          role_data["description"] = description
  
      await client._make_request("POST", "/roles", data=role_data, realm=realm)
      return {"status": "created", "message": f"Realm role {name} created successfully"}