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..f121e0d73b2 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 @@ -13,4 +13,6 @@ Operating a production application requires continuous monitoring of its health 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. What you learn 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..9f028c70f25 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 you build the app in Studio Pro with Maia Make. External AI agents can also 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..c4a78b902d2 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, and 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 was also available in Studio Pro 10.12.0 to 11.7. In Studio Pro 11.8 and above, Maia Make supersedes Maia Chat, and you ask questions 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..0fcc5589299 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 a description 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 section below lists the capabilities that are available. + ## 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..1d60be977b8 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 build with Maia and get quick 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,9 +145,9 @@ 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 **Maia** pane in the upper-right corner of Studio Pro, 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.” {{% /alert %}} @@ -260,7 +260,7 @@ 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 model elements, such as domain models, pages, or microflows, to match. In the same Maia Make chat, you can create domain models, pages, workflows, and OQL queries, and ask questions or ask [Maia Explain](/refguide/maia-explain/) for an explanation when you want to understand something rather than change 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..70e839e97b4 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, they also 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..d17b4b85395 --- /dev/null +++ b/content/en/docs/refguide/mendix-ai-assistance/agentic-development.md @@ -0,0 +1,158 @@ +--- +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. 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 how Mendix answers these questions. It explains 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. It ends with practical working practices for agentic development in Mendix. + +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 determines 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, gives it context, and reviews its work. The agent does the production work. + +In Mendix, Maia is the agent that is 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: writing code or modeling each element by hand. Agentic development changes where the effort goes: + +* **From producing to specifying** – When an agent produces a first version of a feature, the quality of the result depends on how clearly you describe the intent. Clear requirements, user stories, and acceptance criteria become more important, not less. +* **From producing to reviewing** – Agent output can contain mistakes. Every result needs a review by someone who understands the app. Review becomes a central development activity. +* **From single steps to complete tasks** – An agent can apply changes to several parts of an app in one task. This makes the scope of a single request larger. It also makes context and guardrails more important. +* **From individual knowledge to shared context** – An agent only knows what you give it. Teams that write down their conventions, architecture decisions, and domain knowledge get more consistent results from agents. + +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** 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 also ask Maia to explain or solve a consistency error from the **Errors** pane. + +### Visual Review + +Agents create regular model documents. You review a generated microflow as a diagram, a generated page in the page editor, and a generated domain model in the domain model editor. You use the same editors for documents that an agent creates as for the documents that you model yourself. + +### 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 and ask questions in the Maia Make chat while they model. +* **Understanding** – 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 and 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 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 does not know your business context, your users, or your quality standards unless you tell it. In agentic development, the developer directs the work, and the responsibility for the app stays with the development team. + +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, from simple to complex, 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. | [Questions and guidance in Maia Make](/refguide/maia-chat/), [Maia Learn](/refguide/maia-learn/), [Maia Explain](/refguide/maia-explain/) | +| Recommendation | Suggests the next step in the editor that you have open, or detects issues in your app model. You decide which suggestion to apply. | [Logic Recommender](/refguide/logic-recommender/), [UI Recommender](/refguide/ui-recommender/), [Workflow Recommender](/refguide/workflow-recommender/), [Best Practice Recommender](/refguide/best-practice-recommender/) | +| Generation | Creates or changes one or more documents based on your request. | [Start with Maia](/refguide/start-with-maia/), [Maia Make](/refguide/maia-make/) | +| Agentic development | Carries out a goal that involves several steps or documents. It can ask clarifying questions and use tools, such as external MCP servers or web content. | [Maia Make](/refguide/maia-make/) with [Maia MCP Client](/refguide/maia-mcp/) and [Maia Web Fetch](/refguide/maia-web-fetch/), external agents through the [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/) | + +Choose the level that fits the task. For a small change in a microflow, a recommendation is often faster than a conversation. For a new feature that affects several documents, give the goal to Maia Make or to your own agent. + +## Working Practices for Agentic Development {#working-practices} + +The following practices help you get reliable results from Maia and other agents, and keep control of your app. + +### Start with Clear Intent + +Describe the outcome that you want and the context in which it is used. If you work with user stories, use them as input. Maia Make supports story-based development and can generate app artifacts from existing user stories. For larger initiatives, use [Maia Plan](/developerportal/maia-plan/) to define the scope and solution before you build. + +For guidance on how to write effective prompts, see [Prompt Engineering](/agents/prompt-engineering/) and the [Best Practices](/refguide/maia-make/#best-practices) section of *Maia Make Capabilities*. + +### Give the Agent the Right Context + +Maia uses your app model as context. You can add more context in the following ways: + +* **Documents** – Add the relevant microflows or pages to the conversation with the @ option, or from the **App Explorer**. +* **Attachments** – Attach images, PDFs, Markdown documents, or user stories. +* **Agent instructions** – Use [AGENTS.md](/refguide/maia-agent-instructions/) files for context that applies to every conversation in a project or module, such as company conventions. +* **Agent skills** – Use [agent skills](/refguide/maia-agent-skills/) for knowledge that applies only in certain situations, such as your microflow conventions. + +Agent instructions and agent skills follow industry standards, so they work with Maia and with other agentic tools. + +### Work in Small Steps + +Agents give faster and more reliable results for focused, well-scoped goals. Split a large feature into smaller requests, for example, first the domain model, then the pages, then the logic. Review the result of each step before you continue. + +### Review Every Change + +After Maia completes a request, review the result: + +1. Open each document in the list of changed items above the chat box. +2. Check the documents in their editors. +3. Check the **Errors** pane for consistency errors. +4. If a change is not what you want, ask Maia to fix it. You can also undo the change per document or for all documents, and refine your request. + +You can also ask Maia to explain its changes. Review changes from an external agent in the same way, in the Studio Pro editors and the **Errors** pane. + +### Use Version Control as a Safety Net + +Commit your work before you give an agent a large task. Commit the changes after you have reviewed them. This gives you a clear point to return to. For more information, see [Version Control](/refguide/version-control/). + +### Check Quality Continuously + +Run [Best Practice Recommender](/refguide/best-practice-recommender/) on generated documents in the same way as on documents that you model yourself. Test the generated functionality before you deploy it. + +### Capture Team Knowledge + +When you correct an agent for the same reason more than once, write the correction down as an agent instruction or an agent skill. In Studio Pro 11.15 and above, you can ask Maia to create or edit a skill directly in the chat. Because agent instructions and agent skills follow industry standards, other agentic tools that your team uses can apply the same knowledge. Skills and instructions are stored in the `skillssource` directory of your app, so they stay with the app instead of with one developer. Module-level skills are also exported together with their module. + +## Read More + +* [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) +* [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/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-development-lifecycle.md b/content/en/docs/refguide/mendix-ai-assistance/maia-development-lifecycle.md new file mode 100644 index 00000000000..9cc2b483a49 --- /dev/null +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-development-lifecycle.md @@ -0,0 +1,197 @@ +--- +title: "Maia Across the Development Lifecycle" +linktitle: "Maia Across the Lifecycle" +url: /refguide/maia-development-lifecycle/ +weight: 1 +description: "Describes how Maia supports you at each stage of the application lifecycle, from learning and planning to building, quality improvement, operation, and evolution." +--- + +## Introduction + +Mendix AI Assistance (Maia) supports you at each stage of the application lifecycle. In the build stages, Maia works as an agent. You describe the goal, and Maia creates or changes the necessary documents. In other stages, Maia gives guidance, recommendations, and insights. + +The stages do not need to be followed in a specific order. You will often move between them as you develop an app, such as when adding a feature to an existing app. Maia supports you through each stage, including when you revisit earlier work. + +This document decribes each stage of the application lifecycle. For the principles behind this approach, see [Agentic and Model-Driven Development](/refguide/agentic-development/). + +## One Conversation for the Whole App Model {#one-conversation} + +In Studio Pro, [Maia Make](/refguide/maia-make/) provides a single chat interface for agentic development. You can use the same conversation to create and change any part of your app model, such as the domain model, logic, pages, workflows, and translations. You can also ask to get guidance and explanations. + +In Studio Pro 11.8 and above, the earlier document-specific tools, such as Maia for Pages and Maia for Workflows, are consolidated into [Maia Make](/refguide/maia-make/). This means you can use Maia Make to work with any supported part of your app model, without switching between tools. Individual documents such as [Pages in Maia Make](/refguide/maia-for-pages/) and [Workflows in Maia Make](/refguide/maia-for-workflows/) describe what Maia Make can do for a specific document type. For a full list of supported document types and the Studio Pro version that supports them, see the [Supported Document Types](/refguide/maia-make/#supported-document-types) section of *Maia Make Capabilities*. + +Next to the chat, the [in-editor recommenders](/preferences-dialog/#in-editor-recommender) and [Best Practice Recommender](/refguide/best-practice-recommender/) provide guidance as you model your app. + +{{% alert type="info" %}} +In Studio Pro 11.7 and below, Maia Make capabilities are available through separate tools. See the relevant [Make Make Capabilities](/refguide/maia-make/#maia-make-capabilities-overview) documentation for information about accessing and using each tool. +{{% /alert %}} + +## Discover and Learn {#discover-and-learn} + +When you start with Mendix, or with a new part of the platform, you need to understand the concepts and how to apply them. + +Maia helps in the following ways: + +* [Maia Learn](/refguide/maia-learn/) – Maia Learn guides you through the Mendix core concepts, such as domain models, pages, logic, security, and integrations, directly in Studio Pro. +* [Maia Make](/refguide/maia-make/) – Maia Make answers questions about all aspects of Mendix development in the same chat in which you build, so you can move from a question to a change in your app in one conversation. Maia uses sources such as [Mendix Docs](https://docs.mendix.com/) and the [Mendix Community](https://community.mendix.com/link/home). In Studio Pro 11.8 and above, Maia Make replaces [Maia Chat](/refguide/maia-chat/), the earlier chat interface in Studio Pro. Maia Chat is still available in Studio Pro 11.7 and below and Mendix Portal. + +Below are example prompts you can use: + +* What is the difference between a microflow and a nanoflow? +* How do I set up entity access for a role that can only see its own records? + +## Plan and Design {#plan-and-design} + +Before you build, you define what the app must do, for whom, and how you measure success. + +Maia helps in the following ways: + +* [Maia Plan](/developerportal/maia-plan/) – Maia Plan turns your project context, such as goals, target users, requirements, and attached documents, into a project scope. After you approve the scope, Maia generates a solution with epics and user stories. It can also recommend Marketplace components for specific stories. +* **Create and Refine a Story with Maia** – Maia can help write new user stories and improve existing ones on the **Board** and **Planning** pages in Mendix Portal. For more information, see [Maia in Mendix Portal](/portal/maia/). + +You can use the stories from the plan as input when you build with Maia Make, which supports story-based development. Clear user stories with acceptance criteria give Maia better context. + +## Generate the App {#generate-the-app} + +When the scope is clear, use Maia to generate a first version of the app. This gives you a working starting point instead of an empty model. + +You have the following options: + +* **From Maia Plan** – In Maia Plan, select **Open in Studio Pro** to continue to work on the new app in Studio Pro with Maia Make. For more information, see [Starting the Development](/developerportal/maia-plan/start-development/). +* [Start with Maia](/refguide/start-with-maia/) – In Studio Pro, select **Start with Maia** as your starting point. Describe your app using a text description and an optional image or PDF. Maia uses this input to generate a domain model, data management overview pages, test data, and a homepage. +* **Maia Make** – In an existing app, describe a new module or feature in the **Maia** pane. Maia then generates the necessary documents. + +Review the generated app in the same way as any other change. For more information, see the [Review Every Change](/refguide/agentic-development/#working-practices) section of *Agentic and Model-Driven Development*. + +## Model Data {#model-data} + +The domain model is the foundation of every Mendix app. The other documents, such as pages and microflows, build on it. + +Maia helps in the following ways: + +* **Maia Make** – Maia Make generates new domain models, adds entities, attributes, and associations, and explains or improves existing domain models. In Studio Pro 11.9 and above, it can also work with [view entities](/refguide/view-entities/), enumerations, and constants, and generate OQL queries from a description of the data that you need. For more information, see [Domain Models in Maia Make](/refguide/maia-for-domain-model/) and [OQL in Maia Make](/refguide/maia-for-oql/). + +Below are example prompts you can use: + +* The app will help field engineers register maintenance visits. Each visit belongs to one asset and can have several photos. +* Add a status enumeration to the Order entity with the values Draft, Submitted, and Approved. +* Show all active orders with customer names. + +## Create Logic {#create-logic} + +Logic defines how your app behaves. In Mendix, you model logic with microflows, nanoflows, rules, and Java or JavaScript actions. + +Maia helps in the following ways: + +* **Maia Make** – Maia Make generates and changes microflows from a description. In Studio Pro 11.10 and above, it can also generate JavaScript actions. For the current scope per document type, see the [Supported Document Types](/refguide/maia-make/#supported-document-types) section of *Maia Make Capabilities*. +* [Logic Recommender](/refguide/logic-recommender/) – The Logic Recommender recommends the next best activity while you model a microflow, nanoflow, or rule, and prefills its parameters. +* [Validation Assist](/refguide/validation-assist/) – Validation Assist helps you build validation microflows with pre-built expressions, for example, for a button with the **Save changes** on-click event. + +Below are example prompts you can use: + +* Create a microflow that retrieves all open orders older than 30 days, changes their status to Expired, and commits them. +* Add a decision to this microflow that shows an error message when the order has no order lines. + +## Create UI {#create-ui} + +Pages, navigation, and styling define how end-users experience your app. + +Maia helps in the following ways: + +* **Maia Make** – Maia Make generates pages from a text description and an optional image, such as a wireframe or screenshot. Maia knows the domain model of the module that you work in, so it can connect widgets to your entities. It can also change existing pages. In Studio Pro 11.11 and above, it can work with navigation and menus. In Studio Pro 11.12 and above, it can change theme variables and create custom styling. For more information, see [Pages in Maia Make](/refguide/maia-for-pages/). +* [UI Recommender](/refguide/ui-recommender/) – The UI Recommender recommends widgets while you work in the page editor. + +Below are example prompts you can use: + +* Generate a page based on this image, but change the header to Welcome. +* Add a list of the open maintenance visits for the current engineer to this page. + +## Create Workflows {#create-workflows} + +Workflows model processes that involve people and several steps, such as approvals and onboarding. + +Maia helps in the following ways: + +* **Maia Make** – Maia Make generates a workflow from a description of a business process or from a BPMN image, and changes existing workflows. For more information, see [Workflows in Maia Make](/refguide/maia-for-workflows/). +* [Workflow Recommender](/refguide/workflow-recommender/) – The Workflow Recommender recommends the next best activity while you model a workflow. + +Below is an example prompt you can use: + +* Generate a workflow based on this BPMN image, but make sure it waits before sending an email to the new employee. + +## Integrate {#integrate} + +Most apps exchange data with other systems. + +Maia helps in the following ways: + +* **Maia Make** – Maia Make creates [JSON structures](/refguide/json-structures/) (Studio Pro 11.13 and above) and [data transformers](/refguide/data-transformers/) (Studio Pro 11.12 and above). +* [Maia Web Fetch](/refguide/maia-web-fetch/) – Maia Web Fetch reads public API documentation and endpoints, after you approve each request. Maia can use this information when it creates integration documents. +* [Maia MCP Client](/refguide/maia-mcp/) – Maia MCP Client connects Maia to external MCP servers, such as design tools or source code platforms. Maia can then use the tools of these servers during the conversation. + +## Understand and Get Guidance {#understand-and-get-guidance} + +You often work on documents that someone else created, or that you created a long time ago. Before you change them, you need to understand them. + +Maia helps in the following ways: + +* **Maia Make** – Ask in the chat about any document, concept, or error. [Maia Explain](/refguide/maia-explain/) describes the purpose and the technical details of an existing document. You can also start it in the **App Explorer** by right-clicking a document and selecting **Maia Explain**. +* **Explain consistency errors** – In Studio Pro 11.12.1 and above, right-click an item in the **Errors** pane to ask Maia to explain or solve it. +* [Agent Instructions (AGENTS.md)](/refguide/maia-agent-instructions/) and [Agent Skills (SKILLS.md)](/refguide/maia-agent-skills/) – Give Maia your team conventions and domain knowledge so its guidance and output follow your standards. + +Below are example prompts you can use: + +* Can you explain the function and purpose of this document? +* Could you identify any potential issues with this document and recommend solutions? + +## Improve Quality {#improve-quality} + +Quality includes correctness, performance, security, and maintainability. + +Maia helps in the following ways: + +* [Best Practice Recommender](/refguide/best-practice-recommender/) – Use the Best Practice Recommender to inspect your app model against Mendix best practices. It detects anti-patterns, explains their impact, and in some cases fixes them automatically. +* **Maia Make** – Maia Make explains and solves consistency errors, suggests improvements to existing documents, and helps you refactor. In Studio Pro 11.9 and above, Maia can remove elements as part of a refactoring. + +Use these capabilities on all documents, including the documents that Maia generates. + +## Localize {#localize} + +If your app serves users in several countries, it needs translated texts. + +Maia helps in the following ways: + +* **Maia Make** – In Studio Pro 11.15 and above, ask Maia in the chat to create or update the translations of texts in your app, as part of the same conversation in which you build the feature. +* [Translation Generator](/refguide/translation-generator/) – The Translation Generator translates the texts in your app that do not have a translation yet in one batch, and translates system texts. + +## Work with External AI Agents {#external-agents} + +Some teams use AI coding assistants or their own AI agents next to Studio Pro. Some organizations require a specific AI provider. + +Maia supports these scenarios in the following ways: + +* [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/) – The Studio Pro MCP Server exposes Maia capabilities to external AI agents through the Model Context Protocol (MCP). Changes appear in Studio Pro in real time. +* [Maia Plan as MCP Server](/developerportal/maia-plan-mcp/) – Maia Plan as MCP Server gives external AI agents read-only access to the scope and solution of a Maia Plan project. +* **Custom AI provider** – The Custom AI provider feature lets Maia use your own LLM provider. This feature 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 of *Maia Make Capabilities*. + +For an overview of how these options work together, see [Using Maia with External AI Agents](/refguide/maia-external-agents/). + +## Operate and Evolve {#operate-and-evolve} + +After you deploy your app, you monitor it, collect feedback, and plan the next iteration. + +Maia helps in the following ways: + +* [AI Log Summary](/developerportal/maia-operate/ai-log-summary/) – This feature is in Public Beta. For apps that run on Mendix Cloud, it gives an AI-generated overview of the log activity of an environment over the previous 24 hours. It groups errors by pattern and shows lifecycle events and security signals. It is not available in Mendix Cloud Africa (Cape Town). +* **Maia for Feedback** – This feature organizes end-user feedback into groups. You can create stories from feedback with Maia. For more information, see [Feedback](/developerportal/app-insights/feedback/). +* **Maia Make** – Maia Make changes existing documents for new requirements. Use Maia Explain first to understand the current behavior, then ask Maia to make the change. + +New stories from feedback bring you back to the [Plan and Design](#plan-and-design) stage. This closes the loop of the lifecycle. + +## Read More + +* [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) +* [Agentic and Model-Driven Development](/refguide/agentic-development/) +* [Maia Make Capabilities](/refguide/maia-make/) +* [Maia in Mendix Portal](/portal/maia/) +* [Maia Operate](/developerportal/deploy/maia-operate/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-external-agents.md b/content/en/docs/refguide/mendix-ai-assistance/maia-external-agents.md new file mode 100644 index 00000000000..4167da61809 --- /dev/null +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-external-agents.md @@ -0,0 +1,91 @@ +--- +title: "Using Maia with External AI Agents" +linktitle: "External AI Agents" +url: /refguide/maia-external-agents/ +weight: 6 +description: "Describes how Maia works with external AI agents, AI coding assistants, MCP servers, and custom AI providers, and how to combine these options." +--- + +## Introduction + +Many development teams use AI tools next to Studio Pro, such as AI coding assistants, their own AI agents, or a company-approved AI provider. Maia is designed to work with these tools. It uses open standards, such as the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction), the [AGENTS.md](https://agents.md) format, and the [Agent Skills](https://agentskills.io/) format. + +This document gives an overview of the integration options, explains when to use each option, and describes an example of how to combine them. + +## Integration Options {#integration-options} + +The table below lists the options. Each option connects Maia and external AI tools in a different direction: + +| Option | Direction | Use It When | Available From | +| --- | --- | --- | --- | +| [Maia MCP Client](/refguide/maia-mcp/) | Maia uses tools from external MCP servers. | You want Maia to use information or actions from other systems during a conversation, for example, design assets or a source code platform. | Studio Pro 11.8 | +| [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/) | External AI agents use Maia capabilities in Studio Pro. | You want to work from your own AI agent or AI coding assistant and let it create and change Mendix documents. This is also known as bring your own agent (BYO Agent). | Studio Pro 11.10 | +| [Maia Plan as MCP Server](/developerportal/maia-plan-mcp/) | External AI agents read Maia Plan content. | You want an external AI agent to use the scope, epics, and stories of a Maia Plan project. | Mendix Portal | +| [Custom AI provider](/refguide/maia-make/#custom-provider) | Maia uses your LLM provider. | Your organization requires a specific LLM provider, or you need uninterrupted access to Maia without Maia Units. This is also known as bring your own LLM (BYO LLM). | Studio Pro 11.12 (beta) | +| [Agent Instructions](/refguide/maia-agent-instructions/) and [Agent Skills](/refguide/maia-agent-skills/) | Shared context for Maia and other agents. | You want all agents to follow the same conventions and domain knowledge. Both follow industry standards, so they work with any agentic tool that supports these standards. | Studio Pro 11.11 (skills), Studio Pro 11.12 (instructions) | + +You can combine these options. For example, you can use a custom AI provider for Maia in Studio Pro, and connect Maia to an external MCP server at the same time. + +## Bring Your Own Agent {#byo-agent} + +With the Studio Pro MCP Server, an external AI agent, such as an AI coding assistant, can use the same capabilities as Maia in Studio Pro. The agent can generate and change Mendix documents, such as domain models, pages, and microflows. Studio Pro shows the changes in real time. In Studio Pro 11.10, the MCP Server cannot generate pages. For more information, see the [Limitations](/refguide/studio-pro-mcp-server/#limitations) section of *Studio Pro MCP Server*. + +This approach has the following benefits: + +* **Work from one tool** – If you already use an AI agent for other parts of your work, such as code, documentation, or tickets, you can also use it for your Mendix app. +* **Model-aware changes** – The agent uses Maia capabilities to change your app. It works with Mendix documents, such as domain models and microflows. +* **Review in Studio Pro** – You review the changes in the Studio Pro editors and in the **Errors** pane, in the same way as changes from Maia in Studio Pro. +* **Shared conventions** – Agent instructions and agent skills follow the AGENTS.md and Agent Skills standards. They work with Maia and with other agentic tools, so your external agent can use the same conventions as Maia. + +The Studio Pro MCP Server runs locally on your workstation, so you do not need to be signed in to Studio Pro to use it. Mendix platform MCP servers, such as Maia Plan as MCP Server, require authentication with your Mendix account. + +When you use an external agent, the agent uses tokens from your own LLM provider account. Usage and billing are managed by your LLM provider, not by Mendix. + +To set up the Studio Pro MCP Server, see the [Enabling the MCP Server](/refguide/studio-pro-mcp-server/#enabling-the-mcp-server) section of *Studio Pro MCP Server*. + +## Bring Your Own LLM {#byo-llm} + +By default, Maia uses the Mendix platform AI service. This is the recommended option. It requires no configuration and includes Mendix platform optimizations. + +If you configure a custom AI provider, Maia Make sends its requests to the provider that you select, such as Amazon Bedrock or an OpenAI-compatible endpoint. Custom AI provider settings are per project and local to your workstation. They are not committed to version control. Some Mendix platform optimizations may not be available with a custom provider. + +To configure a custom AI provider, see the [Configuring a Custom AI Provider](/refguide/maia-make/#custom-provider) section of *Maia Make Capabilities*. + +## Extend Maia with External Tools {#extend-maia} + +With Maia MCP Client, Maia can call tools from remote MCP servers during a conversation. For example, Maia can look up design assets or interact with a source code platform. Studio Pro includes a preset connection to the Mendix Marketplace and a catalog of other preset servers. + +Tools from a new server are disabled by default. You choose which tools Maia can use. For more information, see [Maia MCP Client](/refguide/maia-mcp/). + +## Example: From Plan to Implementation with an External Agent {#example} + +This example shows how you can combine the options. A team plans an app in Mendix Portal and uses an AI coding assistant to implement the stories in Studio Pro. + +1. Create a plan in [Maia Plan](/developerportal/maia-plan/). Review the scope, epics, and stories. +2. In your AI coding assistant, configure the [Maia Plan MCP Server](/developerportal/maia-plan-mcp/#configure) with a personal access token that has the `mx:plan:v1:read` scope. +3. Open the app in Studio Pro and [enable the Studio Pro MCP Server](/refguide/studio-pro-mcp-server/#enabling-the-mcp-server). Connect your AI coding assistant to it. +4. Add an [AGENTS.md](/refguide/maia-agent-instructions/) file with your team conventions, such as naming rules and the modules that the agent must not change. Agent instructions guide the agent, but they do not enforce restrictions, so check the result in step 6. +5. In your AI coding assistant, ask the agent to get one story from the plan and implement it in a specific module. +6. Review the result in Studio Pro. Check the changed documents and the **Errors** pane, and run [Best Practice Recommender](/refguide/best-practice-recommender/). +7. Test the functionality and commit the changes. + +Repeat steps 5 to 7 for each story. Implement one story at a time, so that each change stays small enough to review. + +## Security and Control {#security-and-control} + +Keep the following points in mind when you connect external AI tools: + +* **Authentication** – The Studio Pro MCP Server runs locally and does not require you to be signed in to Studio Pro. Mendix platform MCP servers require authentication with your Mendix account. +* **Credentials** – Store personal access tokens and API keys securely, for example, in environment variables. Do not commit them to version control. +* **Tool access** – Enable only the MCP tools that Maia needs. Tools from new servers are disabled by default. +* **Web access** – Maia asks for your approval before it fetches web content. For more information, see [Maia Web Fetch](/refguide/maia-web-fetch/). +* **Data** – When you use an external agent or a custom AI provider, your prompts and project context go to that provider. Check that the provider meets the data requirements of your organization. For information on the services that Maia uses by default, see the [Maia Third-Party Services](/refguide/mendix-ai-assistance/#maia-third-party-services) section of *Mendix AI Assistance (Maia)*. +* **Review** – Changes from an external agent are regular changes to your app. Review them before you commit them. + +## Read More + +* [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/) +* [Maia MCP Client](/refguide/maia-mcp/) +* [Maia Plan as MCP Server](/developerportal/maia-plan-mcp/) +* [Agentic and Model-Driven Development](/refguide/agentic-development/) +* [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-learn.md b/content/en/docs/refguide/mendix-ai-assistance/maia-learn.md index b789fb22858..76fc0b0bad5 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-learn.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-learn.md @@ -29,8 +29,8 @@ Click **Mendix Core Concepts**, you can start your learning journey with Maia Le You can also access additional materials on the topic, such as related documentation or a learning path. -If you have any questions during the learning journey, you can always click **Ask Maia** and ask your questions in [Maia Chat](/refguide/maia-chat/) for further assistance. +If you have any questions during the learning journey, you can always click **Ask Maia** and ask your questions in the Maia chat. In Studio Pro 11.8 and above, this is the [Maia Make](/refguide/maia-make/) chat for further assistance. ## Read More -* [Maia Chat](/refguide/maia-chat/) +* [Questions and Guidance in Maia Make](/refguide/maia-chat/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/_index.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/_index.md index fa1c5767c55..f43a5e75bf9 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/_index.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/_index.md @@ -15,10 +15,14 @@ Maia Make capabilities are available in Studio Pro 11.8 and above. 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 agentic 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. It also supports story-based development by generating app artifacts based on existing user stories. +Maia Make is the single chat interface for agentic development in Studio Pro. In one conversation, you can create and change any part of your app model, such as the domain model, logic, pages, workflows, and translations, and ask for guidance and explanations. + +Maia Make works as an agent on your app model. You describe a goal, and Maia determines which documents to create or change. It considers its built-in capabilities and the MCP tools that you enable, and it asks clarifying questions when it needs more information. Maia creates and changes regular Mendix documents. You review the results in the Studio Pro editors, and you can undo them. Because of this, you can use Maia Make in most stages of the application lifecycle, from generating a first version of an app to refactoring and extending an existing one. For more information, see [Maia Across the Development Lifecycle](/refguide/maia-development-lifecycle/). + For guidance on how to best prompt Maia, refer to [Prompt Engineering](/agents/prompt-engineering/). ## Maia Make Capabilities Overview @@ -52,7 +56,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 | | +| [Questions and guidance](/refguide/maia-chat/) | Answers questions about all aspects of Mendix development in the same chat in which you build. | Studio Pro 11.8 | Supersedes Maia Chat, the earlier chat interface in Studio Pro. | | [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 | | @@ -76,6 +80,7 @@ The following table lists the general capabilities of Maia Make and the Studio P | Themes and styling | Allows Maia to modify theme variables, create custom styling, and manage design properties. | Studio Pro 11.12 | | | Markdown attachment support | Allows you to provide Markdown documents as input to help Maia better understand your requirements. | Studio Pro 11.12 | | | Explain and solve consistency errors | Allows you to use Maia to explain or solve problems by right-clicking the item in the **Errors** pane. | Studio Pro 11.12.1 | | +| Translations | Allows Maia to create and update translations of the texts in your app from the chat. | Studio Pro 11.15 | | ## Using Maia Make Capabilities @@ -115,9 +120,9 @@ This option ({{% icon name="plug" %}}) allows you to connect external [MCP](http {{< 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**, where it appears in the context menu. +The **Add file to Maia chat** 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" alt="" >}} @@ -135,6 +140,18 @@ This feature is available for Studio Pro 11.12 and above. When Maia needs more information, it asks clarifying questions through a dedicated UI to improve the quality of its response. +## Reviewing and Controlling Maia Changes {#reviewing-changes} + +Maia changes regular documents in your app. You stay in control of these changes in the following ways: + +* **Changed list** – After each request, the [Changed List](#changed-list) shows the documents that Maia added or changed. Select an entry to open the document in its editor. +* **Consistency checks** – Studio Pro checks the documents that Maia creates or changes for consistency errors, in the same way as the documents that you create yourself. In Studio Pro 11.12.1 and above, you can right-click an item in the **Errors** pane to ask Maia to explain or solve it. +* **Undo** – In Studio Pro 11.9 and above, you can undo Maia changes per document or for all documents. +* **Version control** – Maia changes are part of your local changes. You decide when to commit them. For more information, see [Version Control](/refguide/version-control/). +* **Settings** – You can disable Maia Make capabilities in Studio Pro **Preferences**, on the **Maia** tab. + +For practices that help you review and control AI-generated changes, see the [Working Practices for Agentic Development](/refguide/agentic-development/#working-practices) section of *Agentic and Model-Driven Development*. + ## Save a Maia Session {#save-maia-session} A Maia session contains your conversation history and context, which can help analyze Maia's responses and behavior for troubleshooting or support purposes. To save a Maia session, go to **Help** > **Support Tools** > **Capture Maia Agent Session**. @@ -243,3 +260,6 @@ You can provide a BPMN image representing employee onboarding alongside your tex ## Read More * [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) +* [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/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-agent-instructions.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-agent-instructions.md index 78809b825e7..ddefdcb4670 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-agent-instructions.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-agent-instructions.md @@ -62,4 +62,4 @@ Project-level instructions are stored as `skillssource/AGENTS.md`, while module- * [Agent Skills](/refguide/maia-agent-skills/) * [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) -* [Maia Chat](/refguide/maia-chat/) +* [Questions and Guidance in Maia Make](/refguide/maia-chat/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-agent-skills.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-agent-skills.md index b47cb29b43d..543858a3a77 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-agent-skills.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-agent-skills.md @@ -153,6 +153,6 @@ To apply the updated skills immediately, click the **Sync** button in the **Skil * [Maia Make Capabilities](/refguide/maia-make/) * [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) -* [Maia Chat](/refguide/maia-chat/) +* [Questions and Guidance in Maia Make](/refguide/maia-chat/) * [Best Practices for Skill Creators](https://agentskills.io/skill-creation/best-practices) – guidance on writing effective skill content * [Agent Skills Specification](https://agentskills.io/specification) – the full specification for the agent skills format diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-chat.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-chat.md index 5706688e959..41bb37cbdac 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-chat.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-chat.md @@ -1,9 +1,9 @@ --- -title: "Maia Chat" -linktitle: "Chat" +title: "Questions and Guidance in Maia Make" +linktitle: "Questions and Guidance" url: /refguide/maia-chat/ weight: 5 -description: "Describes how to use Maia Chat, the built-in AI chat interface in Studio Pro." +description: "Describes how to ask questions about Mendix development in Maia Make, and how Maia Chat worked in earlier versions of Studio Pro." aliases: - /refguide/mendix-chat/ #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. @@ -12,20 +12,14 @@ aliases: ## Introduction {{% alert color="info" %}} -Maia Chat is also available in the Mendix Portal. For more information, refer to the [Maia Chat](/portal/maia/#maia-chat) section in *Maia in Mendix Portal*. -{{% /alert %}} +In Studio Pro 11.8 and above, [Maia Make](/refguide/maia-make/) supersedes Maia Chat, the earlier chat interface in Studio Pro. Maia Chat is still available in Mendix Portal. For more information, refer to the [Maia Chat](/portal/maia/#maia-chat) section in *Maia in Mendix Portal*. -{{% alert color="info" %}} -To use Maia Chat, you need an internet connection and must be signed in to Studio Pro. +To ask questions in Studio Pro, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} -{{% alert color="info" %}} -Maia Chat does not use any project, customer, or company information. It only uses the data you enter in the chat to fulfill the request. Do not enter any personal or sensitive data. -{{% /alert %}} - -Maia Chat is a built-in chat interface in the Mendix Platform powered by generative AI. You can ask questions about all aspects of Mendix, including how to apply concepts, best practices, governance tools, and development patterns. It is based on large language models (LLMs) using data from various resources. +In Studio Pro, you ask questions about Mendix development in the Maia Make chat. You can ask about all aspects of Mendix, including how to apply concepts, best practices, governance tools, and development patterns. Because you ask questions in the same chat in which you build, you can move from a question to a change in your app in one conversation. -Maia Chat uses the following data sources: +To answer questions about Mendix, Maia uses the following data sources: * [Mendix Docs](/) * [Mendix Community](https://community.mendix.com/) @@ -35,19 +29,23 @@ Maia Chat uses the following data sources: * [Mendix Evaluation Guide](https://www.mendix.com/evaluation-guide/) * [Mendix Support Knowledge Base](https://support.mendix.com/hc/en-us/p/knowledge-base) (in Studio Pro 11.10 and above) -## Using Maia Chat +## Asking Questions in Maia Make {#asking-questions} -You can start using Maia Chat by clicking one of the demo questions. Alternatively, you can ask your own question, and press Enter 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*. +In Studio Pro 11.8 and above, open the **Maia** pane and ask your question in the chat. There is no separate interface for questions. For more information, see [Maia Make Capabilities](/refguide/maia-make/). -For tips on getting better responses, see the [Best Practices](/portal/maia/#best-practices) section in *Maia in Mendix Portal* or the [Text Input](/refguide/maia-make/#text-input) section of *Maia Make Capabilites*. +For the shortcut keys that you can use in the chat, see the [Maia Shortcut Keys](/refguide/keyboard-shortcuts/#maia-chat-shortcuts) section in *Keyboard Shortcuts*. The same shortcut keys work in Maia Chat in Studio Pro 11.7 and below. -### In Studio Pro 11.8 and Above +For tips on getting better responses, see the [Best Practices](/portal/maia/#best-practices) section in *Maia in Mendix Portal* or the [Text Input](/refguide/maia-make/#text-input) section of *Maia Make Capabilities*. -In Studio Pro 11.8 and above, Maia Chat is incorporated into the unified Maia Make capabilities, which are enabled by default. Maia Chat does not have a dedicated interface. For more information, see [Maia Make Capabilities](/refguide/maia-make/). +## Maia Chat in Studio Pro 11.7 and Below {#maia-chat-legacy} -### In Studio Pro 11.7 and Below +In Studio Pro 11.7 and below, Maia Chat is a separate chat interface in Studio Pro. -In Studio Pro 11.7 and below, there are two ways to access Maia Chat in Studio Pro: +{{% alert color="info" %}} +Maia Chat does not use any project, customer, or company information. It only uses the data you enter in the chat to fulfill the request. Do not enter any personal or sensitive data. +{{% /alert %}} + +There are two ways to access Maia Chat in Studio Pro: * Click the **Maia** ({{% icon name="sparkles" %}}) icon to the right of the top bar. * Go to the **View** menu and click **Maia**. @@ -56,7 +54,9 @@ The chat interface appears on the right side of Studio Pro under the **Maia** pa {{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-chat/maia-chat-interface.png" alt="" width="250px">}} -#### Giving Feedback {#feedback} +You can start using Maia Chat by clicking one of the demo questions. Alternatively, you can ask your own question, and press Enter or click **Ask** to send the question. + +### Giving Feedback {#feedback} Mendix encourages you to provide feedback on Maia Chat answers to help improve the feature. @@ -71,4 +71,5 @@ Click **Submit feedback** to send your feedback. Maia Chat then returns you to t ## Read More -The **Maia** pane also includes a **Learn** tab. For more information, see [Maia Learn](/refguide/maia-learn/). +* [Maia Make Capabilities](/refguide/maia-make/) +* [Maia Learn](/refguide/maia-learn/) – the **Maia** pane also includes a **Learn** tab diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-explain.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-explain.md index 4fc5a2b0b6c..74f33212f03 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-explain.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-explain.md @@ -12,6 +12,8 @@ description: "Describes the features in Maia Explain." To use Maia Explain, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} +Maia Explain helps you understand existing documents in your app, such as microflows and pages. It describes the overall purpose of a document and highlights its technical details. Use it when you take over an app from another developer, before you change existing logic, or when you review documents that Maia generated. + ## Using Maia Explain The initial answer consists of two parts: @@ -58,4 +60,4 @@ In this dedicated chat, only requests related to Maia Explain are properly handl ## Read More * [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) -* [Maia Chat](/refguide/maia-chat/) +* [Questions and Guidance in Maia Make](/refguide/maia-chat/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model.md index 598d0c1bc06..f7d8e3eb025 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model.md @@ -1,8 +1,9 @@ --- -title: "Maia for Domain Model" +title: "Domain Models in Maia Make" +linktitle: "Domain Models" url: /refguide/maia-for-domain-model/ weight: 50 -description: "Describes the features in Maia for Domain Model." +description: "Describes how Maia Make generates, explains, and improves domain models in Studio Pro." aliases: - /refguide/domain-model-generator/ #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. @@ -11,22 +12,24 @@ aliases: ## Introduction {{% alert color="info" %}} -To use Maia for Domain Model, you need an internet connection and must be signed in to Studio Pro. +In Studio Pro 11.8 and above, domain model generation is part of [Maia Make](/refguide/maia-make/). In Studio Pro 11.7 and below, it was a separate tool called Maia for Domain Model. + +To use this capability, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} -Maia for Domain Model helps you generate new [domain models](/refguide/domain-model/) and explain and improve existing domain models. It has some limitations. For more information, see the [Limitations](#limitation) section below. +In the Maia Make chat, Maia can generate new [domain models](/refguide/domain-model/) and explain and improve existing domain models. You can work on the domain model in the same conversation in which you create pages, logic, and other parts of your app. There are some limitations. For more information, see the [Limitations](#limitation) section below. -## Using Maia for Domain Model +## Working with Domain Models in Maia Make Describe your application or its main goals in the chat. Maia uses this information to generate a relevant domain model for you. In Studio Pro 11.1 and above, you can also attach up to one image and one PDF to help Maia better understand your request. For more information, see the [Attachment Requirements](#attachment-requirements) section below. -After Maia generates a domain model, if the dedicated chat is still active, you can continue asking Maia to add entities and associations to the domain model. Maia also supports adding more attributes to an existing entity in the domain model. You can also ask Maia to explain or improve the generated domain model. +After Maia generates a domain model, you can continue asking Maia to add entities and associations to the domain model. Maia also supports adding more attributes to an existing entity in the domain model. You can also ask Maia to explain or improve the generated domain model. ### In Studio Pro 11.8 and Above -In Studio Pro 11.8 and above, Maia for Domain Model is incorporated into the unified Maia Make capabilities, which are enabled by default. Maia for Domain Model does not have a dedicated interface. For more information, see [Maia Make Capabilities](/refguide/maia-make/). +In Studio Pro 11.8 and above, you work on domain models in the Maia Make chat, which is enabled by default. There is no dedicated interface for domain models. For more information, see [Maia Make Capabilities](/refguide/maia-make/). -### In Studio Pro 11.7 and Below +### Maia for Domain Model in Studio Pro 11.7 and Below In Studio Pro 11.7 and below, Maia for Domain Model is enabled by default. You can find it in the toolbar of a domain model: @@ -57,13 +60,14 @@ In Studio Pro 11.1 and above, Maia for Domain Model supports adding up to one im ## Limitations {#limitation} -Maia for Domain Model has the following limitations: +Maia has the following limitations when it works with domain models: * It can only generate an attribute of type Enumeration if there is an existing enumeration in the module to refer to. * It cannot set [generalization](/refguide/generalization-and-association/) for an entity. ## Read More +* [Maia Make Capabilities](/refguide/maia-make/) * [Data in the Domain Model](/refguide/domain-model/) * [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) -* [Maia Chat](/refguide/maia-chat/) +* [Questions and Guidance in Maia Make](/refguide/maia-chat/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-oql.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-oql.md index a07577b1680..edaffabc316 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-oql.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-oql.md @@ -1,19 +1,22 @@ --- -title: "Maia for OQL" +title: "OQL in Maia Make" +linktitle: "OQL" url: /refguide/maia-for-oql/ weight: 78 -description: "Describes the features in Maia for OQL Generation." +description: "Describes how Maia Make generates OQL queries for view entities in Studio Pro." --- ## Introduction {{% alert color="info" %}} -To use Maia for OQL, you need an internet connection and must be signed in to Studio Pro. +In Studio Pro 11.9 and above, OQL generation is part of [Maia Make](/refguide/maia-make/). In Studio Pro 11.8 and below, it was a separate tool called Maia for OQL. + +To use this capability, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} -Maia for OQL enables you to generate and manage OQL (Object Query Language) queries. It simplifies query creation and reduces manual effort. It has some limitations. For more details, see the [Limitations](#limitations) section below. +In the Maia Make chat, Maia can generate and manage OQL (Object Query Language) queries. This simplifies query creation and reduces manual effort. There are some limitations. For more details, see the [Limitations](#limitations) section below. -## Using Maia for OQL +## Working with OQL in Maia Make Describe the data you need. For example, if you type *Show all active orders with customer names*, Maia generates the most relevant OQL query based on the data available in the same module. @@ -21,13 +24,13 @@ Maia interprets your intent and provides a query that fits your requirements, he ### In Studio Pro 11.9 and Above -In Studio Pro 11.9 and above, Maia for OQL is incorporated into the unified Maia Make capabilities, which are enabled by default. Maia for OQL does not have a dedicated interface. For more information, see [Maia Make Capabilities](/refguide/maia-make/). +In Studio Pro 11.9 and above, you generate OQL queries in the Maia Make chat, which is enabled by default. There is no dedicated interface for OQL. For more information, see [Maia Make Capabilities](/refguide/maia-make/). {{% alert type="info" %}} Studio Pro 11.13 and above, and 11.12.2 and above, include a setting to enable or disable OQL generation with Maia. OQL generation always uses the Mendix Platform regardless of the configured AI provider. To use OQL generation, you must enable both **Enable Maia** and **Enable OQL Tool**. {{% /alert %}} -### In Studio Pro 11.8 and Below +### Maia for OQL in Studio Pro 11.8 and Below In Studio Pro 11.8 and below, to enable Maia for OQL, go to **Edit** > **Preferences** > the **Maia** tab and select **Enable Maia for OQL Generation**. @@ -41,9 +44,9 @@ Clicking **Maia for OQL** opens a dedicated chat interface on the right side of ## Limitations {#limitations} -Maia for OQL has the following limitations: +OQL generation with Maia has the following limitations: -* Maia for OQL currently supports only [view entities](/refguide/view-entities/). +* It currently supports only [view entities](/refguide/view-entities/). * Associations with a **custom name** are not supported. * Cross-module associations are not supported. * The chat history does not retain previous OQL examples. diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-pages.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-pages.md index 46838df5fa6..d16a6c70c2a 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-pages.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-pages.md @@ -1,8 +1,9 @@ --- -title: "Maia for Pages" +title: "Pages in Maia Make" +linktitle: "Pages" url: /refguide/maia-for-pages/ weight: 60 -description: "Describes the features in Maia for Pages." +description: "Describes how Maia Make generates, changes, and explains pages in Studio Pro." aliases: - /refguide/page-generator/ #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. @@ -11,28 +12,30 @@ aliases: ## Introduction {{% alert color="info" %}} -To use Maia for Pages, you need an internet connection and must be signed in to Studio Pro. +In Studio Pro 11.8 and above, page generation is part of [Maia Make](/refguide/maia-make/). In Studio Pro 11.7 and below, it was a separate tool called Maia for Pages. + +To use this capability, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} -Maia for Pages helps you generate a [page](/refguide/page/) by adding and configuring widgets based on text input and optional image input. You can also use it to edit or remove existing widgets or ask it to provide further improvements and explanations. For information on the current limitations of Maia for Pages, see the [Limitations](#limitation) section below. +In the Maia Make chat, Maia can generate a [page](/refguide/page/) by adding and configuring widgets based on text input and optional image input. You can also ask Maia to edit or remove existing widgets, or to provide further improvements and explanations. You can work on pages in the same conversation in which you create the domain model, logic, and other parts of your app. For information on the current limitations, see the [Limitations](#limitation) section below. -## Using Maia for Pages +## Working with Pages in Maia Make 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. You can also supplement text input with an image. Maia uses the image to interpret your request better. For example, it can recognize the layout of a page from the image and replicate it. The image can be a screenshot, photo, wireframe, or drawing. With text input, you can also specify differences between the provided image and how you would like the generated page to appear. For example, you might write: *Generate a page based on this image, but change the header to Welcome.* -On pages that have already been created, either by Maia for Pages or manually, you can ask Maia to further improve the page and provide explanations. For example, you can add extra widgets, edit widgets by changing their properties, or remove widgets. +On pages that have already been created, either by Maia or manually, you can ask Maia to further improve the page and provide explanations. For example, you can add extra widgets, edit widgets by changing their properties, or remove widgets. ### In Studio Pro 11.8 and Above -In Studio Pro 11.8 and above, Maia for Pages is incorporated into the unified Maia Make capabilities, which are enabled by default. Maia for Pages does not have a dedicated interface. For more information, see [Maia Make Capabilities](/refguide/maia-make/). +In Studio Pro 11.8 and above, you work on pages in the Maia Make chat, which is enabled by default. There is no dedicated interface for pages. For more information, see [Maia Make Capabilities](/refguide/maia-make/). In Studio Pro 11.8, only overview pages can be generated. In Studio Pro 11.9 and above, you can generate custom pages from scratch and modify existing pages. Local variables, additional data sources, client actions, XPath constraints, and expressions are also supported. -### In Studio Pro 11.7 and Below +### Maia for Pages in Studio Pro 11.7 and Below 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**. @@ -54,7 +57,7 @@ In this dedicated chat, only requests related to Pages are handled. If you have ## Limitations {#limitation} -Maia for Pages does not support all widgets. +Maia does not support all widgets when it generates pages. The following widgets are supported: @@ -84,6 +87,7 @@ In Studio Pro 11.6 and above, Maia can understand customized pluggable widgets w ## Read More +* [Maia Make Capabilities](/refguide/maia-make/) * [Pages](/refguide/page/) * [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) -* [Maia Chat](/refguide/maia-chat/) +* [Questions and Guidance in Maia Make](/refguide/maia-chat/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-workflows.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-workflows.md index ec6d7bda4cd..95859d3bf0d 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-workflows.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-workflows.md @@ -1,20 +1,23 @@ --- -title: "Maia for Workflows" +title: "Workflows in Maia Make" +linktitle: "Workflows" url: /refguide/maia-for-workflows/ weight: 75 -description: "Describes the features in Maia for Workflows." +description: "Describes how Maia Make generates, explains, and improves workflows in Studio Pro." #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 {{% alert color="info" %}} -To use Maia for Workflows, you need an internet connection and must be signed in to Studio Pro. +In Studio Pro 11.9 and above, workflow generation is part of [Maia Make](/refguide/maia-make/). In Studio Pro 11.7 and below, it was a separate tool called Maia for Workflows. + +To use this capability, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} -Maia for Workflows helps you generate a [workflow](/refguide/workflows/). It can also provide explanations or suggest improvements to the generated elements. It has some limitations. For more details, see the [Limitations](#limitation) section below. +In the Maia Make chat, Maia can generate a [workflow](/refguide/workflows/). It can also provide explanations or suggest improvements to the generated elements. You can work on workflows in the same conversation in which you create the domain model, pages, logic, and other parts of your app. There are some limitations. For more details, see the [Limitations](#limitation) section below. -## Using Maia for Workflows +## Working with Workflows in Maia Make Describe a business process you want to model. Maia uses this information to add relevant workflow activities and configures them where possible. For more information on how to communicate with Maia to achieve better results when configuring a workflow, see the [Best Practices](/refguide/maia-make/#workflows-best-practices) section of *Maia Make Capabilities*. @@ -22,15 +25,15 @@ Describe a business process you want to model. Maia uses this information to add #### Studio Pro 11.9 and Above -Maia for Workflows is incorporated into the unified [Maia Make Capabilities](/refguide/maia-make/), which are enabled by default. +You work on workflows in the [Maia Make](/refguide/maia-make/) chat, which is enabled by default. #### Studio Pro 11.8 -Maia for Workflows is not available. +Workflow generation is not available. #### Studio Pro 11.7 and Below -To enable Maia for Workflows, go to **Edit** > **Preferences** > the **Maia** tab and select **Enable Maia for Workflows**. After you enable it, you can find it in the toolbar of a workflow: +In Studio Pro 11.7 and below, workflow generation is a separate tool called Maia for Workflows. To enable Maia for Workflows, go to **Edit** > **Preferences** > the **Maia** tab and select **Enable Maia for Workflows**. After you enable it, you can find it in the toolbar of a workflow: {{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-for-workflows/maia-for-workflows.png" alt="" max-width=80% >}} @@ -52,4 +55,4 @@ Due to the complex cross-document nature of a workflow, not all properties of th * [Maia Make Capabilities](/refguide/maia-make/) * [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) * [Workflow](/refguide/workflows/) -* [Maia Chat](/refguide/maia-chat/) +* [Questions and Guidance in Maia Make](/refguide/maia-chat/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-mcp.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-mcp.md index 7bd3857dfbc..04f7ebd531f 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-mcp.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-mcp.md @@ -23,7 +23,7 @@ For details on the current limitations, see the [Limitations](#limitations) sect There are two ways to open the MCP Client panel: -* Click the **Configure MCP Connections** ({{% icon name="plug" %}}) icon under the **Maia Chat** tab. +* Click the **Configure MCP Connections** ({{% icon name="plug" %}}) icon under the **Chat** tab of the **Maia** pane. * Go to the **View** menu and click **MCP Settings**. ### Preset Servers {#preset-servers} @@ -169,4 +169,4 @@ Maia MCP Client has the following limitations: ## Read More * [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) -* [Maia Chat](/refguide/maia-chat/) +* [Questions and Guidance in Maia Make](/refguide/maia-chat/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-web-fetch.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-web-fetch.md index 0aa8623b494..8bf73d4b75a 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-web-fetch.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-web-fetch.md @@ -58,4 +58,4 @@ If Maia says it cannot fetch a URL, check the following: * [Maia Make Capabilities](/refguide/maia-make/) * [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) -* [Maia Chat](/refguide/maia-chat/) +* [Questions and Guidance in Maia Make](/refguide/maia-chat/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/studio-pro-mcp-server.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/studio-pro-mcp-server.md index 279779ad73f..e5faa3229b8 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/studio-pro-mcp-server.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/studio-pro-mcp-server.md @@ -12,7 +12,7 @@ description: "Describes the features in Studio Pro MCP Server." {{% alert color="info" %}} This feature is available from Studio Pro 11.10. -To use Studio Pro MCP Server, you need an internet connection and must be signed in to Studio Pro. +To use Studio Pro MCP Server, you need an internet connection. The MCP Server runs locally on your workstation, so you do not need to be signed in to Studio Pro to use it. To use Mendix platform MCP servers, such as [Maia Plan as MCP Server](/developerportal/maia-plan-mcp/), you need to authenticate with your Mendix account. {{% /alert %}} Studio Pro MCP Server enables bring your own agent (BYO Agent) capabilities, allowing you to use Maia's capabilities directly from external clients, including AI coding assistants, agents, and other MCP-based LLM tools. @@ -26,6 +26,27 @@ It has the following highlights: When you connect external agents or AI tools to Studio Pro's MCP Server, those tools consume tokens from your own LLM provider account each time they interact with Maia. Because these requests occur outside of the Mendix environment, usage and billing details are managed through your LLM provider's dashboard rather than within Mendix. {{% /alert %}} +For an overview of all the ways in which Maia works with external AI tools, see [Using Maia with External AI Agents](/refguide/maia-external-agents/). + +## How It Works {#how-it-works} + +The Studio Pro MCP Server runs on your workstation, as part of Studio Pro. It works in the following way: + +1. You enable the MCP Server in Studio Pro and connect your external client to it on `localhost`. +2. Your external client sends a request to its own LLM, which decides to use one of the tools that the MCP Server exposes. +3. The MCP Server carries out the request with Maia capabilities on the app that is open in Studio Pro. +4. Studio Pro shows the changes in real time. You can review them in the regular editors and in the **Errors** pane. + +The external client works with Mendix documents, such as domain models and microflows, through the tools that the MCP Server exposes. + +## Use Cases {#use-cases} + +Use the Studio Pro MCP Server in the following situations: + +* **You already work with an AI agent** – You use an AI coding assistant for other work, such as code in other repositories, documentation, or tickets. With the MCP Server, you can use the same assistant for your Mendix app. +* **You combine information from several sources** – Your agent has access to other MCP servers, such as [Maia Plan as MCP Server](/developerportal/maia-plan-mcp/). The agent can use information from these sources and then change your app through the Studio Pro MCP Server. +* **You need an alternative to Maia Units** – Requests from an external client use your own LLM provider account. For more information, see the [Maia Usage Limits](/refguide/mendix-ai-assistance/#maia-usage) section of *Mendix AI Assistance (Maia)*. + ## Enabling the MCP Server To enable the MCP Server, go to **Preferences** > **AI** > **MCP Server** and select **Enable MCP Server**. You can also configure the port in this menu. @@ -38,6 +59,17 @@ Once enabled, you can connect external clients to the MCP Server. For example, t Replace `` with your preferred server name and `` with the port configured in **Preferences**. +## Working Practices {#working-practices} + +The following practices help you get reliable results when you use an external client: + +* **Give the agent context** – [Agent Instructions (AGENTS.md)](/refguide/maia-agent-instructions/) and [Agent Skills (SKILLS.md)](/refguide/maia-agent-skills/) follow industry standards, so they work with Maia and with other agentic tools. Use them to share your conventions with every agent that works on the app. +* **Keep requests small** – Ask for one feature or one story at a time, so that you can review each change. +* **Review in Studio Pro** – Check the changed documents and the **Errors** pane before you continue with the next request. +* **Commit after review** – Commit the changes to version control when you have reviewed and tested them. + +For more practices, see the [Working Practices for Agentic Development](/refguide/agentic-development/#working-practices) section of *Agentic and Model-Driven Development*. + ## Limitations The following limitations apply only to Studio Pro 11.10: @@ -47,6 +79,8 @@ The following limitations apply only to Studio Pro 11.10: ## Read More +* [Using Maia with External AI Agents](/refguide/maia-external-agents/) * [Maia Make Capabilities](/refguide/maia-make/) +* [Maia MCP Client](/refguide/maia-mcp/) * [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) -* [Maia Chat](/refguide/maia-chat/) +* [Questions and Guidance in Maia Make](/refguide/maia-chat/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/start-with-maia.md b/content/en/docs/refguide/mendix-ai-assistance/start-with-maia.md index de4cc067013..c5bb280109d 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/start-with-maia.md +++ b/content/en/docs/refguide/mendix-ai-assistance/start-with-maia.md @@ -60,4 +60,4 @@ You can attach a maximal of one image or one PDF and the attachment must meet th ## Read More * [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) -* [Maia Chat](/refguide/maia-chat/) +* [Questions and Guidance in Maia Make](/refguide/maia-chat/) diff --git a/content/en/docs/refguide/mendix-ai-assistance/translation-generator.md b/content/en/docs/refguide/mendix-ai-assistance/translation-generator.md index 49e50a8bca1..09bf16473a7 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/translation-generator.md +++ b/content/en/docs/refguide/mendix-ai-assistance/translation-generator.md @@ -13,6 +13,8 @@ To use Translation Generator, an internet connection and signing in to Studio Pr Maia Translation Generator is a translation tool powered by AI in Mendix Studio Pro. You can use this AI tool in Studio Pro to [batch translate](/refguide/batch-translate/) your Mendix app into a different language. You can also use it to translate [system texts](/refguide/system-texts/). +In Studio Pro 11.15 and above, you can also ask Maia in the [Maia Make](/refguide/maia-make/) chat to create and update translations, as part of the same conversation in which you build a feature. + For more information on how to enable and use this AI translation tool in Studio Pro, see the sections below. ## Modeling Using Translation Generator diff --git a/content/en/docs/refguide/modeling/domain-model/_index.md b/content/en/docs/refguide/modeling/domain-model/_index.md index a98e770ca84..468a945cd7f 100644 --- a/content/en/docs/refguide/modeling/domain-model/_index.md +++ b/content/en/docs/refguide/modeling/domain-model/_index.md @@ -116,4 +116,4 @@ The entity `OrderLine` is stored in the table `module$orderline` which is shown ## Read More * [Configuring a Domain Model](/refguide/configuring-a-domain-model/) -* [Maia for Domain Model](/refguide/maia-for-domain-model/) +* [Domain Models in Maia Make](/refguide/maia-for-domain-model/) diff --git a/content/en/docs/refguide/modeling/domain-model/entities/view-entities/_index.md b/content/en/docs/refguide/modeling/domain-model/entities/view-entities/_index.md index ba789620f7c..577e7e30e3f 100644 --- a/content/en/docs/refguide/modeling/domain-model/entities/view-entities/_index.md +++ b/content/en/docs/refguide/modeling/domain-model/entities/view-entities/_index.md @@ -72,7 +72,7 @@ Alternatively, you can right-click the view entity and click **Go to OQL query** The OQL query tab consists of the following sections: * [OQL editor](#oql-editor) -* [Maia for OQL](#maia-for-oql) +* [Generating OQL with Maia](#maia-for-oql) * [Preview data table](#preview-data) {{< figure src="/attachments/refguide/modeling/domain-model/view-entities/view-entity-document.png">}} @@ -131,9 +131,9 @@ FROM Shop.Order AS o {{< figure src="/attachments/refguide/modeling/domain-model/view-entities/association-alias.png" >}} -### Maia for OQL {#maia-for-oql} +### Generating OQL with Maia {#maia-for-oql} -You can ask Maia to suggest OQL queries for you. For more information, see [Maia for OQL](/refguide/maia-for-oql/). +You can ask Maia to suggest OQL queries for you. For more information, see [OQL in Maia Make](/refguide/maia-for-oql/). ### Preview Data Table {#preview-data} diff --git a/content/en/docs/refguide/modeling/menus/view-menu/_index.md b/content/en/docs/refguide/modeling/menus/view-menu/_index.md index 488d16e6088..d58a157c414 100644 --- a/content/en/docs/refguide/modeling/menus/view-menu/_index.md +++ b/content/en/docs/refguide/modeling/menus/view-menu/_index.md @@ -111,7 +111,7 @@ The [Integration pane](/refguide/integration-pane/) enables you to browse the [C ### Maia -The **Maia** pane displays the Maia Chat interface where you can ask 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/). +The **Maia** pane displays the Maia Make chat interface. In this chat, you can create and change parts of your app, and ask questions about app development in Mendix, including how to apply concepts, best practices, and development patterns. For more information, see [Maia Make Capabilities](/refguide/maia-make/). In Studio Pro 11.7 and below, the **Maia** pane displays the Maia Chat interface. For more information, see [Questions and Guidance in Maia Make](/refguide/maia-chat/). ### Marketplace