Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ To perform an action via the Backups API, you need **Backups Access** and **API

To download a backup of your data, do as follows:

1. Make sure that you have an API key or a PAT, and the **API Access** and **Backups** permissions.
1. Make sure that you have an API key and the **API Access** and **Backups** permissions.

2. If the snapshot already exists, find the [snapshot ID](/developerportal/operate/backups/#backups-details).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ For specific Maia features, use the feature name directly: Logic Recommender, Wo

It is okay to include "Maia" as part of the feature name if it is introduced for the first time or if no near context about Maia is given: Maia Logic Recommender, Maia Workflow Recommender, Maia Translation Generator, for instance.

As of Studio Pro 11.8, Maia Make replaces Maia's individual features. Refer to "Maia" or "Maia Make" as a set of capabilities. Do not refer to older individual tools, such as "Maia Chat", "Maia for Domain Models", or "Maia for Pages" unless referring to Studio Pro 11.7 and below.
Maia Chat is an exception: use "Maia Chat" instead of "Chat". Only use "Chat" in very rare cases: as a page title in the left navigation menu under the [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) category.

Capitalize in all instances.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,17 @@ description: "Describes how to connect AI coding assistants to Mendix Cloud usin
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.

{{% alert color="warning" %}}
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) has access to. Through the [Backups API](/apidocs-mxsdk/apidocs/backups-api/) and [Logs](/developerportal/operate/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.
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](/apidocs-mxsdk/apidocs/backups-api/) and [Logs](/developerportal/operate/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.
{{% /alert %}}

## Prerequisites

Before you start, make sure you have the following:

* An MCP-compatible AI client that supports custom request headers, such as Claude Code or VS Code with GitHub Copilot
* A Mendix account with API access enabled
* A [Personal Access Token (PAT)](/portal/user-settings/#pat) with the `mx:deployment:write` and `mx:deployment:read` scopes selected
* A [Mendix API key](/portal/user-settings/#profile-api-keys)

## Connecting Your AI Assistant {#connecting}

Expand All @@ -32,10 +34,16 @@ To add the Mendix MCP server in Claude Code, run the following command in your t
```bash
claude mcp add --scope user --transport http mendix-cloud-mcp \
https://mcp.home.mendix.com/ \
--header "Authorization: MxToken {GENERATED_PAT}"
--header "Authorization: MxToken {GENERATED_PAT}" \
--header "Mendix-Username: {Mendix-Username}" \
--header "Mendix-ApiKey: {Mendix-ApiKey}"
```

Replace `{GENERATED_PAT}` with your Mendix Personal Access Token (PAT).
Replace the following placeholders with your credentials:

* `{GENERATED_PAT}` – the generated Mendix Personal Access Token (PAT)
* `{Mendix-Username}` – the login name of the user making the request, with the required privileges in the Mendix Platform
* `{Mendix-ApiKey}` – the API key associated with that user

To verify the connection, run the following command:

Expand All @@ -54,6 +62,8 @@ mendix-cloud-mcp:
URL: https://mcp.home.mendix.com/
Headers:
Authorization: MxToken {GENERATED_PAT}
Mendix-Username: {Mendix-Username}
Mendix-ApiKey: {Mendix-ApiKey}

To remove this server, run: claude mcp remove mendix-cloud-mcp -s user
```
Expand All @@ -70,15 +80,17 @@ To add the Mendix MCP server in VS Code, add the following configuration to your
"type":"http",
"url":"https://mcp.home.mendix.com/",
"headers":{
"Authorization":"MxToken {GENERATED_PAT}"
"Authorization":"MxToken {GENERATED_PAT}",
"Mendix-Username":"{Mendix-Username}",
"Mendix-ApiKey":"{Mendix-ApiKey}"
}
}
}
}
}
```

Replace `{GENERATED_PAT}` with your Mendix Personal Access Token (PAT).
Replace the placeholder values with your credentials as described in the [Claude Code](#claude-code) section above.

## Available Capabilities {#capabilities}

Expand Down Expand Up @@ -137,18 +149,23 @@ Once connected, your AI assistant has access to the following capabilities.

Your credentials are passed directly to the Mendix APIs and are not stored or inspected by the MCP gateway. Each user authenticates using their own credentials.

All APIs, including the Deploy API, Build API, Backups API, and App Permissions, use the `Authorization: MxToken {GENERATED_PAT}` header.
Two authentication methods are used depending on the API:

| API Version | Headers Required |
| --- | --- |
| Deploy API v4, App Permissions | `Authorization: MxToken {GENERATED_PAT}` |
| Deploy API v1/v2, Build API, Backups API | `Mendix-Username` and `Mendix-ApiKey` |

{{% alert color="info" %}}
Include the `Authorization` header in your connection configuration to ensure all tools work correctly.
Include all three headers in your connection configuration to ensure all tools work correctly.
{{% /alert %}}

## Client Compatibility {#compatibility}

The Mendix MCP integration works with any MCP-compatible client that supports HTTP transport (streamable HTTP) and custom headers for authentication.

{{% alert color="warning" %}}
Clients that only support OAuth 2.0 authentication without custom header support are not compatible with the Mendix Cloud MCP integration, as Mendix APIs use token-based authentication.
Clients that only support OAuth 2.0 authentication without custom header support are not compatible with the Mendix Cloud MCP integration, as Mendix APIs use token and API key-based authentication.
{{% /alert %}}

## Known Limitations {#limitations}
Expand All @@ -170,7 +187,7 @@ The following limitations apply:

### 401 Unauthorized

Your credentials are incorrect or have expired. Regenerate your PAT.
Your credentials are incorrect or have expired. Regenerate your PAT and verify that your API key is still active.

### 403 Forbidden

Expand All @@ -184,7 +201,9 @@ Your MCP client is not sending the correct `Accept` header. This happens when yo
claude mcp remove mendix-cloud-mcp
claude mcp add --scope user --transport http mendix-cloud-mcp \
https://mcp.home.mendix.com/ \
--header "Authorization: MxToken {GENERATED_PAT}"
--header "Authorization: MxToken {GENERATED_PAT}" \
--header "Mendix-Username: {Mendix-Username}" \
--header "Mendix-ApiKey: {Mendix-ApiKey}"
```

### Tools Not Showing Up
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ description_list: true

## Introduction

Operating a production application requires continuous monitoring of its health and behavior, including reviewing logs, investigating errors, and understanding application activity over time. Maia Operate simplifies these tasks by using data already available in Mendix Cloud to provide AI-powered insights into your running application. It helps you resolve incidents faster and spend less time on investigation and routine operational work.
Operating a production application requires continuous monitoring of its health and behavior. This often involves reviewing logs, investigating errors, and understanding application activity over time.

Maia Operate covers the operation stage of the application lifecycle. Insights from operating your app can become input for the next iteration, which you can plan in Mendix Portal and build in Studio Pro with Maia. For an overview of how Maia supports each stage, see [Maia Across the Development Lifecycle](/refguide/maia-development-lifecycle/).
Maia Operate simplifies these operational tasks by using data already available in Mendix Cloud to provide AI-powered insights into your running application. It helps you resolve incidents more quickly, reduce investigation time, and spend less effort on routine operational work.

## Documents in This Category
2 changes: 0 additions & 2 deletions content/en/docs/developerportal/maia-plan/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,4 @@ Maia Plan helps you create a detailed project plan, based on which you can then

{{< figure src="/attachments/developerportal/maia/maia-create-app.png" alt="Plan and build with Maia entry point" max-width=50% >}}

Maia Plan covers the planning stage of the application lifecycle. You can use the stories from the plan as input when building your app in Studio Pro with Maia Make, or have external AI agents read the plan through [Maia Plan as MCP Server](/developerportal/maia-plan-mcp/). For an overview of how Maia supports each stage, see [Maia Across the Development Lifecycle](/refguide/maia-development-lifecycle/).

## Documents in This Category
1 change: 1 addition & 0 deletions content/en/docs/marketplace/marketplace-home-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ This table breaks down the roles and permissions for content groups:
| Group Admin | ✘ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| Group Member | ✘ | ✘ | ✘ | ✔ | ✔ | ✔ | ✔ |
| Organization member (not part of any group) | ✘ | ✘ | ✘ | ✘ | ✔ | ✔ | ✘ |
| Guest | ✘ | ✘ | ✘ | ✘ | ✔ | ✘ | ✘ |
| Developer (not part of any group) | ✘ | ✘ | ✘ | ✔ | ✔ | ✔ | ✔ |

### Content Tab {#group-content}
Expand Down
6 changes: 2 additions & 4 deletions content/en/docs/mendix-portal/maia-portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ aliases:

Mendix AI Assistance (Maia) refers to Mendix Platform capabilities that leverage [artificial intelligence (AI)](https://www.mendix.com/glossary/artificial-intelligence-ai/) and [machine learning (ML)](https://www.mendix.com/glossary/machine-learning/) to assist developers in application development. Maia is designed to help development teams in modeling and delivering Mendix applications faster, more consistently, and with higher quality.

{{< figure src="/attachments/developerportal/global-nav/maia-mendix-portal.jpg" alt="Maia in Mendix Portal" width="500" >}}

Maia in Mendix Portal supports the planning, collaboration, and feedback stages of the application lifecycle. For example, you can use Maia Plan to define the scope of a new app, then continue in Studio Pro with Maia Make to build it. For an overview of how Maia supports each stage, see [Maia Across the Development Lifecycle](/refguide/maia-development-lifecycle/).
{{< figure src="/attachments/developerportal/global-nav/maia-mendix-portal.jpg" width="500" >}}

## Maia Capabilities in Mendix Portal

Expand Down Expand Up @@ -51,7 +49,7 @@ Maia Chat does not use any project, customer, or company information. It only us

Maia Chat is a built-in chat interface in the Mendix Platform powered by Generative AI. Developers can ask questions about all aspects of Mendix, including how to apply concepts, best practices, governance tools, and development patterns.

Maia Chat is also available in Studio Pro 10.12.0 to 11.7. In Studio Pro 11.8 and above, Maia Chat is part of Maia Make, where you can ask questions directly to Maia in the **Chat** tab. For more information, see [Chat with Maia](/refguide/maia-chat/).
Maia Chat is also available in Studio Pro 10.12.0 and above. See [Maia Chat](/refguide/maia-chat/) for more information.

For information on Mendix data storage policies and practices for Maia, see [Maia Privacy Policy](https://www.mendix.com/legal/privacy/maia/).

Expand Down
16 changes: 7 additions & 9 deletions content/en/docs/private-platform/pmp-maia.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,14 @@ weight: 51

Mendix AI Assistance (Maia) refers to Mendix Platform capabilities that leverage [artificial intelligence (AI)](https://www.mendix.com/glossary/artificial-intelligence-ai/) and [machine learning (ML)](https://www.mendix.com/glossary/machine-learning/) to assist developers in application development. Maia is designed to help development teams in modeling and delivering Mendix applications faster, more consistently, and with higher quality.

For an overview of how Maia supports each stage of the application lifecycle, see [Maia Across the Development Lifecycle](/refguide/maia-development-lifecycle/). Not all capabilities on that page are available in Private Mendix Platform. The following section lists the capabilities that are supported.

## Maia Capabilities in Private Mendix Platform

Mendix AI Assistance (Maia) in Private Mendix Platform has the following capabilities:

Starting point for app creation:

* **Start with Maia** - a starting point in Studio Pro that helps you to start the app development process. Based on a required text description and an optional image or PDF, it generates an app that includes a domain model, data management overview pages, test data, and a tailored homepage. For more information, see [Start with Maia](/refguide/start-with-maia/).
* **Maia Make** - a unified conversational interface in Studio Pro that groups all agentic development capabilities into a single chat experience. With this interface, everything happens in one place. Start a conversation, describe what you need, and Maia generates the necessary app artifacts, such as a new domain model, pages, and microflows. You can also ask it to explain documents for you, including your app logic and pages. For more information, see [Maia Make Capabilities](/refguide/maia-make/).
* **Maia Make** - a unified conversational interface in Studio Pro that groups all AI-assisted development capabilities into a single chat experience. With this interface, everything happens in one place. Start a conversation, describe what you need, and Maia generates the necessary app artifacts, such as a new domain model, pages, and microflows. You can also ask it to explain documents for you, including your app logic and pages. For more information, see [Maia Make Capabilities](/refguide/maia-make/).

Recommenders:

Expand All @@ -28,15 +26,15 @@ Recommenders:

Generators:

* **Domain Models in Maia Make** – helps you generate new [domain models](/refguide/domain-model/), and explain and provide suggestions for existing domain models. For more information, see [Domain Models in Maia Make](/refguide/maia-for-domain-model/).
* **Maia for Domain Model** – helps you generate new [domain models](/refguide/domain-model/), and explain and provide suggestions for existing domain models. For more information, see [Maia for Domain Model](/refguide/maia-for-domain-model/).

For Private Mendix Platform, this feature is supported for version 11.6 and newer.

* **Pages in Maia Make** – helps you generate a [page](/refguide/page/). It helps you add and configure widgets based on a text input and an optional image. After a page is generated, you can continue in the same session to ask Maia for further improvements and explanations. For more information, see [Pages in Maia Make](/refguide/maia-for-pages/).
* **Maia for Pages** – helps you generate a [page](/refguide/page/). It helps you add and configure widgets based on a text input and an optional image. After a page is generated, you can continue in the same session to ask Maia for further improvements and explanations. For more information, see [Maia for Pages](/refguide/maia-for-pages/).

For Private Mendix Platform, this feature is supported for version 11.6 and newer.

* **Workflows in Maia Make** – helps you generate a [Workflow](/refguide/workflows/). By providing a use case via text input or an image, Maia can help you start creating your workflows. For more information, see [Workflows in Maia Make](/refguide/maia-for-workflows/).
* **Maia for Workflows** – helps you generate a [Workflow](/refguide/workflows/). By providing a use case via text input or an image, Maia can help you start creating your workflows. For more information, see [Maia for Workflows](/refguide/maia-for-workflows/).
* **Validation Assist** – helps you build validation microflows in a more automated way using pre-built expressions. For more information, see [Validation Assist](/refguide/validation-assist/).

## Changing the LLM Provider for Maia
Expand All @@ -61,9 +59,9 @@ The following table shows which Maia capabilities are supported by various model

| Maia Capability | AWS Bedrock | Anthropic | Azure | OpenAI |
| --- | --- | --- | --- | --- |
| **Pages in Maia Make** | Full support | Full support | Simple requests only | Simple requests only |
| **Domain Models in Maia Make** | Full support | Full support | Full support | Full support |
| **Workflows in Maia Make** | Full support | Full support | Simple requests only | Does not support workflow creation |
| **Maia for Pages** | Full support | Full support | Simple requests only | Simple requests only |
| **Maia for Domain Model** | Full support | Full support | Full support | Full support |
| **Maia for Workflows** | Full support | Full support | Simple requests only | Does not support workflow creation |
| **Start with Maia** | Full support | Full support | Full support | Full support |
| **Best Practice Recommender** | Full support | Full support | Full support | Full support |
| **UI Recommender** | Full support | Full support | Full support | Full support |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -545,7 +545,7 @@ Install the Private Mendix Platform by doing the following steps:

## Installing Maia for the Private Mendix Platform {#maia}

[Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) refers to Mendix Platform capabilities that leverage [artificial intelligence (AI)](https://www.mendix.com/glossary/artificial-intelligence-ai/) and [machine learning (ML)](https://www.mendix.com/glossary/machine-learning/) to assist developers in application development. Private Mendix Platform currently offers support for Maia-assisted app creation. Other Maia capabilities will be made available in future releases.
[Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) refers to Mendix Platform capabilities that leverage [artificial intelligence (AI)](https://www.mendix.com/glossary/artificial-intelligence-ai/) and [machine learning (ML)](https://www.mendix.com/glossary/machine-learning/) to assist developers in application development. Private Mendix Platform currently offers support for Maia-assisted app creation. Other Maia capabilities, such as Maia Chat, will be made available in future releases.

To enable [Maia for Private Mendix Platform](/private-mendix-platform/maia/), perform the following steps:

Expand Down
Loading
Loading