Skip to content

Commit 6b4a02a

Browse files
Cloud MCP doc technical review
1 parent 7a6f607 commit 6b4a02a

1 file changed

Lines changed: 23 additions & 17 deletions

File tree

content/en/docs/deployment/mendix-cloud-deploy/deploy-apis-with-ai-agents.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ description: "Describes how to connect AI coding assistants to Mendix Cloud usin
1212

1313
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 Portal.
1414

15+
{{% alert color="warning" %}}
16+
The use of AI tools is non-deterministic, outputs may vary between runs. AI Assistants/Agents will have permissions based on what the API Key and Personal Access Token (PAT) have access to. Through the [Backups API](https://docs.mendix.com/apidocs-mxsdk/apidocs/backups-api/) and Logs, they may have access to production environments and Personally Identifiable Information (PII) contained within your environments. Carefully review and limit the scope of credentials before use.
17+
{{% /alert %}}
1518

1619
## Prerequisites
1720

@@ -30,17 +33,18 @@ To add the Mendix MCP server in Claude Code, run the following command in your t
3033

3134
```bash
3235
claude mcp add --scope user --transport http mendix-cloud-mcp \
33-
https://mcp.home.mendix.com/ \
34-
--header "Authorization: MxToken <your-personal-access-token>" \
35-
--header "Mendix-Username: <your-username>" \
36-
--header "Mendix-ApiKey: <your-api-key>"
36+
https://mcp.home.mendix.com/ \
37+
--header "Authorization: MxToken {GENERATED_PAT}" \
38+
--header "Mendix-Username: {Mendix-Username}" \
39+
--header "Mendix-ApiKey: {Mendix-ApiKey}"
3740
```
3841

3942
Replace the following placeholders with your credentials:
4043

41-
* `<your-personal-access-token>` – your Mendix PAT
42-
* `<your-mendix-email>` – your Mendix account email address
43-
* `<your-api-key>` – your Mendix API key
44+
* `{GENERATED_PAT}` – the generated Mendix Personal Access Token (PAT)
45+
* `{Mendix-Username}` – the login name of the user making the request, with the required privileges in the Mendix Platform
46+
* `{Mendix-ApiKey}` – the API key associated with that user
47+
4448

4549
To verify the connection, run the following command:
4650

@@ -58,9 +62,9 @@ mendix-cloud-mcp:
5862
Type: http
5963
URL: https://mcp.home.mendix.com/
6064
Headers:
61-
Authorization: MxToken <your-personal-access-token>
62-
Mendix-Username: <your-username>
63-
Mendix-ApiKey: <your-api-key>
65+
Authorization: MxToken {GENERATED_PAT}
66+
Mendix-Username: {Mendix-Username}
67+
Mendix-ApiKey: {Mendix-ApiKey}
6468

6569
To remove this server, run: claude mcp remove mendix-cloud-mcp -s user
6670
```
@@ -77,9 +81,9 @@ To add the Mendix MCP server in VS Code, add the following configuration to your
7781
"type":"http",
7882
"url":"https://mcp.home.mendix.com/",
7983
"headers":{
80-
"Authorization":"MxToken <your-personal-access-token>",
81-
"Mendix-Username":"<your-username>",
82-
"Mendix-ApiKey":"<your-api-key>"
84+
"Authorization":"MxToken {GENERATED_PAT}",
85+
"Mendix-Username":"{Mendix-Username}",
86+
"Mendix-ApiKey":"{Mendix-ApiKey}"
8387
}
8488
}
8589
}
@@ -150,7 +154,7 @@ Two authentication methods are used depending on the API:
150154

151155
| API Version | Headers Required |
152156
| --- | --- |
153-
| Deploy API v4, App Permissions | `Authorization: MxToken <your-pat>` |
157+
| Deploy API v4, App Permissions | `Authorization: MxToken {GENERATED_PAT}` |
154158
| Deploy API v1/v2, Build API, Backups API | `Mendix-Username` and `Mendix-ApiKey` |
155159

156160
{{% alert color="info" %}}
@@ -168,6 +172,8 @@ Clients that only support OAuth 2.0 authentication without custom header support
168172

169173
## Known Limitations {#limitations}
170174

175+
The following limitations apply:
176+
171177
| Limitation | Details |
172178
| --- | --- |
173179
| 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. |
@@ -197,9 +203,9 @@ Your MCP client is not sending the correct `Accept` header. This happens when yo
197203
claude mcp remove mendix-cloud-mcp
198204
claude mcp add --scope user --transport http mendix-cloud-mcp \
199205
https://mcp.home.mendix.com/ \
200-
--header "Authorization: MxToken <your-pat>" \
201-
--header "Mendix-Username: <your-email>" \
202-
--header "Mendix-ApiKey: <your-api-key>"
206+
--header "Authorization: MxToken {GENERATED_PAT}" \
207+
--header "Mendix-Username: {Mendix-Username}" \
208+
--header "Mendix-ApiKey: {Mendix-ApiKey}"
203209
```
204210

205211
### Tools Not Showing Up

0 commit comments

Comments
 (0)