You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/deployment/private-cloud/private-cloud-api-mcp.md
+52-34Lines changed: 52 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ weight: 100
12
12
For example, you can ask the AI assistant to list your apps, deploy the latest package to an acceptance environment, or stop a production environment, without writing `curl` commands or navigating the Mendix on Kubernetes Portal.
13
13
14
14
{{% alert color="warning" %}}
15
-
The use of AI tools is non-deterministic, outputs may vary between runs. AI Assistants/Agents will have permissions based on what the Personal Access Token (PAT) have access to. Carefully review and limit the scope of credentials before use.
15
+
The use of AI tools is non-deterministic, outputs may vary between runs. AI assistants (agents) are assigned permissions based on the access rights of the Personal Access Token (PAT). Carefully review and limit the scope of credentials before use.
16
16
{{% /alert %}}
17
17
18
18
## Prerequisites
@@ -26,45 +26,54 @@ Before you start, make sure you have the following:
26
26
27
27
## Connecting Your AI Assistant {#connecting}
28
28
29
+
Refer to the following sections for information about connecting your agent.
30
+
29
31
### Claude Code {#claude-code}
30
32
31
-
To add the Mendix MCP server in Claude Code, run the following command in your terminal:
33
+
To add the Mendix MCP server in Claude Code, perform the following steps:
32
34
33
-
```bash
34
-
claude mcp add --scope user --transport http mendix-cloud-mcp-private \
35
-
https://mcp.home.mendix.com/private \
36
-
--header "Authorization: MxToken {GENERATED_PAT}"
37
-
```
35
+
1. Run the following command in your terminal:
38
36
39
-
Replace the following placeholders with your credentials:
37
+
```bash
38
+
claude mcp add --scope user --transport http mendix-cloud-mcp-private \
39
+
https://mcp.home.mendix.com/private \
40
+
--header "Authorization: MxToken {GENERATED_PAT}"
41
+
```
40
42
41
-
*`{GENERATED_PAT}` – the generated Mendix Personal Access Token (PAT)
43
+
2. Replace the following placeholders with your credentials:
42
44
45
+
*`{GENERATED_PAT}` - Replace with the generated Mendix Personal Access Token (PAT)
43
46
44
-
To verify the connection, run the following command:
47
+
3. Verify the connection by running the following command:
45
48
46
-
```bash
47
-
claude mcp get mendix-cloud-mcp-private
48
-
```
49
+
```bash
50
+
claude mcp get mendix-cloud-mcp-private
51
+
```
52
+
53
+
A successful connection displays output similar to the following:
49
54
50
-
A successful connection displays output similar to the following:
55
+
```bash
56
+
claude mcp get mendix-cloud-mcp-private
57
+
mendix-cloud-mcp-private:
58
+
Scope: User config (available in all your projects)
59
+
Status: ✔ Connected
60
+
Type: http
61
+
URL: https://mcp.home.mendix.com/private
62
+
Headers:
63
+
Authorization: MxToken {GENERATED_PAT}
64
+
```
65
+
66
+
4. To remove this server, run the following command:
51
67
52
68
```bash
53
-
claude mcp get mendix-cloud-mcp-private
54
-
mendix-cloud-mcp-private:
55
-
Scope: User config (available in all your projects)
56
-
Status: ✔ Connected
57
-
Type: http
58
-
URL: https://mcp.home.mendix.com/private
59
-
Headers:
60
-
Authorization: MxToken {GENERATED_PAT}
61
-
62
-
To remove this server, run: claude mcp remove mendix-cloud-mcp -s user
69
+
claude mcp remove mendix-cloud-mcp -s user
63
70
```
64
71
65
72
### VS Code with GitHub Copilot {#vs-code}
66
73
67
-
To add the Mendix on Kubernetes MCP server in VS Code, add the following configuration to your `.vscode/settings.json` file or your VS Code user settings:
74
+
To add the Mendix on Kubernetes MCP server in VS Code, perform the following steps:
75
+
76
+
1. Add the following configuration to your `.vscode/settings.json` file or your VS Code user settings:
68
77
69
78
```json
70
79
{
@@ -82,7 +91,7 @@ To add the Mendix on Kubernetes MCP server in VS Code, add the following configu
82
91
}
83
92
```
84
93
85
-
Replace the placeholder values with your credentials as described in the [Claude Code](#claude-code) section above.
94
+
2. Replace the placeholder values with your credentials as described in the [Claude Code](#claude-code) section above.
86
95
87
96
## Available Capabilities {#capabilities}
88
97
@@ -137,7 +146,6 @@ Two authentication methods are used depending on the API:
137
146
Include all three headers in your connection configuration to ensure all tools work correctly.
138
147
{{% /alert %}}
139
148
140
-
141
149
## Client Compatibility {#compatibility}
142
150
143
151
The Mendix on Kubernetes MCP integration works with any MCP-compatible client that supports HTTP transport (streamable HTTP) and custom headers for authentication.
@@ -150,17 +158,25 @@ Clients that only support OAuth 2.0 authentication without custom header support
150
158
151
159
The following limitations apply:
152
160
153
-
| Limitation | Details |
154
-
| --- | --- |
155
-
| File uploads not supported | The MCP gateway does not support `application/octet-stream` content types. APIs that require binary file upload, such as uploading a deployment package, are not supported. Use the Mendix Portal or the Mendix CLI instead. |
156
-
| Rate limiting | Requests are limited to 60 per minute. High-volume automated workflows may exceed this limit. |
157
-
| OAuth-only clients | Clients that exclusively use OAuth 2.0 for MCP authentication cannot connect. |
161
+
### File Uploads Not Supported
162
+
163
+
The MCP gateway does not support `application/octet-stream` content types. APIs that require binary file upload, such as uploading a deployment package, are not supported. Use the Mendix Portal or the Mendix CLI instead.
164
+
165
+
### Rate Limiting
166
+
167
+
Requests are limited to 60 per minute. High-volume automated workflows may exceed this limit.
168
+
169
+
### OAuth-only Clients
170
+
171
+
Clients that exclusively use OAuth 2.0 for MCP authentication cannot connect.
158
172
159
173
## Troubleshooting {#troubleshooting}
160
174
161
175
### Connection Fails or Times Out
162
176
163
-
* Make sure the URL is exactly `https://mcp.home.mendix.com/private`
177
+
In case of connection failures or time outs, verify the following:
178
+
179
+
* Make sure the URL is exactly `https://mcp.home.mendix.com/private.
164
180
* Verify that your JSON configuration uses `"type": "http"` and not `"transport": "http"`.
0 commit comments