Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
6d5b33a
Update Maia Chat
quinntracy Aug 27, 2026
e670cde
Maia Explain
quinntracy Aug 27, 2026
da692da
Add Best Practices
quinntracy Aug 27, 2026
51367f5
Remove section
quinntracy Aug 27, 2026
73e287a
Add Microflows section to Best Practices
quinntracy Aug 27, 2026
2fb3498
Update Microflow warnings
quinntracy Aug 27, 2026
3ff8365
Move Workflows best practices to Maia Make
quinntracy Aug 27, 2026
c7bd6c5
Review Maia Make Capabilities
quinntracy Aug 27, 2026
a00341a
Review Maia Chat
quinntracy Aug 28, 2026
a4a42eb
Review Maia Explain
quinntracy Aug 28, 2026
bcb9492
Review Domain Model
quinntracy Aug 31, 2026
f4b58ee
Review Pages
quinntracy Aug 31, 2026
ab9f26f
Review Microflows
quinntracy Aug 31, 2026
bf14971
Review Workflows
quinntracy Aug 31, 2026
53e5552
Review OQL
quinntracy Aug 31, 2026
4de7d7f
Review MCP
quinntracy Sep 1, 2026
74245e0
Review MCP Pro Server
quinntracy Sep 1, 2026
a1c2e5b
Reivew Web Fetch
quinntracy Sep 1, 2026
e5b21e2
Review Agent Skills
quinntracy Sep 1, 2026
592bd63
Review Instructions
quinntracy Sep 1, 2026
4ec6309
Edits
quinntracy Sep 1, 2026
98c8671
Move descriptions
quinntracy Sep 1, 2026
49cb579
Description
quinntracy Sep 1, 2026
1d8b54f
Links
quinntracy Sep 1, 2026
91beec0
Merge branch 'development' into qt-mmrestructure
quinntracy Sep 7, 2026
6c358a9
Merge branch 'development' into qt-mmrestructure
quinntracy Oct 1, 2026
6e9b363
Revise feedback
quinntracy Oct 1, 2026
83ef2e8
Delete Microflows doc and move limitation to Index
quinntracy Oct 1, 2026
9f5f392
Remove Microflows page and change Skills and Instructions title
quinntracy Oct 1, 2026
7f7fd87
Remove Mircroflow doc and change tltle for Skills and Instructions
quinntracy Oct 1, 2026
02be41a
Adjust info box about BYO Agent
quinntracy Oct 1, 2026
91d0112
Adjust links
quinntracy Oct 1, 2026
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
86 changes: 64 additions & 22 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. You must be signed in to Studio Pro unless you have configured a bring your own agent (BYO Agent).
{{% /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.

For guidance on how to best prompt Maia, refer to [Prompt Engineering](/agents/prompt-engineering/).

Expand All @@ -31,7 +31,7 @@ Maia Make can generate new documents, modify existing documents, and explain app
| --- | --- | --- |
| [Domain model](/refguide/maia-for-domain-model/) | Studio Pro 11.8 | |
| [Pages](/refguide/maia-for-pages/) | Studio Pro 11.8 | |
| [Microflows](/refguide/maia-for-microflows/) | Studio Pro 11.8 | |
| Microflows | Studio Pro 11.8 | In Studio Pro 11.9 and above, Maia can delete flows and microflow objects, but cannot change activity types or replace complex configuration settings. In Studio Pro 11.8, Maia can change variable names, move objects, and reconnect flows for existing objects, but cannot delete objects or flows or change activity types. |
| [Workflows](/refguide/maia-for-workflows/) | Studio Pro 11.9 | |
| [OQL](/refguide/maia-for-oql/) | Studio Pro 11.9 | |
| View entities | Studio Pro 11.9 | |
Expand All @@ -53,7 +53,7 @@ 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 | |
Expand All @@ -68,7 +68,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 @@ -85,18 +85,14 @@ 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.

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/).
{{% /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.
{{% /alert %}}

### Maia Make Capabilities Interface Overview

The conversational interface includes the following features.
Expand All @@ -105,39 +101,39 @@ The conversational interface includes the following features.

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 @@ -194,10 +190,56 @@ 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 {#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 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?

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

### Microflows {#microflows-best-practices}

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.

### Workflows {#workflows-best-practices}

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

## Read More

* [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Maia Agent Instructions (AGENTS.md)"
title: "Agent Instructions (AGENTS.md)"
linktitle: "Agent Instructions"
url: /refguide/maia-agent-instructions/
aliases:
Expand All @@ -12,14 +12,14 @@ description: "Describes how to create and manage agent instructions (AGENTS.md)
## Introduction

{{% alert color="info" %}}
This feature was released as part of [Maia Make](/refguide/maia-make/) capabilities in Studio Pro 11.12.
This feature is part of [Maia Make](/refguide/maia-make/) and was introduced in Studio Pro 11.12.

To use Agent Instructions, an internet connection and signing in to Studio Pro are required.
To use Agent Instructions, you need an internet connection and must be signed in to Studio Pro. If you are using the [MCP Server](/refguide/studio-pro-mcp-server/#enabling-the-mcp-server) to bring your own agent (BYO Agent), you do not need to be signed in to Studio Pro.
{{% /alert %}}

Agent Instructions are instructions that are automatically added to the conversation context. They let you define shared prompt context, such as company conventions or environment restrictions, once and reuse it when needed.

They can be provided at the project level or module level. Project-level instructions are included in every conversation in the project. Module-level instructions are included whenever Maia starts working in the given module.
They can be provided at the project level or module level. Project-level instructions are included in every conversation in the project. Module-level instructions are included whenever Maia starts working in that module.

Agent Instructions follow the [AGENTS.md standard](https://agents.md) for agent instructions.

Expand All @@ -37,23 +37,22 @@ Maia supports both [agent skills](/refguide/maia-agent-skills/) and agent instru

To create a new agent instruction, follow these steps:

1. In the **App Explorer**, find either the **Maia** node under **App** for project-level instructions, or the **Maia** node under a module if you wish to add a module-level instruction.
1. In the **App Explorer**, find either the **Maia** node under **App** for project-level instructions, or the **Maia** node under a module if you want to add a module-level instruction.
2. Right-click this node and click **Add** > **Agent instructions**.

Studio Pro creates the `AGENTS.md` file. You can continue adding the instruction content.
Studio Pro creates the `AGENTS.md` file. You can now add the instruction content.

{{% alert color="info" %}}Newly added instructions or changes to existing instructions are discovered only when new session is started.{{% /alert %}}
{{% alert color="info" %}}New instructions and changes to existing instructions take effect only when you start a new session.{{% /alert %}}

### Instructions Content {#instructions-content}

Agent Instructions are arbitrary Markdown files that follow the AGENTS.md standard. You can structure them any way you like.

However, it is recommended to include only instructions that are applicable to every prompt in the given project or module. For example, you can add naming conventions, limitations of your environment, or language preferences to the agent instructions. If the instructions are applicable only when working with a single module in the project, you should add instructions at the module level.
However, Mendix recommends including only instructions that are applicable to every prompt in the given project or module. For example, you can add naming conventions, environment limitations, or language preferences. If the instructions apply only to a single module, add them at the module level.

### Directory Structure {#directory-structure}

Project-level instructions are stored as `skillssource/AGENTS.md`, while module-level instructions are stored as
`skillssource/_modules/<module_name>/AGENTS.md`. You can add only one instructions file per project or per module.
Project-level instructions are stored as `skillssource/AGENTS.md`, while module-level instructions are stored as `skillssource/_modules/<module_name>/AGENTS.md`. You can add only one instructions file per project or per module.

## Read More

Expand Down
Loading
Loading