keycloak-model-context-protocol 1.0.1 → 1.0.3

package/README.md

@@ -22,53 +22,13 @@ A [Model Context Protocol](https://modelcontextprotocol.io) (MCP) server for **K
 
 Your MCP client starts the server as a local child process and talks to it over stdio. Every tool call passes the guards, then goes through a single gateway that owns the Keycloak login and caches the access token.
 
-```mermaid
-flowchart LR
-    subgraph Host["Your machine"]
-        Client["MCP client<br/>(Claude Desktop, Claude Code,<br/>VS Code, Cursor, ...)"]
-        subgraph Server["keycloak-model-context-protocol (Node.js)"]
-            Guards["Guards<br/>read-only, realm allowlist,<br/>master protection, confirmation"]
-            Toolsets["Toolsets, prompts, resources<br/>core, groups, roles, clients,<br/>sessions, events, security"]
-            Gateway["Gateway<br/>login and token cache"]
-            Guards --> Toolsets --> Gateway
-        end
-        Client <-->|"JSON-RPC over stdio"| Guards
-    end
-
-    subgraph KC["Keycloak"]
-        Token["Token endpoint"]
-        Admin["Admin REST API<br/>/admin/realms/..."]
-    end
-
-    Gateway -->|"client_credentials or password grant"| Token
-    Gateway -->|"Bearer token"| Admin
-```
+![Architecture: the MCP client talks JSON-RPC over stdio to the server, whose guards, toolsets and gateway call the Keycloak token endpoint and Admin REST API](https://raw.githubusercontent.com/ChristophEnglisch/keycloak-model-context-protocol/main/docs/diagrams/architecture.svg)
 
 ### What a destructive call looks like
 
 A destructive tool never acts on the first call. It returns a preview of what would happen and changes nothing. Only after you approve does the assistant repeat the call with `confirm: true`.
 
-```mermaid
-sequenceDiagram
-    autonumber
-    actor User
-    participant LLM as MCP client / LLM
-    participant MCP as Keycloak MCP server
-    participant KC as Keycloak
-
-    User->>LLM: "Delete user bob from realm demo"
-    LLM->>MCP: user_delete (realm, userId)
-    MCP->>KC: GET user (for the preview)
-    KC-->>MCP: user data
-    MCP-->>LLM: isError, "Confirmation required. This would: permanently delete user bob ... Nothing was changed."
-    LLM->>User: "This will permanently delete bob. Proceed?"
-    User->>LLM: "Yes"
-    LLM->>MCP: user_delete (realm, userId, confirm: true)
-    MCP->>KC: DELETE user
-    KC-->>MCP: 204 No Content
-    MCP-->>LLM: deleted: true
-    LLM-->>User: "User bob was deleted."
-```
+![Sequence of a destructive call: the first user_delete call returns a preview and changes nothing, the repeated call with confirm: true deletes the user](https://raw.githubusercontent.com/ChristophEnglisch/keycloak-model-context-protocol/main/docs/diagrams/destructive-call.svg)
 
 ## Quick start
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keycloak-model-context-protocol",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "MCP server for Keycloak administration",
   "mcpName": "io.github.ChristophEnglisch/keycloak-model-context-protocol",
   "license": "MIT",
@@ -45,7 +45,9 @@
     "test:smoke": "npm run build && node tests/smoke/pack-smoke.mjs",
     "test:all": "npm test && npm run test:integration && npm run test:smoke",
     "docs:tools": "npm run build && node scripts/generate-tools-reference.mjs",
-    "docs:check": "npm run build && node scripts/generate-tools-reference.mjs --check"
+    "docs:check": "npm run build && node scripts/generate-tools-reference.mjs --check",
+    "docs:diagrams": "node scripts/render-diagrams.mjs",
+    "docs:diagrams:check": "node scripts/render-diagrams.mjs --check"
   },
   "dependencies": {
     "@keycloak/keycloak-admin-client": "^26.8.1",
@@ -53,7 +55,7 @@
     "zod": "^4.6.7"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.6.2",
+    "@biomejs/biome": "^2.6.3",
     "@modelcontextprotocol/client": "^2.4.0",
     "@types/node": "^22.20.5",
     "@vitest/coverage-v8": "^5.0.5",