Skip to content

Commit e065ad2

Browse files
Update private-cloud-api-mcp.md
1 parent d3f28fd commit e065ad2

1 file changed

Lines changed: 52 additions & 34 deletions

File tree

content/en/docs/deployment/private-cloud/private-cloud-api-mcp.md

Lines changed: 52 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ weight: 100
1212
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.
1313

1414
{{% 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.
1616
{{% /alert %}}
1717

1818
## Prerequisites
@@ -26,45 +26,54 @@ Before you start, make sure you have the following:
2626

2727
## Connecting Your AI Assistant {#connecting}
2828

29+
Refer to the following sections for information about connecting your agent.
30+
2931
### Claude Code {#claude-code}
3032

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:
3234

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:
3836

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+
```
4042

41-
* `{GENERATED_PAT}`the generated Mendix Personal Access Token (PAT)
43+
2. Replace the following placeholders with your credentials:
4244

45+
* `{GENERATED_PAT}` - Replace with the generated Mendix Personal Access Token (PAT)
4346

44-
To verify the connection, run the following command:
47+
3. Verify the connection by running the following command:
4548

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:
4954

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:
5167

5268
```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
6370
```
6471

6572
### VS Code with GitHub Copilot {#vs-code}
6673

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:
6877

6978
```json
7079
{
@@ -82,7 +91,7 @@ To add the Mendix on Kubernetes MCP server in VS Code, add the following configu
8291
}
8392
```
8493

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.
8695

8796
## Available Capabilities {#capabilities}
8897

@@ -137,7 +146,6 @@ Two authentication methods are used depending on the API:
137146
Include all three headers in your connection configuration to ensure all tools work correctly.
138147
{{% /alert %}}
139148

140-
141149
## Client Compatibility {#compatibility}
142150

143151
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
150158

151159
The following limitations apply:
152160

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.
158172

159173
## Troubleshooting {#troubleshooting}
160174

161175
### Connection Fails or Times Out
162176

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.
164180
* Verify that your JSON configuration uses `"type": "http"` and not `"transport": "http"`.
165181
166182
### 401 Unauthorized
@@ -185,10 +201,12 @@ https://mcp.home.mendix.com/private \
185201
186202
### Tools Not Showing Up
187203
204+
If your tools are not discovered after connection, verify the following:
205+
188206
* Wait 10–15 seconds after connecting for tool discovery to complete.
189207
* Run `claude mcp get mendix-cloud-mcp-private` to check the connection status.
190208
* If the status shows an error, remove and re-add the connection.
191209
192210
## Feedback
193211
194-
To report an issue or request additional API coverage, contact your Mendix CSM.Nidhi
212+
To report an issue or request additional API coverage, contact your Mendix CSM.

0 commit comments

Comments
 (0)