diff --git a/content/en/docs/deployment/mendix-cloud-deploy/maia-operate/_index.md b/content/en/docs/deployment/mendix-cloud-deploy/maia-operate/_index.md index 1d2e1eca318..fbed244431a 100644 --- a/content/en/docs/deployment/mendix-cloud-deploy/maia-operate/_index.md +++ b/content/en/docs/deployment/mendix-cloud-deploy/maia-operate/_index.md @@ -9,8 +9,8 @@ description_list: true ## Introduction -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. +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. -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. +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/). ## Documents in This Category diff --git a/content/en/docs/developerportal/maia-plan/_index.md b/content/en/docs/developerportal/maia-plan/_index.md index 002374fe8c4..8120e54bb72 100644 --- a/content/en/docs/developerportal/maia-plan/_index.md +++ b/content/en/docs/developerportal/maia-plan/_index.md @@ -11,6 +11,8 @@ description_list: true Maia Plan helps you create a detailed project plan, based on which you can then generate your app with [Maia Make](/refguide/maia-make/). The pages in this category describe how to provide project context, review and refine the generated project scope, and approve the solution proposal to start app development. +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/). + {{< figure src="/attachments/developerportal/maia/maia-create-app.png" alt="Plan and build with Maia entry point" max-width=50% >}} ## Documents in This Category diff --git a/content/en/docs/mendix-portal/maia-portal.md b/content/en/docs/mendix-portal/maia-portal.md index f40a437ff92..b7a2530cd73 100644 --- a/content/en/docs/mendix-portal/maia-portal.md +++ b/content/en/docs/mendix-portal/maia-portal.md @@ -11,7 +11,9 @@ 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" 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" alt="Maia in Mendix Portal" width="500" >}} ## Maia Capabilities in Mendix Portal @@ -49,7 +51,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 and above. See [Maia Chat](/refguide/maia-chat/) for more information. +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 in the Maia Make chat. For more information, see [Questions and Guidance in Maia Make](/refguide/maia-chat/). For information on Mendix data storage policies and practices for Maia, see [Maia Privacy Policy](https://www.mendix.com/legal/privacy/maia/). diff --git a/content/en/docs/private-platform/pmp-maia.md b/content/en/docs/private-platform/pmp-maia.md index 879259d290c..8ba1ff811ca 100644 --- a/content/en/docs/private-platform/pmp-maia.md +++ b/content/en/docs/private-platform/pmp-maia.md @@ -9,6 +9,8 @@ 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: @@ -16,7 +18,7 @@ Mendix AI Assistance (Maia) in Private Mendix Platform has the following capabil 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 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/). +* **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/). Recommenders: diff --git a/content/en/docs/quickstarts/responsive-web-app.md b/content/en/docs/quickstarts/responsive-web-app.md index 6be56b5e7d5..142586826d6 100644 --- a/content/en/docs/quickstarts/responsive-web-app.md +++ b/content/en/docs/quickstarts/responsive-web-app.md @@ -92,7 +92,7 @@ When you launch **Studio Pro** for the first time, you’ll see the **Welcom** t * [Maia Learn](/refguide/maia-learn/) – learning materials to help you get started -* [Maia Chat](/refguide/maia-chat/) – an AI-powered assistant for quick support and guidance +* [Maia Make](/refguide/maia-make/) – the Maia chat, where you can build with Maia and get quick answers, support, and guidance We recommend watching the introduction videos to get familiar with the basic concepts of Mendix development before you start building your app. {{% /alert %}} @@ -145,11 +145,11 @@ You have created a new persistable entity called **Employee**. This means the en {{< figure src="/attachments/quickstarts/part1/7.2 CreateAttributes.png" width="450px" alt="Create attributes on an entity">}} {{% alert type="info" %}} -You can create a domain model by simply describing your application using [Maia for Domain Model](/refguide/maia-for-domain-model/) an AI-powered tool that generates domain models based on your input. +You can also create a domain model by describing your application to Maia. Maia generates the domain model based on your input. For more information, see [Domain Models in Maia Make](/refguide/maia-for-domain-model/). -To use it, **click Maia for Domain Model** in the **Working Area**, then describe your application in the chat box on the right. +To use it in Studio Pro 11.8 and above, open the **View** menu and select the **Maia** pane, then describe your application in the chat. In Studio Pro 11.7 and below, click **Maia for Domain Model** in the **Working Area**, then describe your application in the chat box on the right. -In our case, you can ask Maia: “Create a domain model that stores employee information: first name, last name, job role, and employee ID.” +In this case, you can ask Maia: “Create a domain model that stores employee information: first name, last name, job role, and employee ID.” {{% /alert %}} ### Add an Association @@ -260,7 +260,9 @@ Throughout this guide, you built your **Employee** app by hand—dragging entiti Unlike a typical chatbot that only answers questions, Maia is agentic: it can read your app's current domain model, pages, and logic, understand the context you are working in, and then directly create or modify app elements on your behalf. Ask it to add an entity, generate a page, or build out a microflow, and it will produce real, editable Studio Pro artifacts—not just a suggestion or a code snippet for you to copy in. -Maia is not one single feature but a collection of capabilities woven into Studio Pro. [Maia Make](/refguide/mendix-ai-assistance/), is a conversational interface where you describe what you want in plain language and Maia generates the domain model changes, pages, or microflows to match. Within Maia Make are focused generators (for domain models, pages, workflows, and OQL queries), recommenders that suggest the next best widget or microflow activity as you build, and guidance tools like [Maia Chat](/refguide/maia-chat/) and [Maia Explain](/refguide/mendix-ai-assistance/) for when you want an explanation rather than a change to your app. As you grow more advanced, [Maia Agent Skills](/refguide/maia-agent-skills/) and Agent Instructions let you teach Maia your team's own conventions so Maia's suggestions stay consistent with how your organization builds apps. +Maia is not one single feature but a collection of capabilities woven into Studio Pro. [Maia Make](/refguide/maia-make/) is a conversational interface where you describe what you want in plain language, and Maia generates the corresponding model elements, such as domain models, pages, or microflows, to match. In the same chat, you can create workflows and OQL queries, ask questions, or ask [Maia Explain](/refguide/maia-explain/) to understand existing functionalities without changing your app. + +Next to Maia Make, recommenders suggest the next best widget or microflow activity as you build. As you grow more advanced, [Maia Agent Skills](/refguide/maia-agent-skills/) and Agent Instructions let you teach Maia your team's own conventions so Maia's suggestions stay consistent with how your organization builds apps. ### Try It Yourself: Extending the Employee App diff --git a/content/en/docs/refguide/general/studio-pro-overview/keyboard-shortcuts.md b/content/en/docs/refguide/general/studio-pro-overview/keyboard-shortcuts.md index 2b6ae960d24..f64e127fca3 100644 --- a/content/en/docs/refguide/general/studio-pro-overview/keyboard-shortcuts.md +++ b/content/en/docs/refguide/general/studio-pro-overview/keyboard-shortcuts.md @@ -206,9 +206,9 @@ The following shortcut keys are assigned to menu actions that can be used in all | Ctrl + Shift + W | Command + Shift + W | Closes all document tabs. | | Delete | Delete | Deletes the selected element. | -## Maia Chat Shortcut Keys {#maia-chat-shortcuts} +## Maia Shortcut Keys {#maia-chat-shortcuts} -You can use the following shortcut keys in [Maia Chat](/refguide/maia-chat/), including on the feedback page: +You can use the following shortcut keys in the [Maia Make](/refguide/maia-make/) chat. In Studio Pro 11.7 and below, these shortcuts work in [Maia Chat](/refguide/maia-chat/), including on the feedback page: | Windows | Mac | Description | | --- | --- | --- | diff --git a/content/en/docs/refguide/mendix-ai-assistance/_index.md b/content/en/docs/refguide/mendix-ai-assistance/_index.md index cc6cc37bb90..ae9d46155b3 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/_index.md +++ b/content/en/docs/refguide/mendix-ai-assistance/_index.md @@ -2,16 +2,25 @@ title: "Mendix AI Assistance (Maia)" url: /refguide/mendix-ai-assistance/ weight: 17 -description: "Describes Mendix AI Assistance (Maia) in Studio Pro." +description: "Describes Mendix AI Assistance (Maia), the agentic development capability that supports you across the application lifecycle in Mendix Portal, Studio Pro, and Mendix Cloud." aliases: - /refguide/mx-assist-studio-pro/ --- ## Introduction -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. +Mendix AI Assistance (Maia) is the agentic development capability of the Mendix Platform. With agentic development, you give an agent a development goal, and the agent carries out the work: it determines which documents to create or change, uses tools, and asks clarifying questions when it needs more information. You direct the work and review the result. Maia supports you in this way across the full application lifecycle: from learning and planning, through modeling and building, to quality improvement, operation, and the ongoing evolution of your app. -Mendix developers can use Maia to get guidance by asking questions, get recommendation and assistance for certain development tasks, and even generate part of their app. +Maia is not a single feature. It is a set of capabilities that share one foundation: the Mendix app model. A Mendix app consists of model documents, such as domain models, pages, microflows, and workflows. Maia reads and changes these same documents. When Maia generates a microflow, the result is a regular microflow that you can open, inspect, and change in Studio Pro, just like a microflow that you model yourself. + +This foundation has the following practical results for you as a developer: + +* **Maia is model-aware** – Maia works with your app as context. For example, when Maia generates a page, it knows the domain model of the module that you work in. You can also add specific documents to the conversation as extra context. +* **You can review everything** – Generated and changed documents appear in the regular Studio Pro editors. Studio Pro checks them for consistency errors in the same way as documents that you create yourself. +* **You stay in control** – You decide what Maia builds, you review the changes, and you can undo them. You commit the changes to version control when you are satisfied. +* **Maia is open** – You can extend Maia with your own conventions, connect Maia to external tools, use your own AI provider, or use your own agent with Studio Pro. Agent instructions and agent skills follow industry standards, so they work with any agentic tool. + +Maia works with professional developers. It does not replace them. Maia takes on tasks such as creating a first version of a document, applying conventions, explaining existing logic, and detecting anti-patterns. You keep ownership of the requirements, the architecture, and the quality of your app. For more information on this approach, see [Agentic and Model-Driven Development](/refguide/agentic-development/). Maia does not use any project, customer, company, or user-entered data for model training. Maia operates on pre-trained, off-the-shelf large language models (LLMs). For more information on Mendix data storage policies and practices for Maia, see [Maia Privacy Policy](https://www.mendix.com/legal/privacy/maia/). @@ -25,72 +34,128 @@ For information on what third-party services Maia uses and what data are sent to For more information on how to ensure optimal performance of Maia, see the [Best Practice for Maia Performance](#maia-performance-best-practice) section below. -## Maia Usage Limits {#maia-usage} +## Maia Across the Application Lifecycle {#lifecycle} -To ensure a reliable experience with Maia, Mendix provides two ways to manage your usage: purchasing Maia Units and configuring a custom AI provider of your choice. Every company receives 2400 free units per month and can purchase more as needed. +Maia is available at each stage of the application lifecycle. In Studio Pro, Maia Make is the single chat interface for all build stages: in one conversation, you can create and change any part of your model, such as data, logic, UI, workflows, and translations, and ask for guidance. The table below gives an overview. For a detailed description of each stage, including example prompts, see [Maia Across the Development Lifecycle](/refguide/maia-development-lifecycle/). -When your free Maia Units allocation or purchased Maia Units have been consumed, you receive a notification in Studio Pro indicating that you need to take action before you can use Maia Make again. Your allocation resets at the start of each month. To increase your capacity, you can purchase additional Maia Units. For more information on purchasing Maia Units, see [Increasing Your Maia Usage Capacity](/control-center/maia-resources/#increase-maia-units). +| Lifecycle Stage | How Maia Helps | Capabilities | +| --- | --- | --- | +| Discover and learn | Explains Mendix concepts and answers development questions. | [Maia Learn](/refguide/maia-learn/), [Maia Make](/refguide/maia-chat/) | +| Plan and design | Turns an app idea into a project scope, epics, and user stories. | [Maia Plan](/developerportal/maia-plan/), [Create Story with Maia and Refine Story with Maia](/portal/maia/#maia-capabilities-in-mendix-portal) | +| Generate the app | Generates a first version of an app from a description, an image, a PDF, or a plan. | [Start with Maia](/refguide/start-with-maia/), [Maia Make](/refguide/maia-make/) | +| Model data | Generates and changes domain models, view entities, enumerations, and OQL queries. | [Maia Make](/refguide/maia-make/): [domain models](/refguide/maia-for-domain-model/), [OQL](/refguide/maia-for-oql/) | +| Create logic | Generates and changes microflows, recommends the next activity in a flow, and builds validation logic. | [Maia Make](/refguide/maia-make/), [Logic Recommender](/refguide/logic-recommender/), [Validation Assist](/refguide/validation-assist/) | +| Create UI | Generates and changes pages, navigation, menus, and theme styling. Recommends widgets in the page editor. | [Maia Make](/refguide/maia-make/): [pages](/refguide/maia-for-pages/), [UI Recommender](/refguide/ui-recommender/) | +| Create workflows | Generates workflows from a process description or a BPMN image. Recommends the next workflow activity. | [Maia Make](/refguide/maia-make/): [workflows](/refguide/maia-for-workflows/), [Workflow Recommender](/refguide/workflow-recommender/) | +| Integrate | Creates JSON structures and data transformers, reads public APIs, and uses tools from external MCP servers. | [Maia Make](/refguide/maia-make/), [Maia Web Fetch](/refguide/maia-web-fetch/), [Maia MCP Client](/refguide/maia-mcp/) | +| Understand and get guidance | Explains existing documents and consistency errors, and applies your team conventions. | [Maia Make](/refguide/maia-make/), [Maia Explain](/refguide/maia-explain/), [Agent Instructions](/refguide/maia-agent-instructions/), [Agent Skills](/refguide/maia-agent-skills/) | +| Improve quality | Detects anti-patterns, explains their impact, and fixes some of them automatically. Explains and solves consistency errors. | [Best Practice Recommender](/refguide/best-practice-recommender/), [Maia Make](/refguide/maia-make/#maia-make-general-capabilities) | +| Localize | Creates and updates translations of the texts in your app (Maia Make in Studio Pro 11.15 and above). | [Maia Make](/refguide/maia-make/), [Translation Generator](/refguide/translation-generator/) | +| Work with external AI agents | Lets external AI agents use Maia capabilities, and lets Maia use your own AI provider. | [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/), [Maia Plan as MCP Server](/developerportal/maia-plan-mcp/), [Custom AI provider](/refguide/maia-make/#custom-provider) (beta) | +| Operate and evolve | Summarizes application logs, organizes end-user feedback, and changes existing documents for new requirements. | [AI Log Summary](/developerportal/maia-operate/ai-log-summary/) (beta), [Maia for Feedback](/portal/maia/#maia-capabilities-in-mendix-portal), [Maia Make](/refguide/maia-make/) | -If you need uninterrupted access to Maia capabilities, you can [configure a custom AI provider](/refguide/maia-make/#custom-provider) to use your own LLM provider. +## Ways to Work with Maia {#ways-to-work} -Alternatively, you can use the Studio Pro MCP Server's bring your own agent (BYO Agent) capabilities, which allows you to use Maia's capabilities directly from external clients, including AI coding assistants, agents, and other MCP-based LLM tools. For more information on the Studio Pro MCP Server, see [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/). +You can work with Maia in different ways. Choose the way that fits your task: -## Network Configuration Requirements {#maia-network-requirement} +* **Agentic development in Studio Pro** – Use [Maia Make](/refguide/maia-make/) in the **Maia** pane. It is the single chat interface for building with Maia. Describe the goal, and Maia creates or changes the necessary documents, whether they are data, logic, UI, workflows, or translations. You can also ask questions and get explanations in the same conversation. +* **In-editor recommendations in Studio Pro** – Use the recommenders while you model. They suggest the next activity, widget, or fix in the editor that you have open. Most recommenders work offline and do not send data to third-party services. +* **Planning and collaboration in Mendix Portal** – Use [Maia in Mendix Portal](/portal/maia/) to plan an app, write and refine user stories, and organize feedback. +* **Operations in Mendix Cloud** – Use [Maia Operate](/developerportal/deploy/maia-operate/) to get AI-generated insights into apps that run on Mendix Cloud. +* **Your own agent or AI provider** – Use the [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/) to work with Maia capabilities from your own agent, or [configure a custom AI provider](/refguide/maia-make/#custom-provider) for Maia. For an overview of these options, see [Using Maia with External AI Agents](/refguide/maia-external-agents/). -To ensure the smooth operation of Mendix AI Assistance (Maia), the following network requirements must be met: +## Maia Capabilities in Mendix Studio Pro {#maia-capabilities-in-mendix-studio-pro} -* Ensure access to hostnames within the `maia.mendix.com` and `mxassist.rnd.mendix.com` subdomains -* Allow secure network traffic through port 443 (HTTPS) to enable uninterrupted operation of Maia +Mendix AI Assistance (Maia) in Studio Pro has the following capabilities. -## Maia Capabilities in Mendix Studio Pro +### Starting Points -Mendix AI Assistance (Maia) in Studio Pro has the following capabilities: +* **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/). -Starting point for app creation: +### Agentic Development with Maia Make -* **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 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. +* **Maia Make** – a unified conversational interface in Studio Pro that groups all agentic development capabilities into a single chat experience. Start a conversation, describe what you need, and Maia creates or changes the necessary parts of your model, such as the domain model, microflows, pages, workflows, and, in Studio Pro 11.15 and above, translations. In the same conversation, you can ask questions and ask Maia to explain documents, such as your app logic and pages. This unified conversational interface was released in Studio Pro 11.8. For more information, see [Maia Make](/refguide/maia-make/). -Guidance: +Maia Make replaces the earlier document-specific tools Maia for Domain Model, Maia for Pages, Maia for OQL, and Maia for Workflows. Domain models and pages are part of Maia Make from Studio Pro 11.8. OQL and workflows are part of Maia Make from Studio Pro 11.9. The following pages describe what Maia Make can do for each of these document types, and how the earlier tools work in older versions: + +* **Domain models** – Maia generates new [domain models](/refguide/domain-model/), and explains and suggests improvements for existing domain models. For more information, see [Domain Models in Maia Make](/refguide/maia-for-domain-model/). -* **Maia Chat** – a built-in chat interface powered by Generative AI in Studio Pro. It answers questions about app development in Mendix, including how to apply concepts, best practices, and development patterns. For more information, see [Maia Chat](/refguide/maia-chat/). + For Private Mendix Platform, this feature is supported for version 11.6 and newer. + +* **Pages** – Maia generates a [page](/refguide/page/) and adds and configures widgets based on a text input and an optional image. You can continue in the same conversation to ask Maia for further improvements and explanations. For more information, see [Pages in Maia Make](/refguide/maia-for-pages/). + + For Private Mendix Platform, this feature is supported for version 11.6 and newer. + +* **OQL** – Maia generates and manages OQL (Object Query Language) queries. For more information, see [OQL in Maia Make](/refguide/maia-for-oql/). +* **Workflows** – Maia generates a [workflow](/refguide/workflows/) from a use case in text or an image. For more information, see [Workflows in Maia Make](/refguide/maia-for-workflows/). + +For all document types that Maia Make supports, see the [Supported Document Types](/refguide/maia-make/#supported-document-types) section of *Maia Make Capabilities*. + +### Guidance and Learning + +In Studio Pro 11.8 and above, you ask questions and request explanations in the Maia Make chat. Maia Make supersedes Maia Chat, the earlier chat interface in Studio Pro. + +* **Questions and guidance** – ask questions about app development in Mendix in the Maia Make chat, including how to apply concepts, best practices, and development patterns. For more information, see [Questions and Guidance in Maia Make](/refguide/maia-chat/). * **Maia Learn** – helps you to quickly learn Mendix core concepts and get started with Studio Pro. For more information, see [Maia Learn](/refguide/maia-learn/). -* **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. For more information, see [Maia Explain](/refguide/maia-explain/). -* **Maia Agent Skills** – lets you define modular, reusable instructions that extend Maia with domain-specific knowledge. Maia applies them automatically whenever relevant, eliminating the need to repeat the same context across conversations. For more information, see [Maia Agent Skills (SKILLS.md)](/refguide/maia-agent-skills/). +* **Maia Explain** – helps you understand existing documents, such as microflows and pages. It explains the general purpose of the document and highlights specific technical details. For more information, see [Maia Explain](/refguide/maia-explain/). + +### Context and Customization + * **Maia Agent Instructions** – allows you to define project- or module-level instructions (AGENTS.md) that steer agent behavior. You can use them to set common context for your prompts, such as company conventions or environment restrictions. For more information, see [Maia Agent Instructions (AGENTS.md)](/refguide/maia-agent-instructions/). +* **Maia Agent Skills** – lets you define modular, reusable instructions that extend Maia with domain-specific knowledge. Maia applies them automatically whenever relevant, which removes the need to repeat the same context across conversations. For more information, see [Maia Agent Skills (SKILLS.md)](/refguide/maia-agent-skills/). +* **Maia MCP Client** – connects Maia to external MCP servers, giving it access to third-party tools during chat. For more information, see [Maia MCP Client](/refguide/maia-mcp/). +* **Maia Web Fetch** – lets Maia fetch and read content from public websites and APIs, after you approve the request. For more information, see [Maia Web Fetch](/refguide/maia-web-fetch/). -Recommenders: +### Recommenders -* **Best Practice Recommender** – helps you inspect your app against Mendix development best practice detecting and pinpointing development anti-patterns and, in some cases, automatically fixing them. For more information, see [Best Practice Recommender](/refguide/best-practice-recommender/). +* **Best Practice Recommender** – helps you inspect your app against Mendix development best practices. It detects and pinpoints development anti-patterns and, in some cases, fixes them automatically. For more information, see [Best Practice Recommender](/refguide/best-practice-recommender/). * **Logic Recommender** – helps you model and configure microflows, nanoflows, and rules in Mendix Studio Pro. It gives you contextualized recommendations on the next best activity based on the activities and parameters that are already configured in your application. For more information, see [Logic Recommender](/refguide/logic-recommender/). -* **UI Recommender** – helps you easily add new widgets to a page in Mendix Studio Pro without losing the context of what you are currently working on. For more information, see [UI Recommender](/refguide/ui-recommender/). +* **UI Recommender** – helps you add new widgets to a page in Mendix Studio Pro without losing the context of what you are currently working on. For more information, see [UI Recommender](/refguide/ui-recommender/). * **Workflow Recommender** – helps you model and configure workflows in Mendix Studio Pro. It gives you contextualized recommendations on the next best activity in your workflow based on context-related information. For more information, see [Workflow Recommender](/refguide/workflow-recommender/). +* **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/). -Generators: +### Localization -* **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/). +* **Translation Generator** – helps you with [batch translate](/refguide/translation-generator/#batch-translate) and [translating system texts](/refguide/translation-generator/#translate-system-text) in the web-based system texts editor. For more information, see [Translation Generator](/refguide/translation-generator/). - For Private Mendix Platform, this feature is supported for version 11.6 and newer. - -* **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/). +### External AI Agents and AI Providers - For Private Mendix Platform, this feature is supported for version 11.6 and newer. +* **Studio Pro MCP Server** – exposes Maia capabilities to external AI agents and AI coding assistants through the Model Context Protocol (MCP). This is also known as bring your own agent (BYO Agent). For more information, see [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/). +* **Custom AI provider** – lets Maia use your own LLM provider instead of the Mendix platform AI service. This is also known as bring your own LLM (BYO LLM). It is available in Studio Pro 11.12 and above as a beta feature. For more information, see the [Configuring a Custom AI Provider](/refguide/maia-make/#custom-provider) section in *Maia Make Capabilities*. -* **Maia for OQL** – helps you generate and manage OQL (Object Query Language) queries through an intuitive interface. It is designed to simplify query creation and reduce manual effort. For more information, see [Maia for OQL](/refguide/maia-for-oql/). -* **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/). -* **Translation Generator** – helps you with [batch translate](/refguide/translation-generator/#batch-translate) and [translating system texts](/refguide/translation-generator/#translate-system-text) in the web-based system texts editor. For more information, see [Translation Generator](/refguide/translation-generator/). -* **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/). +For an overview of how these options work together, see [Using Maia with External AI Agents](/refguide/maia-external-agents/). ## Maia in Mendix Portal -Various Maia features are available in Mendix Portal. For more information, refer to [Maia in Mendix Portal](/portal/maia/). +Maia in Mendix Portal supports the planning and collaboration stages of the lifecycle. You can use Maia Plan to turn an app idea into a project scope and solution, create and refine user stories, organize end-user feedback, and ask questions in Maia Chat. For more information, refer to [Maia in Mendix Portal](/portal/maia/). + +## Maia in Mendix Cloud + +Maia Operate supports the operation stage of the lifecycle for apps that run on Mendix Cloud. For example, AI Log Summary, which is in Public Beta, gives you an AI-generated overview of the log activity of an environment. For more information, refer to [Maia Operate](/developerportal/deploy/maia-operate/). ## Maia in Private Mendix Platform Various Maia features are available in Private Mendix Platform. For more information, refer to [Maia in Private Mendix Platform](/private-mendix-platform/maia/). +## Maia Usage Limits {#maia-usage} + +To ensure a reliable experience with Maia, Mendix provides two ways to manage your usage: purchasing Maia Units and configuring a custom AI provider of your choice. Every company receives 2400 free units per month and can purchase more as needed. + +When your free Maia Units allocation or purchased Maia Units have been consumed, you receive a notification in Studio Pro indicating that you need to take action before you can use Maia Make again. Your allocation resets at the start of each month. To increase your capacity, you can purchase additional Maia Units. For more information on purchasing Maia Units, see [Increasing Your Maia Usage Capacity](/control-center/maia-resources/#increase-maia-units). + +If you need uninterrupted access to Maia capabilities, you can [configure a custom AI provider](/refguide/maia-make/#custom-provider) to use your own LLM provider. + +Alternatively, you can use the Studio Pro MCP Server's bring your own agent (BYO Agent) capabilities, which allows you to use Maia's capabilities directly from external clients, including AI coding assistants, agents, and other MCP-based LLM tools. For more information on the Studio Pro MCP Server, see [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/). + +## Network Configuration Requirements {#maia-network-requirement} + +To ensure the smooth operation of Mendix AI Assistance (Maia), the following network requirements must be met: + +* Ensure access to hostnames within the `maia.mendix.com` and `mxassist.rnd.mendix.com` subdomains +* Allow secure network traffic through port 443 (HTTPS) to enable uninterrupted operation of Maia + ## Maia Third-Party Services {#maia-third-party-services} {{% alert color="info" %}} @@ -99,6 +164,8 @@ As of Studio Pro 11.12, Maia Make uses Claude Sonnet 4.6. [Maia Make](/refguide/maia-make/) introduced in Studio Pro 11.8 uses Claude Sonnet 4.5. Any Maia Make capability in Studio Pro 11.8 and above uses this model to generate Mendix models. +If you [configure a custom AI provider](/refguide/maia-make/#custom-provider), Maia Make sends requests to the provider that you configure instead. + The table below presents all the third-party services each Maia capability uses for Studio Pro versions below 11.8, and what data are sent to the third-party services. | Maia | Third-Party Service | Data Sent to Third-Party Service | @@ -116,7 +183,7 @@ The table below presents all the third-party services each Maia capability uses | Maia for OQL | [Claude in Amazon Bedrock](https://aws.amazon.com/bedrock/claude/) | Project context to fulfill user prompt request | | Maia for Workflows | [Claude in Amazon Bedrock](https://aws.amazon.com/bedrock/claude/) | Project context to fulfill user prompt request | | Translation Generator | [Amazon Translate](https://aws.amazon.com/translate/) | All translatable texts in the application, for example, labels, button names, and menu items | -| Validation Assist | No third-party services used | NA | +| Validation Assist | No third-party services used | N/A | | Maia Rewrite | [Claude in Amazon Bedrock](https://aws.amazon.com/bedrock/claude/) | The draft question description from users | | Maia Summarize | [Claude in Amazon Bedrock](https://aws.amazon.com/bedrock/claude/) | [Community](https://community.mendix.com/p/community) threads | | Maia Create User Story | [Claude in Amazon Bedrock](https://aws.amazon.com/bedrock/claude/) | User prompts | @@ -124,3 +191,13 @@ The table below presents all the third-party services each Maia capability uses ## Best Practice for Maia Performance {#maia-performance-best-practice} For optimal performance, Maia works best when handling focused, well-scoped requests. When working on complex or lengthy content generation tasks, you will get faster and more reliable results by breaking them into smaller, manageable steps. This approach not only reduces the risk of network issues, but often leads to higher-quality outputs that better meet your specific needs. + +For more working practices, such as how to give Maia context and how to review its changes, see the [Working Practices for Agentic Development](/refguide/agentic-development/#working-practices) section in *Agentic and Model-Driven Development*. + +## Read More + +* [Agentic and Model-Driven Development](/refguide/agentic-development/) +* [Maia Across the Development Lifecycle](/refguide/maia-development-lifecycle/) +* [Using Maia with External AI Agents](/refguide/maia-external-agents/) +* [Maia Make Capabilities](/refguide/maia-make/) +* [Enrich Your Mendix App with Agentic Capabilities](/agents/) – for building AI features into your apps diff --git a/content/en/docs/refguide/mendix-ai-assistance/agentic-development.md b/content/en/docs/refguide/mendix-ai-assistance/agentic-development.md new file mode 100644 index 00000000000..1fe3230313d --- /dev/null +++ b/content/en/docs/refguide/mendix-ai-assistance/agentic-development.md @@ -0,0 +1,163 @@ +--- +title: "Agentic and Model-Driven Development" +linktitle: "Agentic Development" +url: /refguide/agentic-development/ +weight: 1 +description: "Describes agentic development, how agentic development and model-driven development reinforce each other in Mendix, and how Maia and other agents work with professional developers." +--- + +## Introduction + +AI changes how teams build software. AI agents can now take a development goal, decide which steps are necessary, use tools, and change several parts of an application in one task. This way of working is called agentic development. It creates new questions for development teams, such as: + +* How do you direct an agent? +* How do you keep the quality of its output high? +* How do you review its work? +* What is the role of the developer? + +This document describes what agentic development is, why model-driven development and agentic development reinforce each other, and how Mendix AI Assistance (Maia) and other agents work with professional developers. For an overview of all Maia capabilities, see [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/). + +## What Is Agentic Development {#what-is-agentic-development} + +In agentic development, you give an AI agent a goal, and the agent carries out the development work to reach it. An agent has the following characteristics: + +* **It works toward a goal** – You describe the outcome, for example, a new feature or a change to existing logic. The agent uses this information to determine which documents to create or change. +* **It uses tools** – The agent uses built-in capabilities and connected tools, such as MCP servers or web content, to get information and to make changes. +* **It works across documents** – One request can result in changes to the domain model, pages, and microflows together. +* **It asks when it needs more information** – The agent can ask clarifying questions before it continues. +* **It works with context that you provide** – The agent follows your instructions, conventions, and domain knowledge. + +The developer directs the agent, provides context, and reviews the results, while the agent handles the actual implementation work. + +In Mendix, Maia is the agent built into the platform. In Studio Pro, [Maia Make](/refguide/maia-make/) works as an agent: it uses your app model as context, considers its built-in capabilities and your enabled MCP tools, and creates and changes regular Mendix documents. You can also use your own agent with Studio Pro through the [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/). + +## How Agentic Development Changes Software Delivery {#agentic-changes-delivery} + +In traditional software delivery, a large part of the effort goes into producing the application, such as writing code and modeling each element by hand. Agentic development changes where the effort goes: + +* **From producing to specifying** – The quality of an agent's output depends on how clearly you describe the intended behavior. Provide clear requirements, user stories, and acceptance criteria to help the agent implement the feature as expected. +* **From producing to reviewing** – Agent output can contain mistakes. Review every change to verify they meet the requirements and work correctly within the application. +* **From single steps to complete tasks** – An agent can apply changes to several parts of an app in one task. Define the scope of the task clearly and provide sufficient context and constraints to guide the changes. +* **From individual knowledge to shared context** – An agent rely on the context provided to it. Document team conventions, architecture decisions, and domain knowledge to get more consistent results. + +These shifts apply to all forms of software development. The way a platform represents an application determines how well a team can work with agents within these shifts. + +## Why Model-Driven Development Matters for Agents {#model-driven-for-agents} + +In Mendix, an app is a model. The model consists of documents with a defined structure, such as [domain models](/refguide/domain-model/), [pages](/refguide/page/), [microflows](/refguide/microflows/), and [workflows](/refguide/workflows/). The [Mendix Runtime](/refguide/runtime/) runs this model. This approach has specific advantages when an agent builds or changes an app. + +### A Higher Level of Abstraction + +Model elements describe an app at a higher level than code. For example, a [Retrieve](/refguide/retrieve-objects/) activity in a microflow describes a complete data retrieval, including its source and its constraints. When an agent generates a model, it works at this level. + +### Built-in Validation + +Studio Pro continuously checks the model for [consistency errors](/refguide/consistency-errors/). This check applies to every document, whether you or an agent created it. For example, if a generated microflow refers to an attribute that does not exist, the **Errors** pane shows the error immediately. You do not have to run the app to find this type of mistake. + +In Studio Pro 11.12.1 and above, you can ask Maia to explain or solve a consistency error from the **Errors** pane. + +### Visual Review + +Agents create standard model documents that you can review in the same editors you use to create them. For example, review a generated microflow as a diagram, a generated page in the page editor, and a generated domain model in the domain model editor. + +### Platform-Provided Foundations + +The Mendix Platform provides many foundations of an app, such as the runtime, data persistence, and the [security](/refguide/security/) model. An agent creates the parts that are specific to your app, such as entities, pages, and logic. These parts build on the same platform foundations as documents that you model yourself. + +### One Shared Language for People and Agents + +Developers, business analysts, and agents all work with the same model documents. A user story in Mendix Portal can become a domain model and pages in Studio Pro. An explanation from Maia refers to the same microflows and entities that you see in the **App Explorer**. This shared language reduces the gap between what is asked, what is built, and what is reviewed. + +## How Agents Strengthen Model-Driven Development {#agents-for-model-driven} + +Agents also make model-driven development stronger. Maia helps in the following areas: + +* **Starting** – Maia generates a first version of an app, a module, or a document. You do not start from an empty model. +* **Learning** – New developers learn Mendix concepts with [Maia Learn](/refguide/maia-learn/) and ask questions in the [Maia Make chat](/refguide/maia-chat/) while they model. +* **Understanding** – [Maia Explain](/refguide/maia-explain/) describes the purpose and details of existing logic and pages. This helps when you take over an app that someone else built. +* **Repetitive work** – Maia creates overview pages, validation logic, translations, and similar repetitive parts. You can focus on the parts that need your expertise. +* **Consistency** – [Agent instructions](/refguide/maia-agent-instructions/) and [agent skills](/refguide/maia-agent-skills/) let Maia and other agents apply your team conventions, such as naming rules, every time they create a document. +* **Quality** – [Best Practice Recommender](/refguide/best-practice-recommender/) detects anti-patterns in the model and helps you fix them. + +## The Role of the Developer {#role-of-developer} + +Agents complement professional developers; they do not replace them. An agent can create documents and carry out tasks, but it relies on the context developers provide to understand business requirements, users, and quality standards. In agentic development, the developer directs the work, and the development team remains responsible for the application. + +The table below shows how the work is divided: + +| Activity | Developer | Maia | +| --- | --- | --- | +| Requirements | Defines the problem, the scope, and the acceptance criteria. | Helps turn an idea into a scope, epics, and user stories. | +| Architecture | Decides on the module structure, integrations, and data model. | Proposes domain models and explains existing documents. | +| Building | Gives goals and context, reviews and refines generated documents, and models parts by hand when needed. | Creates and changes documents, and recommends next steps in the editors. | +| Review | Checks each generated or changed document, and decides what to keep. | Shows the list of changed documents, and explains its changes on request. | +| Quality and security | Owns the quality, security, and performance of the app. | Detects anti-patterns and helps solve consistency errors. | +| Delivery | Commits the changes, and deploys and operates the app. | Summarizes logs and organizes feedback for the next iteration. | + +## From Assistance to Agents {#levels} + +Maia offers a range of capabilities, from assistance with single steps to agentic work. Each level gives Maia more responsibility for a task. At each level, you review and approve the result. + +| Level | What Maia Does | Examples | +| --- | --- | --- | +| Guidance | Answers questions and explains concepts or existing documents. Maia does not change your app. |