@kentico/management-api-mcp 30.12.2-preview → 31.0.0-preview
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 +57 -7
- package/dist/index.js +1692 -382
- package/package.json +53 -28
package/README.md
CHANGED
|
@@ -1,12 +1,62 @@
|
|
|
1
|
-
# Xperience by Kentico
|
|
1
|
+
# Xperience by Kentico ManagementApiMcp
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Model Context Protocol (MCP) server for managing data in Xperience by Kentico.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Development
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
[Content type management API](https://docs.kentico.com/x/management_api_xp)
|
|
7
|
+
To develop the ManagementApiMcp
|
|
9
8
|
|
|
10
|
-
|
|
9
|
+
1. Run the `npm install` to install packages
|
|
10
|
+
2. Run the `npm run dev` to start watcher that will rebuild the mcp on any change.
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
To run the development Management API MCP in cursor/vscode/etc:
|
|
13
|
+
1. Run `npm run dev` or `npm run build` at least once
|
|
14
|
+
2. Add Kentico.Xperience.ManagementApi integration package to the DancingGoat and call `AddKenticoManagementApi()` / `UseKenticoManagementApi()`. Specify 32char length secret.
|
|
15
|
+
3. Run the DancingGoat
|
|
16
|
+
4. Update the `./mcp-config.json` to include correct secret and run `npm run debug`.
|
|
17
|
+
5. Otherwise, you can add the following config to vscode/cursor/etc.:
|
|
18
|
+
|
|
19
|
+
```json
|
|
20
|
+
{
|
|
21
|
+
"mcpServers": {
|
|
22
|
+
"xperience": {
|
|
23
|
+
"type": "stdio",
|
|
24
|
+
"command": "node",
|
|
25
|
+
"args": ["C:\\CMS\\XbK\\CMSSolution\\Integrations\\Kentico.Xperience.ManagementApiMcp\\dist\\index.js"],
|
|
26
|
+
"env": {
|
|
27
|
+
"NODE_OPTIONS": "--use-system-ca",
|
|
28
|
+
"CACHE_OPENAPI": "false",
|
|
29
|
+
"MANAGEMENT_API_URL": "https://localhost:5001/kentico-api/management",
|
|
30
|
+
"MANAGEMENT_API_SECRET": "<your-32+char-secret>"
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Or prettier one if you execute `npm link`:
|
|
38
|
+
|
|
39
|
+
```json
|
|
40
|
+
{
|
|
41
|
+
"mcpServers": {
|
|
42
|
+
"xperience": {
|
|
43
|
+
"type": "stdio",
|
|
44
|
+
"command": "xperience-mcp",
|
|
45
|
+
"env": {
|
|
46
|
+
"NODE_OPTIONS": "--use-system-ca",
|
|
47
|
+
"CACHE_OPENAPI": "false",
|
|
48
|
+
"MANAGEMENT_API_URL": "https://localhost:5001/kentico-api/management",
|
|
49
|
+
"MANAGEMENT_API_SECRET": "<your-32+char-secret>"
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Custom environment variables
|
|
57
|
+
|
|
58
|
+
The following environment variables are used:
|
|
59
|
+
|
|
60
|
+
- `MANAGEMENT_API_URL` - path to the Management API endpoint
|
|
61
|
+
- `MANAGEMENT_API_SECRET` - required, secret used for Authorization header when calling the Management API (must be at least 32 characters)
|
|
62
|
+
- `CACHE_OPENAPI` - optional, can disable caching of OpenAPI spec for development purposes.
|