Skip to content

tide-foundation/keycloak-skills

Repository files navigation

keycloak-skills

Reference skills for AI coding agents working on Keycloak — schema, SPIs, extensions, deployment. Each skill is a self-contained markdown file that an agent loads into context on demand.

Built and maintained by the Tide Foundation.

Skills

Skill Covers Verified against
keycloak-entities JPA entities, schema, JPQL, Liquibase changelogs, ~90 tables, FK cascades, federated user tables, UMA Authorization Services Keycloak 26.5.5
keycloak-token-construction OIDC token construction — scope resolution, mapper-set assembly, base claims, per-surface mapper pipeline, post-mapper transforms (audience restriction); ships eight (request, log, token) fixtures Keycloak 26.5.5
keycloak-token-fixture-build Methodology for adversarial regression fixtures targeting keycloak-token-construction; two-phase fresh-context predictor harness; verdict rubric; corpus lives in tests/token-construction/ Keycloak 26.5.5

More skills planned: SPI development, Admin REST API, themes, deployment, testing, OIDC/SAML protocols, admin UI extension.

Use with Claude.ai

In Claude.ai, go to Settings → Capabilities → Skills → Upload skill, then upload the skill folder as a .zip.

git clone https://github.com/tide-foundation/keycloak-skills.git
cd keycloak-skills/skills
zip -r keycloak-entities.zip keycloak-entities
# upload keycloak-entities.zip via the Claude.ai UI

Workspace admins can deploy skills organization-wide via the same surface.

Use with Claude Code

Clone and symlink each skill into your Claude Code skills directory:

git clone https://github.com/tide-foundation/keycloak-skills.git ~/keycloak-skills
mkdir -p ~/.claude/skills
ln -s ~/keycloak-skills/skills/keycloak-entities ~/.claude/skills/keycloak-entities

Claude Code picks up the skill on next launch and routes to it when your task matches the skill's description.

For project-scoped install (only available inside one repo):

mkdir -p .claude/skills
ln -s ~/keycloak-skills/skills/keycloak-entities .claude/skills/keycloak-entities

Use with the Claude API

Skills are first-class on the Messages API. Manage them via the /v1/skills endpoint and attach via the container.skills parameter on a Messages request. Requires the Code Execution Tool beta. See Anthropic's Skills API Quickstart.

If you'd rather not use the skills API, paste the relevant SKILL.md (and any references/*.md its auto-routing points to) directly into your agent's system prompt.

Use with Cursor / Codex / Aider / other AGENTS.md-aware tools

These tools have no native skill loader, but they read markdown context. Either:

  • Copy the skill content into your tool's rules file (e.g. .cursor/rules/keycloak-entities.md), or
  • Reference the file path in your prompt and let the tool read it on demand.

Versioning

Each skill declares the exact Keycloak version it was verified against, in both its frontmatter description and its body. If you are running a different Keycloak version, treat the skill as advisory and re-verify against your own source — Keycloak's data model and SPIs change meaningfully across versions.

Contributing

See CONTRIBUTING.md for how to add a new skill, and AGENTS.md for the writing and verification rules. Skills must be verified against actual Keycloak source, not web docs.

A starter scaffold lives at skills/_template/SKILL.md.

License

MIT.

About

Low level Keycloak skills to develop SPIs using agents.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages