Skip to content

Commit 459ba8d

Browse files
authored
Merge pull request mendix#10787 from mendix/yl-maia-make-documentation
Add Maia Make Documentation
2 parents 231f298 + c7c1327 commit 459ba8d

18 files changed

Lines changed: 309 additions & 16 deletions

File tree

content/en/docs/refguide/modeling/mendix-ai-assistance/_index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,16 @@ Mendix AI Assistance (Maia) in Studio Pro has the following capabilities:
3939
Starting point for app creation:
4040

4141
* **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/).
42+
* **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—a new domain model, overview pages, or microflows, or explaining your app logic and pages. Below is a list of Maia Make Capabilities:
43+
44+
* **Domain model creation** - Describe your data structure and Maia creates the entities and associations you need.
45+
* **Page generation** - Generate overview pages.
46+
* **Microflow generation** - Generate microflows, enumerations, XPath constraints, and expressions.
47+
* **MCP client** - Connect to compatible MCP Servers to leverage tools such as Playwright or Figma to improve the capabilities of Maia.
48+
* **Document upload** - Upload a PDF or an image and you can ask Maia to use it in your app creation.
49+
* **User story linking** - Select an existing story in Studio Pro and Maia can help you realize it.
50+
51+
This unified conversational interface is released in Studio Pro 11.8. For more information, see [Maia Make](/refguide/maia-make/).
4252

4353
Guidance:
4454

content/en/docs/refguide/modeling/mendix-ai-assistance/maia-for-workflows.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ description: "Describes the features in Maia for Workflows."
1212
To use Maia for Workflows, an internet connection and signing in to Studio Pro are required.
1313
{{% /alert %}}
1414

15+
{{% alert color="info" %}}
16+
In Studio Pro 11.8, Maia for Workflows is not available.
17+
{{% /alert %}}
18+
1519
Maia for Workflows helps you generate a [workflow](/refguide/workflows/). It can also provide explanations or further improvements based on the generated elements. The current version has some known limitations. For example, it is currently intended only for use with empty workflows. Generated elements are appended to the end of the workflow, which may result in incorrectly modeled workflows if the workflow is not empty. For more details, see the [Limitations](#limitation) section below.
1620

1721
## Using Maia for Workflows
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: "Maia Make Capabilities"
3+
url: /refguide/maia-make/
4+
weight: 4
5+
description: "Describes Maia Make capabilities in Mendix Studio Pro."
6+
description_list: true
7+
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
8+
---
9+
10+
## Introduction
11+
12+
{{% alert color="info" %}}
13+
Maia Make capabilities are grouped into a conversational interface, which is available in Studio Pro 11.8 and above.
14+
15+
To use this interface and Maia Make capabilities, an internet connection and signing in to Studio Pro are required.
16+
{{% /alert %}}
17+
18+
Maia Make is a set of AI-assisted development capabilities in Studio Pro that are available through a unified conversational interface. Describe your requirements in natural language, and Maia generates development artifacts such as data structures, overview pages, and microflows.
19+
20+
You can also ask Maia to provide explanations of your existing logic and pages. Moreover, this interface allows you to integrate with external tools via MCP Servers (Playwright, Figma, and others) and it supports story-based development by generating app artifacts based on existing user stories.
21+
22+
The key Maia Make capabilities are as follows:
23+
24+
* Conversational assistance for general Mendix development queries
25+
* Logic and page explanations to clarify existing implementation details
26+
* Domain model generation from natural language descriptions
27+
* Overview page generation from natural language descriptions
28+
* Microflow generation including XPath constraints and expressions
29+
* External tool integration via compatible MCP Servers (such as Playwright, Figma)
30+
* Story-based development to help realize existing user stories
31+
* PDF and image support to help Maia understand your requirements better
32+
* Add relevant logic and pages to the interface to give Maia a more desired context
33+
34+
## Using Maia Make Capabilities
35+
36+
Maia Make capabilities are enabled by default. You can disable them in Studio Pro **Preferences**, via the **Maia** tab.
37+
38+
To access the conversational interface and Maia Make capabilities, in the upper-right corner of Studio Pro, click the **Maia** pane. It appears under the **Chat** tab:
39+
40+
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-make-interface.png" max-width=40% alt="Maia Make interface" >}}
41+
42+
Alternatively, you can also click **View** at the Studio Pro top bar and select **Maia** to open the interface.
43+
44+
{{% alert color="info" %}}
45+
In Studio Pro 11.7 and below, the **Chat** tab is only used for [Maia Chat](/refguide/maia-chat/) where you can ask questions about all aspects of Mendix.
46+
47+
There is also the **Learn** tab under the **Maia** pane. It is a separate Maia capability that is not part of Maia Make capabilities. For more information, see [Maia Learn](/refguide/maia-learn/).
48+
{{% /alert %}}
49+
50+
{{% alert color="warning" %}}
51+
The Maia ({{% icon name="sparkles" %}} ) icon on the right side of the top bar does not work in Studio Pro 11.8.
52+
{{% /alert %}}
53+
54+
### Maia Make Capabilities Interface Overview
55+
56+
The conversational interface includes the following options:
57+
58+
* **New chat** - It allows you to clear the messages and start a new conversation which does not reference your current chat.
59+
* **Configure MCP Connections** ({{% icon name="plug" %}} icon) - It allows you to connect external [MCP](https://modelcontextprotocol.io/introduction) servers to Maia, giving it access to third-party tools during chat. For more information on how to configure MCP connections, see [Maia MCP Client](/refguide/maia-mcp/).
60+
* **{{% icon name="paperclip" %}} Add** (Image, Story, PDF) - With this option, you can attach images, PDFs, or user stories to help Maia understand your requirements better.
61+
* **Add file to Maia Chat** (@ icon) - It allows you to add certain logic or pages to Maia as context. You can also access this option by right-clicking the documents (microflows or pages) in the **App Explorer** and it appears in the context menu.
62+
63+
For more information on how each Maia Make capability work, refer to the following documents:
64+
65+
* [Maia Chat](/refguide/maia-chat/)
66+
* [Maia Explain](/refguide/maia-explain/)
67+
* [Maia for Domain Model](/refguide/maia-for-domain-model/)
68+
* [Maia for Pages](/refguide/maia-for-pages/)
69+
* [Maia for Microflows](/refguide/maia-for-microflows/)
70+
* [Maia MCP Client](/refguide/maia-mcp/)
71+
72+
In Studio Pro 11.8 and above, most of the features described in the documents above are available only through the chat interface. There are no separate entry points to these features in their respective editors. [Maia Explain](/refguide/maia-explain/) is an exception. You can still access this feature by right-clicking the documents (microflows or pages) in the **App Explorer** and the **Maia Explain** option is in the context menu.
73+
74+
## Read More
75+
76+
* [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/)

content/en/docs/refguide/modeling/mendix-ai-assistance/maia-chat.md renamed to content/en/docs/refguide/modeling/mendix-ai-assistance/maia-make/maia-chat.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,20 +36,24 @@ See below a list of Maia Chat's data sources:
3636

3737
## Using Maia Chat in Studio Pro
3838

39-
There are two ways to access Maia Chat in Studio Pro:
39+
{{% alert color="info" %}}
40+
In Studio Pro 11.8 and above, Maia Chat is incorporated into the unified Maia Make capabilities, which are enabled by default. There is no dedicated interface only for Maia Chat. For more information, see [Maia Make Capabilities](/refguide/maia-make/).
41+
{{% /alert %}}
42+
43+
In Studio Pro 11.7 and below, there are two ways to access Maia Chat in Studio Pro:
4044

4145
* Click the **Maia** ({{% icon name="sparkles" %}}) icon to the right of the top bar.
4246
* Go to the **View** menu and click **Maia**.
4347

4448
The chat interface appears at the right side of Studio Pro under the **Maia** pane:
4549

46-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-chat/maia-chat-interface.png" width="250px">}}
50+
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-chat/maia-chat-interface.png" width="250px">}}
4751

4852
You can start using Maia Chat by clicking one of the demo questions. Alternatively, you can ask your own question, and press <kbd>Enter</kbd> or click **Ask** to send the question. For information on the supported shortcut keys in Maia Chat, see the [Maia Chat Shortcut Keys](/refguide/keyboard-shortcuts/#maia-chat-shortcuts) section in *Keyboard Shortcuts*.
4953

5054
For more information on Maia Chat features in Studio Pro, see the sub-sections below.
5155

52-
If Maia is not giving you a good answer, check the [best practices](/portal/maia/#best-practices) in *Maia in Mendix Portal*. If you still can't get a good answer, please see [Giving Feedback](#feedback), below for information on how to let Mendix know.
56+
If Maia is not giving you a good answer, check the [best practices](/portal/maia/#best-practices) in *Maia in Mendix Portal*. If you still can not get a good answer, please see the [Giving Feedback](#feedback) section below for information on how to let Mendix know.
5357

5458
### Maia Chat Features in Studio Pro
5559

@@ -72,7 +76,7 @@ There are several ways to give feedback on the generated answer:
7276
* Click the thumbs up icon ({{% icon name="thumbs-up" %}}) or the thumbs down icon ({{% icon name="thumbs-down" %}})
7377
* To provide more detailed feedback, click the add feedback icon ({{% icon name="notes-paper-edit" %}}). A detailed **Feedback** section shows below the answer:
7478

75-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-chat/feedback-section.png" width="250px" >}}
79+
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-chat/feedback-section.png" width="250px" >}}
7680

7781
* You can rate the **correctness**, **completeness**, and **readability** of the provided answer.
7882
* You can also provide **Additional feedback** if you want to.

content/en/docs/refguide/modeling/mendix-ai-assistance/maia-explain.md renamed to content/en/docs/refguide/modeling/mendix-ai-assistance/maia-make/maia-explain.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,29 @@ description: "Describes the features in Maia Explain."
1212
To use Maia Explain, an internet connection and signing in to Studio Pro are required.
1313
{{% /alert %}}
1414

15-
Maia Explain helps you easily understand a microflow or a nanoflow. It explains the general purpose of the logic and highlights specific technical details to help you understand the logic further.
15+
## Using Maia Explain in Studio Pro 11.8 and Above
1616

17-
## Using Maia Explain
17+
In Studio Pro 11.8 and above, Maia Explain is incorporated into the unified Maia Make capabilities, which are enabled by default. There is no dedicated interface only for Maia Explain. For more information, see [Maia Make Capabilities](/refguide/maia-make/).
1818

19-
Maia Explain is enabled by default. If you want to disable this feature, go to **Edit** > **Preferences** > the **Maia** tab and clear the **Enable Maia Explain** checkbox.
19+
There are two ways to use Maia Explain:
2020

21-
There are two ways to launch Maia Explain:
21+
* Use the chat interface directly to get explanations of your microflows or pages.
22+
* In the App Explorer, right-click a microflow or a page to open its context menu, and click **Maia Explain**.
23+
24+
Nanoflows are not supported by Maia Explain in Studio Pro 11.8.
25+
26+
## Using Maia Explain in Studio Pro 11.7 and Below
27+
28+
In Studio Pro 11.7 and below, Maia Explain is enabled by default. If you want to disable this feature, go to **Edit** > **Preferences** > the **Maia** tab and clear the **Enable Maia Explain** checkbox.
29+
30+
There are two ways to use Maia Explain:
2231

2332
* In the toolbar of the microflow or nanoflow editor, click **Explain**.
2433
* In the App Explorer, right-click a microflow or a nanoflow to open its context menu, and click **Explain**.
2534

2635
A message is sent to Maia and a chat interface with an initial answer appears on the right side of Studio Pro under the **Maia** tab:
2736

28-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-explain/maia-explain-interface.png" width="300px">}}
37+
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-explain/maia-explain-interface.png" width="300px">}}
2938

3039
The initial answer consists of two parts:
3140

@@ -44,4 +53,5 @@ In this dedicated chat, only requests related to Maia Explain will be properly h
4453

4554
## Read More
4655

56+
* [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/)
4757
* [Maia Chat](/refguide/maia-chat/)

content/en/docs/refguide/modeling/mendix-ai-assistance/maia-for-domain-model.md renamed to content/en/docs/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-domain-model.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,19 @@ Maia for Domain Model helps you generate new [domain model](/refguide/domain-mod
1818

1919
## Using Maia for Domain Model
2020

21-
Maia for Domain Model is enabled by default.
21+
{{% alert color="info" %}}
22+
In Studio Pro 11.8 and above, Maia for Domain Model is incorporated into the unified Maia Make capabilities, which are enabled by default. There is no dedicated interface only for Maia for Domain Model. For more information, see [Maia Make Capabilities](/refguide/maia-make/).
23+
{{% /alert %}}
2224

23-
You can find it in the the toolbar of a domain model:
25+
In Studio Pro 11.7 and below, Maia for Domain Model is enabled by default. You can find it in the the toolbar of a domain model:
2426

25-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-for-domain-model/maia-for-domain-model.png" max-width=80% >}}
27+
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-domain-model/maia-for-domain-model.png" max-width=80% >}}
2628

2729
If you want to disable this feature, go to **Edit** > **Preferences** > the **Maia** tab and clear the **Enable Maia for Domain Model** checkbox.
2830

2931
After clicking **Maia for Domain Model**, a dedicated chat interface will appear at the right side of Studio Pro under the **Maia** tab:
3032

31-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-for-domain-model/chat-interface.png" max-width=42% >}}
33+
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-domain-model/chat-interface.png" max-width=42% >}}
3234

3335
Describe your application or its main goals in the chat. Maia will use this information to generate a relevant domain model for you. In Studio Pro 11.1 and above, you can also attach maximally one image and one PDF to help Maia better understand your request. For more information, see the [Attachment Requirements](#attachment-requirements) section below.
3436

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: "Maia for Microflows"
3+
url: /refguide/maia-for-microflows/
4+
weight: 75
5+
description: "Describes the features in Maia for Microflows."
6+
---
7+
## Introduction
8+
9+
{{% alert color="info" %}}
10+
This feature is released as part of [Make Make](/refguide/maia-make/) capabilities in Studio Pro 11.8.
11+
{{% /alert %}}
12+
13+
Maia for Microflows is an AI-powered capability that is available when using [Maia Make](/refguide/maia-make/) in Studio Pro. Maia Make is a unified conversational interface within Studio Pro that consolidates all AI-assisted development capabilities into a single chat experience.
14+
15+
With the microflow generation capability, you can leverage Maia to generate microflow logic efficiently from your text input. It is a powerful tool for quickly setting up both simple and complex microflows, with the goal of providing ready-to-use logic that minimizes the need for manual adjustments.
16+
17+
## Using Maia for Microflows
18+
19+
Open the Maia Make conversational interface in Studio Pro to access its microflow generation capability. Use natural language to describe your goal, Maia will generate the microflows for you, including XPath constraints and expressions. See the section below for text input best practices.
20+
21+
### Best Practices for Text Input
22+
23+
To achieve the best results when using Maia to generate microflows, consider the following guidelines for your text input:
24+
25+
* Be specific: Clearly describe the desired outcome and the steps involved. For example, instead of using *Create a user*, use *Create a new user object, set its name attribute to 'John Doe', and commit it*.
26+
* Use keywords: Incorporate terms relevant to microflow activities, such as *create object*, *retrieve*, *change object*, *show message*, *loop*, or *decision*. This can help with correct microflow generation.
27+
* Provide context: If your microflow interacts with existing entities or attributes, mention them in your text input.
28+
29+
## Limitations
30+
31+
### Destructive Operations Are Not Supported
32+
33+
Maia for Microflows can create objects and flows and change simple ("primitive") settings, but it cannot delete objects or replace complex configuration settings. For example, for existing objects, Maia can change variable names, move objects, or reconnect flows, but it cannot delete objects or flows, or change the activity types.
34+
35+
### Variability in Results
36+
37+
Due to the nature of AI generation, the exact microflow logic produced can vary between separate runs, even with identical input. It is recommended to review the generated output carefully.
38+
39+
### Layout and Positioning
40+
41+
While Maia aims to create functional logic, the visual layout and positioning of elements within the generated microflow may not always be optimally organized. You may need to adjust the arrangement of activities for better readability and structure.
42+
43+
## Read More
44+
45+
* [Microflows](/refguide/microflows/)
46+
* [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/)
47+
* [Maia Chat](/refguide/maia-chat/)

content/en/docs/refguide/modeling/mendix-ai-assistance/maia-for-pages.md renamed to content/en/docs/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-pages.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,23 @@ Maia for Pages helps you generate a [page](/refguide/page/) by adding and config
1818

1919
## Using Maia for Pages
2020

21-
To enable Maia for Pages, go to **Edit** > **Preferences** > the **Maia** tab and select **Enable Maia for Pages**.
21+
{{% alert color="info" %}}
22+
In Studio Pro 11.8 and above, Maia for Pages is incorporated into the unified Maia Make capabilities, which are enabled by default. There is no dedicated interface only for Maia for Pages. For more information, see [Maia Make Capabilities](/refguide/maia-make/).
23+
{{% /alert %}}
24+
25+
In Studio Pro 11.7 and below, to enable Maia for Pages, go to **Edit** > **Preferences** > the **Maia** tab and select **Enable Maia for Pages**.
2226

2327
Once enabled, you can find it in the the toolbar of a page:
2428

25-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-for-pages/maia-for-pages.png" max-width=80% >}}
29+
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-pages/maia-for-pages.png" max-width=80% >}}
2630

2731
{{% alert color="info" %}}
2832
Maia for Pages is available in both the **Structure mode** and **Design mode**.
2933
{{% /alert %}}
3034

3135
After clicking **Maia for Pages**, a dedicated chat interface appears at the right side of Studio Pro under the **Maia** tab:
3236

33-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-for-pages/chat-interface.png" max-width=42% >}}
37+
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-pages/chat-interface.png" max-width=42% >}}
3438

3539
Describe your page or its main goals in the chat. Maia uses this information to add relevant widgets to the page and configure them for you. When generating a page, Maia knows about the domain model of the module you are currently working on. For example, it might include a [Data View](/refguide/data-view/) with some [Text Box](/refguide/text-box/) widgets for an attribute of an entity.
3640

0 commit comments

Comments
 (0)