keycloak-model-context-protocol 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -17
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -11,22 +11,50 @@ A Model Context Protocol server for Keycloak administration, providing tools to
|
|
|
11
11
|
|
|
12
12
|
## Installation
|
|
13
13
|
|
|
14
|
-
###
|
|
14
|
+
### Via NPM (Recommended)
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
|
|
16
|
+
The server is available as an NPM package:
|
|
17
|
+
```bash
|
|
18
|
+
# Direct usage with npx
|
|
19
|
+
npx -y keycloak-model-context-protocol
|
|
18
20
|
|
|
19
|
-
|
|
21
|
+
# Or global installation
|
|
22
|
+
npm install -g keycloak-model-context-protocol
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Local Development Setup
|
|
26
|
+
|
|
27
|
+
If you want to develop or modify the server:
|
|
20
28
|
|
|
21
29
|
```bash
|
|
30
|
+
git clone <repository-url>
|
|
31
|
+
cd keycloak-model-context-protocol
|
|
22
32
|
npm install
|
|
23
33
|
npm run build
|
|
24
34
|
```
|
|
25
35
|
|
|
26
|
-
|
|
36
|
+
## Configuration
|
|
27
37
|
|
|
38
|
+
### Using NPM Package (Recommended)
|
|
28
39
|
Configure the server in your Claude Desktop configuration file:
|
|
29
40
|
|
|
41
|
+
```json
|
|
42
|
+
{
|
|
43
|
+
"mcpServers": {
|
|
44
|
+
"keycloak": {
|
|
45
|
+
"command": "npx",
|
|
46
|
+
"args": ["-y", "keycloak-model-context-protocol"],
|
|
47
|
+
"env": {
|
|
48
|
+
"KEYCLOAK_URL": "http://localhost:8080",
|
|
49
|
+
"KEYCLOAK_ADMIN": "admin",
|
|
50
|
+
"KEYCLOAK_ADMIN_PASSWORD": "admin"
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### For Local Development
|
|
30
58
|
```json
|
|
31
59
|
{
|
|
32
60
|
"mcpServers": {
|
|
@@ -77,17 +105,21 @@ Lists all users in a specified realm.
|
|
|
77
105
|
npm run watch
|
|
78
106
|
```
|
|
79
107
|
|
|
108
|
+
## Testing
|
|
109
|
+
|
|
110
|
+
To test the server using MCP Inspector:
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
npx -y @modelcontextprotocol/inspector npx -y keycloak-model-context-protocol
|
|
114
|
+
```
|
|
115
|
+
|
|
80
116
|
## Deployment
|
|
81
117
|
|
|
82
118
|
### NPM Package
|
|
83
119
|
|
|
84
|
-
This project is
|
|
85
|
-
|
|
86
|
-
1. The workflow automatically builds the package
|
|
87
|
-
2. Tests are run
|
|
88
|
-
3. The package is published to NPM if all checks pass
|
|
120
|
+
This project is automatically published to [NPM](https://www.npmjs.com/package/keycloak-model-context-protocol) via GitHub Actions when a new release is published on GitHub.
|
|
89
121
|
|
|
90
|
-
#### Setup Requirements
|
|
122
|
+
#### Setup Requirements for Deployment
|
|
91
123
|
|
|
92
124
|
1. Create NPM account and get access token
|
|
93
125
|
2. Add NPM_TOKEN secret to GitHub repository
|
|
@@ -95,10 +127,7 @@ This project is set up for automated deployment to NPM via GitHub Actions. When
|
|
|
95
127
|
- Add new secret named `NPM_TOKEN`
|
|
96
128
|
- Paste your NPM access token as the value
|
|
97
129
|
|
|
98
|
-
|
|
130
|
+
## Prerequisites
|
|
99
131
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
```bash
|
|
103
|
-
npm install -g keycloak-model-context-protocol
|
|
104
|
-
```
|
|
132
|
+
- Node.js 18 or higher
|
|
133
|
+
- Running Keycloak instance
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "keycloak-model-context-protocol",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2",
|
|
4
4
|
"description": "MCP server for Keycloak administration",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Christoph Englisch",
|
|
7
7
|
"type": "module",
|
|
8
8
|
"bin": {
|
|
9
|
-
"
|
|
9
|
+
"keycloak-model-context-protocol": "./dist/index.js"
|
|
10
10
|
},
|
|
11
11
|
"files": [
|
|
12
12
|
"dist"
|