keycloak-mcp: Instructions file for GitHub Copilot

.github/copilot-instructions.md

keycloak-mcp copilot-instructions.md is an instructions file for GitHub Copilot from shigechika/keycloak-mcp. It costs 1,935 tokens per session, scanned A, original, MIT.

Repository guidance for keycloak-mcp, an MCP server that exposes Keycloak’s administration API to AI assistants. Keycloak is software for managing users, login sessions, security settings, and access to applications.

In plain words
What is it for?
Use it when building or reviewing changes to the keycloak-mcp Python server. It is particularly useful for work involving authentication, API requests, server tools, and test validation.
Why use it?
It gives an assistant the project context needed to review changes accurately. It also identifies the authentication, API-client, server, testing, and standard-output rules that matter in this codebase.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: mentions CLAUDE.md.

This is shigechika/keycloak-mcp's own configuration. It tells GitHub Copilot how to work on keycloak-mcp itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything keycloak-mcp configures →

Reuse

Borrowing it

Nothing to install: this file belongs to shigechika/keycloak-mcp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/shigechika/keycloak-mcp/main/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/shigechika/keycloak-mcp

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for keycloak-mcp copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/shigechika/keycloak-mcp/copilot-instructions/github.svg)](https://agentmods.dev/instructions/shigechika/keycloak-mcp/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/shigechika/keycloak-mcp/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/shigechika/keycloak-mcp/copilot-instructions/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for keycloak-mcp copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/shigechika/keycloak-mcp/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/shigechika/keycloak-mcp/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,935 This file is loaded in full into every session.
When invoked 1,935 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01935 $0.01935
Opus 5.5 $0.00774 $0.00774
Sonnet 5.5 $0.00387 $0.00387
Haiku 4.5 $0.00194 $0.00194

Measured 28d ago against content hash 6628c11ccc7e, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

keycloak-mcp copilot-instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 28d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/copilot-instructions.md · 145 lines

How it starts

The opening of the file, as written. The whole thing — 145 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Repository overview

keycloak-mcp is an MCP (Model Context Protocol) server exposing the KeyCloak Admin REST API — users, sessions, events, security settings — to AI assistants over stdio transport. It authenticates as a Service Account (Client Credentials Grant, keycloak_mcp/auth.py) and talks to the Admin API via KeyCloakClient (keycloak_mcp/client.py). Built on the official mcp Python SDK's MCPServer (2.x, keycloak_mcp/server.py).

See CLAUDE.md for the authoritative command list and architecture notes — read it before reviewing changes to client.py, auth.py, or server.py.

Build & validate

uv sync --dev
uv run ruff check .
uv run ruff format --check .
uv run pytest -v

This mirrors .github/workflows/ci.yml: a lint job (ruff check + format check) and a test job matrixed over Python 3.10–3.14 on Ubuntu, plus one Windows 3.12 job specifically to catch stdio newline regressions (modelcontextprotocol/python-sdk#2433). Ruff does run in CI here — don't hand-flag formatting/import-order issues it already enforces; focus review comments on things CI can't catch.

What to focus review on in this repo

1. This is a stdio MCP server — stdout is a JSON-RPC channel, not a log

Any print() or library logging that writes to stdout instead of stderr corrupts the protocol stream for the connected client. The existing convention in server.py and __main__.py is to route diagnostics to stderr explicitly (print(..., file=sys.stderr)) in tool error paths (reset_passwords_batch, get_totp_users, daily_brief). The one exception is __main__.py's _check_config(), which prints a plain confirmation line to stdout on --check — that path calls sys.exit() before mcp.run() ever starts, so it never shares the stream with JSON-RPC traffic. Flag any new code path that writes to stdout on the mcp.run(transport="stdio") side, or that lets a dependency's default logging config leak through.

2. MCPServer already wraps tool returns — don't ask for manual envelope code

Read the full file on GitHub · 145 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 28d ago Changed · +3 tokens per session 6628c11ccc7e
  2. 1mo ago First seen · 145 lines · 1,932 tokens per session scan A 19d188a0701c

Subscribe to this mod's changes

keycloak-mcp copilot-instructions.md is an instructions file published in the GitHub repository shigechika/keycloak-mcp (0 stars, last pushed yesterday), licensed MIT. It adds 1,935 tokens to every session, about $0.0077 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,461 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens