Skip to content
Draft
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
90 changes: 71 additions & 19 deletions content/en/docs/refguide/mendix-ai-assistance/maia-make/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ description_list: true
#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.
---

## Introduction
## Introduction

{{% alert color="info" %}}
Maia Make capabilities are available in Studio Pro 11.8 and above.

To use Maia Make capabilities, an internet connection and signing in to Studio Pro are required.
To use Maia Make capabilities, you need an internet connection and must be signed in to Studio Pro.
{{% /alert %}}

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, pages, and microflows.
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, pages, and microflows.

You can also ask Maia to provide explanations of your existing documents, such as microflows, workflows, and pages. Moreover, this interface allows you to integrate with external tools, such as Playwright and Figma, via MCP Servers, and it supports story-based development by generating app artifacts based on existing user stories.
You can also ask Maia to provide explanations of your existing documents, such as microflows, workflows, and pages. Moreover, this interface allows you to integrate with external tools, such as Playwright and Figma, via MCP servers. It also supports story-based development by generating app artifacts based on existing user stories.

## Maia Make Capabilities Overview

Expand Down Expand Up @@ -51,12 +51,12 @@ The following table lists Maia Make Standalone Capabilities and the Studio Pro v
| Capability | Description | Available in Maia Make from | Remarks |
| --- | --- | --- | --- |
| [Maia Chat](/refguide/maia-chat/) | Answers questions about all aspects of Mendix development. | Studio Pro 11.8 | |
| [Maia Explain](/refguide/maia-explain/) | Explains the purpose and logic of existing documents. | Studio Pro 11.8 | |
| [Maia Explain](/refguide/maia-explain/) | Explains the purpose and logic of existing documents. | Studio Pro 11.8 | Can be used directly in the chat interface, or in the App Explorer by right-clicking a document and clicking **Maia Explain**. |
| [Maia MCP Client](/refguide/maia-mcp/) | Connects Maia to external MCP servers, giving it access to third-party tools. | Studio Pro 11.8 | |
| [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/) | Exposes Studio Pro as an MCP server for use by external AI tools. | Studio Pro 11.10 | |
| [Maia Web Fetch](/refguide/maia-web-fetch/) | Fetches and reads content from public websites and APIs. | Studio Pro 11.10 | |
| [Maia Agent Skills](/refguide/maia-agent-skills/) | Extends Maia with reusable knowledge. | Studio Pro 11.11 | |
| [Maia Agent Instructions](/refguide/maia-instructions/) | Extends Maia with instructions to be followed with every prompt | Studio Pro 11.12 | |
| [Maia Agent Instructions](/refguide/maia-instructions/) | Extends Maia with instructions to be followed with every prompt. | Studio Pro 11.12 | |

### Maia Make General Capabilities

Expand All @@ -66,7 +66,7 @@ The following table lists the general capabilities of Maia Make and the Studio P
| --- | --- | --- | --- |
| Story-based development | Generates app artifacts based on existing user stories to support story-driven development workflows. | Studio Pro 11.8 | |
| PDF/image support | Allows you to provide PDFs and images as input to help Maia better understand your requirements. | Studio Pro 11.8 | |
| Adding documents as context | Lets you add relevant documents, to provide Maia with additional context. | Studio Pro 11.8 | |
| Adding documents as context | Lets you add relevant documents to provide Maia with additional context. | Studio Pro 11.8 | |
| Editing existing documents | Enables Maia to modify existing documents, including renaming elements. | Studio Pro 11.8 | |
| Removing elements | Allows Maia to remove elements from documents to support more advanced refactoring tasks. | Studio Pro 11.9 | |
| Undo support | Allows you to undo Maia-generated changes on a per-document basis. | Studio Pro 11.9 | |
Expand All @@ -83,7 +83,7 @@ To access the conversational interface and Maia Make capabilities, in the upper-

{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-interface.png" max-width=40% alt="Maia Make interface" >}}

Alternatively, you can also click **View** at the Studio Pro top bar and select **Maia** to open the interface.
Alternatively, you can click **View** on the Studio Pro top bar and select **Maia** to open the interface.

{{% alert color="info" %}}
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.
Expand All @@ -92,50 +92,54 @@ There is also the **Learn** tab under the **Maia** pane. It is a separate Maia c
{{% /alert %}}

{{% alert color="warning" %}}
The Maia ({{% icon name="sparkles" %}} ) icon on the right side of the top bar does not work in Studio Pro 11.8.
The Maia ({{% icon name="sparkles" %}}) icon on the right side of the top bar does not work in Studio Pro 11.8.
{{% /alert %}}

### Maia Make Capabilities Interface Overview

The conversational interface includes the following features.

{{% alert color="info" %}}
Maia Make loses the conversation history if you exit Studio Pro.
{{% /alert %}}

#### New Chat

Clicking **New Chat** allows you to clear the messages and start a new conversation that does not reference your current chat.

{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/new-chat.jpg" width="250px" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/new-chat.jpg" width="250px" alt="" >}}

#### Configure MCP Connections
#### Configure MCP Connections

This option ({{% icon name="plug" %}}) 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/).

{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/configure.jpg" width="250px" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/configure.jpg" width="250px" alt="" >}}

#### Add

**{{% icon name="paperclip" %}} Add** allows you to attach images, PDFs, or user stories to help Maia understand your requirements better.

{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/add.jpg" width="250px" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/add.jpg" width="250px" alt="" >}}

#### Add file to Maia Chat
#### Add file to Maia Chat

This option (@ icon) 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.
This option (@ icon) 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**, where it appears in the context menu.

{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/add-files.jpg" width="250px" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/add-files.jpg" width="250px" alt="" >}}

#### Changed List

A list of items added or changed by Maia appears above the chat box. Click an entry to open the relevant document. To undo all changes, click **Undo all**. To undo a single change, click the undo button on the right side of that item.

{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/changed-list.png" width="250px" >}}
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/changed-list.png" width="250px" alt="" >}}

#### Clarifying Questions

{{% alert color="info" %}}
This feature is available for Studio Pro 11.12 and above.
{{% /alert %}}

When Maia needs more information, it will ask clarifying questions through a dedicated UI to improve the quality of its response.
When Maia needs more information, it asks clarifying questions through a dedicated UI to improve the quality of its response.

## Save a Maia Session {#save-maia-session}

Expand Down Expand Up @@ -192,10 +196,58 @@ To configure an OpenAI-compatible provider, follow these steps:

[Private Mendix Platform](/private-mendix-platform/) provides an environment where you can develop and deploy your applications within your own enterprise security boundary to ensure the highest levels of data security and compliance. Because Private Mendix Platform instances are hosted within the enterprise firewall, selecting an LLM provider other than the default [Mendix Platform](#mendix-platform) requires you to also configure the LLM Gateway URL.

{{< figure src="/attachments/private-platform/pmp-llm-gateway.png" class="no-border" >}}
{{< figure src="/attachments/private-platform/pmp-llm-gateway.png" class="no-border" alt="" >}}

The LLM Gateway URL is configured during the installation or upgrade of Private Mendix Platform. For more information, see [Installing Maia for Private Mendix Platform](/private-mendix-platform/interactive-installation/#maia).

## Best Practices

### Text Input

To achieve optimal results, provide context about your app or the document you are working on by describing its main use cases, customer needs, or other relevant details. The more Maia knows about what you are building, the more tailored and accurate the generated results will be.

#### Providing Context

Below are some examples of prompts you can use as a starting point:

* The app will help users...
* This module handles...
* Customers need to be able to...
* The page will be used to...
* Generate a workflow for a process that...
* This feature allows users to...

#### Editing and Improving

Below are examples of prompts you can use to ask Maia to make further edits or request explanations and suggestions for improving a document:

* Can you explain the function and purpose of this document?
* I want to add an attribute `ATTRIBUTE_NAME` to the entity `ENTITY_NAME`.
* Can you add a button called `BUTTON_NAME` to the page?
* I want an area on the page where users can...
* Remove the ... widget.
* How can I make this page more user-friendly or visually appealing?
* Could you identify any potential issues with this document and recommend solutions?
* Can you give me suggestions to improve this workflow?

#### Workflows

You can provide a BPMN image representing employee onboarding alongside your text input. Maia can analyze the image, rework it using Mendix Workflows terminology, and generate the corresponding activities. Use text input alongside the image to specify any differences. For example, "Generate a workflow based on this BPMN image, but make sure it waits before sending an email to the new employee."

#### Microflows

When generating microflows, consider the following additional guidelines:

* **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*.
* **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.
* **Provide context:** If your microflow interacts with existing entities or attributes, mention them in your text input.

### Image Input

The image size is limited to 512 KB. Make sure to select a clear image to help Maia better understand your request. For example, you can provide a screenshot, a photo, a design mock-up, or a close-up picture of a drawing. Avoid heavily compressed or low-quality images, as these may result in the loss of important details.

Keep in mind that Maia analyzes only the structure of the image. Maia does not change the theming of your app, such as the color scheme. This can cause some differences between the provided image and the generated page.

## Read More

* [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/)
Original file line number Diff line number Diff line change
Expand Up @@ -54,21 +54,7 @@ The chat interface appears at the right side of Studio Pro under the **Maia** pa

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

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

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.

#### Maia Chat Features in Studio Pro

After a question is sent to Maia Chat, you will see the following in the chat interface:

* An answer generated by Maia Chat
* Links to top relevant resources like Mendix documentation, Mendix Community, and Academy learning paths

{{% alert color="info" %}}You can also see the Mendix version of the references, the level of the learning path if the reference comes from Mendix Academy, and the date and answer status if the reference comes from the Mendix Community.{{% /alert %}}

* A copy icon ({{% icon name="copy" %}}) which allows you to copy the given answer to a clipboard
* Feedback icons
For tips on getting better responses, see the [Best Practices](/portal/maia/#best-practices) section in *Maia in Mendix Portal*.

##### Giving Feedback {#feedback}

Expand All @@ -85,18 +71,6 @@ There are several ways to give feedback on the generated answer:
* You can also provide **Additional feedback** if you want to.
* Remember to click **Submit feedback** to submit your feedback. Afterwards, you will be brought back to the main chat interface where you can continue asking questions.

##### Asking Follow-Up Questions

Maia Chat supports asking follow-up questions based on your previous question and the answer you have received. For example, you can ask it to summarize the latest answer you received by typing the following in the chat: *Can you summarize that?*.

{{% alert color="info" %}}
Maia Chat will lose track of the conversation history if you exit Studio Pro.
{{% /alert %}}

##### New Chat

There is a **New chat** option at the top left of the chat interface. It allows you to clear the messages and start a new conversation which does not reference your current chat.

## Read More

Under the **Maia** pane, there is also a tab called **Learn**. For more information, see [Maia Learn](/refguide/maia-learn/).
Under the **Maia** pane, there is a tab called **Learn**. For more information, see [Maia Learn](/refguide/maia-learn/).
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ There are two ways to use Maia Explain:
* Use the chat interface directly to get explanations of your document (for instance, a microflow or a page).
* In the App Explorer, right-click a document to open its context menu, and click **Maia Explain**.

{{% alert color="info" %}}
Nanoflows are currently not supported by Maia Make.
{{% /alert %}}

### In Studio Pro 11.7 and Below

Expand All @@ -47,7 +49,7 @@ Maia Explain supports follow-up questions. You can modify the tone of the answer

* *Explain again, but in 10 words.*
* *Explain again, but in much greater detail. Be very thorough.*
* *What are your suggestions to improve this microflow?"*
* *What are your suggestions to improve this microflow?*

{{% alert color="info" %}}
In this dedicated chat, only requests related to Maia Explain will be properly handled. If you have other questions, close this chat and go back to the general [Maia Chat](/refguide/maia-chat/) interface.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,26 +45,6 @@ Maia for Domain Model does not support deleting items in the domain model. You c
{{% alert color="info" %}}
In this dedicated chat, only requests related to domain model will be properly handled. If you have other questions, close this chat and go back to the general [Maia Chat](/refguide/maia-chat/) interface.
{{% /alert %}}

#### Best Practices for Text Input

To achieve optimal results, provide context about your application by describing its main use cases, customer needs, or other relevant details. The more Maia knows about your application, the more tailored and accurate the generated domain model will be.

Below are some examples of prompts you can use as a starting point:

* The app will help users ...
* This module handles ...
* Customers need to be able to ...
* I want to send notifications when ...
* The app will analyze and report on ...
* This feature allows users to ...

Below are examples of prompts you can use to ask Maia for explanations or suggestions to improve a domain model:

* Can you explain the function and purpose of this domain model?
* I want to add an attribute `ATTRIBUTE_NAME` to the entity `ENTITY_NAME`.
* I want to make the domain model more efficient. Can you suggest optimizations?
* Could you identify any potential issues with this domain model and recommend solutions?

#### Attachment Requirements {#attachment-requirements}

Expand Down
Loading
Loading