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 baa43a928cc..34a7906f4e6 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 @@ -7,17 +7,17 @@ description_list: true #If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details. --- -## Introduction +## Introduction {{% alert color="info" %}} Maia Make capabilities are available in Studio Pro 11.8 and above. -To use Maia Make capabilities, an internet connection and signing in to Studio Pro are required. +To use Maia Make capabilities, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} -Maia Make is a set of AI-assisted development capabilities in Studio Pro that are available through a unified conversational interface. Describe your requirements in natural language, and Maia generates development artifacts such as data structures, pages, and microflows. +Maia Make is a set of AI-assisted development capabilities in Studio Pro that are available through a unified conversational interface. Describe your requirements in natural language, and Maia generates development artifacts such as data structures, pages, and microflows. -You can also ask Maia to provide explanations of your existing documents, such as microflows, workflows, and pages. Moreover, this interface allows you to integrate with external tools, such as Playwright and Figma, via MCP Servers, and it supports story-based development by generating app artifacts based on existing user stories. +You can also ask Maia to provide explanations of your existing documents, such as microflows, workflows, and pages. Moreover, this interface allows you to integrate with external tools, such as Playwright and Figma, via MCP servers. It also supports story-based development by generating app artifacts based on existing user stories. ## Maia Make Capabilities Overview @@ -51,12 +51,12 @@ The following table lists Maia Make Standalone Capabilities and the Studio Pro v | Capability | Description | Available in Maia Make from | Remarks | | --- | --- | --- | --- | | [Maia Chat](/refguide/maia-chat/) | Answers questions about all aspects of Mendix development. | Studio Pro 11.8 | | -| [Maia Explain](/refguide/maia-explain/) | Explains the purpose and logic of existing documents. | Studio Pro 11.8 | | +| [Maia Explain](/refguide/maia-explain/) | Explains the purpose and logic of existing documents. | Studio Pro 11.8 | Can be used directly in the chat interface, or in the App Explorer by right-clicking a document and clicking **Maia Explain**. | | [Maia MCP Client](/refguide/maia-mcp/) | Connects Maia to external MCP servers, giving it access to third-party tools. | Studio Pro 11.8 | | | [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/) | Exposes Studio Pro as an MCP server for use by external AI tools. | Studio Pro 11.10 | | | [Maia Web Fetch](/refguide/maia-web-fetch/) | Fetches and reads content from public websites and APIs. | Studio Pro 11.10 | | | [Maia Agent Skills](/refguide/maia-agent-skills/) | Extends Maia with reusable knowledge. | Studio Pro 11.11 | | -| [Maia Agent Instructions](/refguide/maia-instructions/) | Extends Maia with instructions to be followed with every prompt | Studio Pro 11.12 | | +| [Maia Agent Instructions](/refguide/maia-instructions/) | Extends Maia with instructions to be followed with every prompt. | Studio Pro 11.12 | | ### Maia Make General Capabilities @@ -66,7 +66,7 @@ The following table lists the general capabilities of Maia Make and the Studio P | --- | --- | --- | --- | | Story-based development | Generates app artifacts based on existing user stories to support story-driven development workflows. | Studio Pro 11.8 | | | PDF/image support | Allows you to provide PDFs and images as input to help Maia better understand your requirements. | Studio Pro 11.8 | | -| Adding documents as context | Lets you add relevant documents, to provide Maia with additional context. | Studio Pro 11.8 | | +| Adding documents as context | Lets you add relevant documents to provide Maia with additional context. | Studio Pro 11.8 | | | Editing existing documents | Enables Maia to modify existing documents, including renaming elements. | Studio Pro 11.8 | | | Removing elements | Allows Maia to remove elements from documents to support more advanced refactoring tasks. | Studio Pro 11.9 | | | Undo support | Allows you to undo Maia-generated changes on a per-document basis. | Studio Pro 11.9 | | @@ -83,7 +83,7 @@ To access the conversational interface and Maia Make capabilities, in the upper- {{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-interface.png" max-width=40% alt="Maia Make interface" >}} -Alternatively, you can also click **View** at the Studio Pro top bar and select **Maia** to open the interface. +Alternatively, you can click **View** on the Studio Pro top bar and select **Maia** to open the interface. {{% alert color="info" %}} In Studio Pro 11.7 and below, the **Chat** tab is only used for [Maia Chat](/refguide/maia-chat/) where you can ask questions about all aspects of Mendix. @@ -92,42 +92,46 @@ There is also the **Learn** tab under the **Maia** pane. It is a separate Maia c {{% /alert %}} {{% alert color="warning" %}} -The Maia ({{% icon name="sparkles" %}} ) icon on the right side of the top bar does not work in Studio Pro 11.8. +The Maia ({{% icon name="sparkles" %}}) icon on the right side of the top bar does not work in Studio Pro 11.8. {{% /alert %}} ### Maia Make Capabilities Interface Overview The conversational interface includes the following features. +{{% alert color="info" %}} +Maia Make loses the conversation history if you exit Studio Pro. +{{% /alert %}} + #### New Chat Clicking **New Chat** allows you to clear the messages and start a new conversation that does not reference your current chat. -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/new-chat.jpg" width="250px" >}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/new-chat.jpg" width="250px" alt="" >}} -#### Configure MCP Connections +#### Configure MCP Connections This option ({{% icon name="plug" %}}) allows you to connect external [MCP](https://modelcontextprotocol.io/introduction) servers to Maia, giving it access to third-party tools during chat. For more information on how to configure MCP connections, see [Maia MCP Client](/refguide/maia-mcp/). -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/configure.jpg" width="250px" >}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/configure.jpg" width="250px" alt="" >}} #### Add **{{% icon name="paperclip" %}} Add** allows you to attach images, PDFs, or user stories to help Maia understand your requirements better. -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/add.jpg" width="250px" >}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/add.jpg" width="250px" alt="" >}} -#### Add file to Maia Chat +#### Add file to Maia Chat -This option (@ icon) allows you to add certain logic or pages to Maia as context. You can also access this option by right-clicking the documents (microflows or pages) in the **App Explorer** and it appears in the context menu. +This option (@ icon) allows you to add certain logic or pages to Maia as context. You can also access this option by right-clicking the documents (microflows or pages) in the **App Explorer**, where it appears in the context menu. -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/add-files.jpg" width="250px" >}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/add-files.jpg" width="250px" alt="" >}} #### Changed List A list of items added or changed by Maia appears above the chat box. Click an entry to open the relevant document. To undo all changes, click **Undo all**. To undo a single change, click the undo button on the right side of that item. -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/changed-list.png" width="250px" >}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-capabilities/changed-list.png" width="250px" alt="" >}} #### Clarifying Questions @@ -135,7 +139,7 @@ A list of items added or changed by Maia appears above the chat box. Click an en This feature is available for Studio Pro 11.12 and above. {{% /alert %}} -When Maia needs more information, it will ask clarifying questions through a dedicated UI to improve the quality of its response. +When Maia needs more information, it asks clarifying questions through a dedicated UI to improve the quality of its response. ## Save a Maia Session {#save-maia-session} @@ -192,10 +196,58 @@ To configure an OpenAI-compatible provider, follow these steps: [Private Mendix Platform](/private-mendix-platform/) provides an environment where you can develop and deploy your applications within your own enterprise security boundary to ensure the highest levels of data security and compliance. Because Private Mendix Platform instances are hosted within the enterprise firewall, selecting an LLM provider other than the default [Mendix Platform](#mendix-platform) requires you to also configure the LLM Gateway URL. -{{< figure src="/attachments/private-platform/pmp-llm-gateway.png" class="no-border" >}} +{{< figure src="/attachments/private-platform/pmp-llm-gateway.png" class="no-border" alt="" >}} The LLM Gateway URL is configured during the installation or upgrade of Private Mendix Platform. For more information, see [Installing Maia for Private Mendix Platform](/private-mendix-platform/interactive-installation/#maia). +## Best Practices {#best-practices} + +### Text Input + +To achieve optimal results, provide context about your app or the document you are working on by describing its main use cases, customer needs, or other relevant details. The more Maia knows about what you are building, the more tailored and accurate the generated results will be. + +#### Providing Context + +Below are some examples of prompts you can use as a starting point: + +* The app will help users... +* This module handles... +* Customers need to be able to... +* The page will be used to... +* Generate a workflow for a process that... +* This feature allows users to... + +#### Editing and Improving + +Below are examples of prompts you can use to ask Maia to make further edits or request explanations and suggestions for improving a document: + +* Can you explain the function and purpose of this document? +* I want to add an attribute `ATTRIBUTE_NAME` to the entity `ENTITY_NAME`. +* Can you add a button called `BUTTON_NAME` to the page? +* I want an area on the page where users can... +* Remove the ... widget. +* How can I make this page more user-friendly or visually appealing? +* Could you identify any potential issues with this document and recommend solutions? +* Can you give me suggestions to improve this workflow? + +### Image Input + +The image size is limited to 512 KB. Make sure to select a clear image to help Maia better understand your request. For example, you can provide a screenshot, a photo, a design mock-up, or a close-up picture of a drawing. Avoid heavily compressed or low-quality images, as these may result in the loss of important details. + +Keep in mind that Maia analyzes only the structure of the image. Maia does not change the theming of your app, such as the color scheme. This can cause some differences between the provided image and the generated page. + +### Microflows {#microflows-best-practices} + +When generating microflows, consider the following additional guidelines: + +* **Be specific:** Clearly describe the desired outcome and the steps involved. For example, instead of using *Create a user*, use *Create a new user object, set its name attribute to 'John Doe', and commit it*. +* **Use keywords:** Incorporate terms relevant to microflow activities, such as *create object*, *retrieve*, *change object*, *show message*, *loop*, or *decision*. This can help with correct microflow generation. +* **Provide context:** If your microflow interacts with existing entities or attributes, mention them in your text input. + +### Workflows {#workflows-best-practices} + +You can provide a BPMN image representing employee onboarding alongside your text input. Maia can analyze the image, rework it using Mendix Workflows terminology, and generate the corresponding activities. Use text input alongside the image to specify any differences. For example, "Generate a workflow based on this BPMN image, but make sure it waits before sending an email to the new employee." + ## Read More * [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) 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 1396bf50eab..258ce5eec41 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 @@ -10,22 +10,21 @@ description: "Describes how to create and manage agent skills that equip Maia wi ## Introduction {{% alert color="info" %}} -This feature was released as part of [Maia Make](/refguide/maia-make/) capabilities in Studio Pro 11.11. +This feature is part of [Maia Make](/refguide/maia-make/) and was introduced in Studio Pro 11.11. -To use Maia Agent Skills, an internet connection and signing in to Studio Pro are required. +To use Maia Agent Skills, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} Maia Agent Skills are modular, reusable instructions that extend Maia's capabilities with domain-specific knowledge, giving it the context, workflows, and guidance it needs to work the way your team works. Instead of typing the same context into every chat, you define agent skills once, and Maia applies them automatically whenever relevant. This eliminates the need to repeat the same guidance across conversations. -Use agent skills to equip Maia with the domain knowledge and conventions it needs, whether those are company-wide standards or team-specific workflows. For example, a skill capturing your company's Mendix naming conventions means Maia applies them consistently whenever it generates entities, attributes, or microflows without you having to mention them each time. +Use agent skills to equip Maia with the domain knowledge and conventions it needs, whether those are company-wide standards or team-specific workflows. For example, a skill that captures your company's Mendix naming conventions lets Maia apply them consistently whenever it generates entities, attributes, or microflows, without you having to mention them each time. -Starting from Studio Pro 11.12, Maia supports not only project-level skills, but also skills for all application modules. These skills are exportable together with the module in which they are kept -and can help you split your skills better. +From Studio Pro 11.12, Maia supports not only project-level skills, but also skills for all application modules. These skills are exportable together with the module in which they are kept and can help you split your skills better. {{% alert color="info" %}} -Agents skills are not supported for Add-on and Solution modules. +Agent skills are not supported for Add-on and Solution modules. {{% /alert %}} For guidance on writing effective skills, see [Best Practices for Skill Creators](https://agentskills.io/skill-creation/best-practices) and [Optimizing Skill Descriptions](https://agentskills.io/skill-creation/optimizing-descriptions) in the [Agent Skills documentation](https://agentskills.io/). @@ -34,12 +33,12 @@ For guidance on writing effective skills, see [Best Practices for Skill Creators To create a new agent skill in Studio Pro, follow these steps: -1. In the **App Explorer**, find either the **Maia** node under **App** for project-level skills, or **Maia** node under a module if you wish to add skills for a module. +1. In the **App Explorer**, find either the **Maia** node under **App** for project-level skills, or the **Maia** node under a module if you want to add skills for a module. 1. Expand this node to **Maia** > **skills**. 1. Right-click **skills** and click **Add** > **Skill**. 1. Enter a name for the skill. -Studio Pro creates the `SKILL.md` file. You can continue adding the skill content. +Studio Pro creates the `SKILL.md` file. You can now add the skill content. ### SKILL.md Format {#skill-md-format} @@ -67,9 +66,9 @@ The `name` field must match the skill's parent directory name exactly. A mismatc ### Directory Structure {#directory-structure} Skills are stored in the `skillssource/` directory at the root of your application directory. You can also manage skills directly in the file system, for example, to copy in skills from another project. After making changes in the file system, go to **App** > **Synchronize App Directory** (keyboard shortcut: F4) to make the changes visible in Studio Pro. -You can also sync the changes by pressing the **Sync** button in the **Maia skills** overview pane. +You can also sync the changes by clicking the **Sync** button in the **Maia skills** overview pane. -Project-level skills are stored directly under `skillssource` directory: +Project-level skills are stored directly under the `skillssource` directory: ``` skillssource/ @@ -80,7 +79,7 @@ skillssource/ NOTES.md ``` -Skills for particular modules are stored under `_modules` subdirectory: +Skills for particular modules are stored under the `_modules` subdirectory: ``` skillssource/ @@ -109,20 +108,20 @@ For more information on how skills and reference files load, and when they apply At the start of each chat session, Maia becomes aware of all agent skills in your project. As you work, Maia picks up the relevant skill content automatically. You do not need to reference or invoke skills explicitly. -Make sure to provide informative description of a skill as this is the leading information Maia uses to decide whether to read your skill. +Make sure to provide an informative description of a skill, as it is the primary information Maia uses to decide whether to read it. If you add or edit a skill while a session is active, those changes take effect the next time you start a chat. ## Skill Overview {#skill-overview} -Since Studio Pro 11.12, Maia lets you list all registered agent skills. Click the **Skills** button next to +From Studio Pro 11.12, Maia lets you list all registered agent skills. Click the **Skills** button next to **Add** in the Maia input area to open the **Skills** pane. The pane shows whether each skill has loaded successfully, including any error message, references found, and the module the skill belongs to. -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-agent-skills/skills-pane.png" width="400px">}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-agent-skills/skills-pane.png" alt="" width="400px">}} Updates to skills, whether you add a new skill or change an existing one, appear only after you start a new session. -To apply the updated skills immediately, click the **Sync** button in the **Skills** pane. +To apply the updated skills immediately, click the **Sync** button in the **Skills** pane. ## Limitations {#limitations} 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 8bdc88770be..5706688e959 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 @@ -3,7 +3,7 @@ title: "Maia Chat" linktitle: "Chat" url: /refguide/maia-chat/ weight: 5 -description: "Describes the features in Maia Chat." +description: "Describes how to use Maia Chat, the built-in AI chat interface in 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. @@ -16,16 +16,16 @@ Maia Chat is also available in the Mendix Portal. For more information, refer to {{% /alert %}} {{% alert color="info" %}} -To use Maia Chat, an internet connection and signing in to Studio Pro are required. +To use Maia Chat, 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 that you have entered in the Chat to fulfill the user request. Please do not enter any personal or sensitive data! +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. Developers 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. +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. -See below a list of Maia Chat's data sources: +Maia Chat uses the following data sources: * [Mendix Docs](/) * [Mendix Community](https://community.mendix.com/) @@ -37,9 +37,13 @@ See below a list of Maia Chat's data sources: ## Using Maia Chat +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*. + +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*. + ### In Studio Pro 11.8 and Above -In Studio Pro 11.8 and above, Maia Chat is incorporated into the unified Maia Make capabilities, which are enabled by default. There is no dedicated interface only for Maia Chat. For more information, see [Maia Make Capabilities](/refguide/maia-make/). +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/). ### In Studio Pro 11.7 and Below @@ -48,55 +52,23 @@ In Studio Pro 11.7 and below, there are two ways to access Maia Chat in Studio P * Click the **Maia** ({{% icon name="sparkles" %}}) icon to the right of the top bar. * Go to the **View** menu and click **Maia**. -The chat interface appears at the right side of Studio Pro under the **Maia** pane: - -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-chat/maia-chat-interface.png" width="250px">}} - -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*. - -For more information on Maia Chat features in Studio Pro, see the sub-sections below. - -If Maia is not giving you a good answer, check the [best practices](/portal/maia/#best-practices) in *Maia in Mendix Portal*. If you still can not get a good answer, please see the [Giving Feedback](#feedback) section below for information on how to let Mendix know. - -#### Maia Chat Features in Studio Pro - -After a question is sent to Maia Chat, you will see the following in the chat interface: +The chat interface appears on the right side of Studio Pro under the **Maia** pane: -* An answer generated by Maia Chat -* Links to top relevant resources like Mendix documentation, Mendix Community, and Academy learning paths +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-chat/maia-chat-interface.png" alt="" width="250px">}} - {{% alert color="info" %}}You can also see the Mendix version of the references, the level of the learning path if the reference comes from Mendix Academy, and the date and answer status if the reference comes from the Mendix Community.{{% /alert %}} +#### Giving Feedback {#feedback} -* A copy icon ({{% icon name="copy" %}}) which allows you to copy the given answer to a clipboard -* Feedback icons - -##### Giving Feedback {#feedback} - -Mendix encourages giving feedback on the answers generated by Maia Chat. Feedback will be used to further improve Maia Chat. +Mendix encourages you to provide feedback on Maia Chat answers to help improve the feature. There are several ways to give feedback on the generated answer: * Click the thumbs up icon ({{% icon name="thumbs-up" %}}) or the thumbs down icon ({{% icon name="thumbs-down" %}}) -* To provide more detailed feedback, click the add feedback icon ({{% icon name="notes-paper-edit" %}}). A detailed **Feedback** section shows below the answer: - - {{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-chat/feedback-section.png" width="250px" >}} - - * You can rate the **correctness**, **completeness**, and **readability** of the provided answer. - * You can also provide **Additional feedback** if you want to. - * Remember to click **Submit feedback** to submit your feedback. Afterwards, you will be brought back to the main chat interface where you can continue asking questions. - -##### Asking Follow-Up Questions +* To provide more detailed feedback, click the add feedback icon ({{% icon name="notes-paper-edit" %}}). A detailed **Feedback** section appears below the answer: -Maia Chat supports asking follow-up questions based on your previous question and the answer you have received. For example, you can ask it to summarize the latest answer you received by typing the following in the chat: *Can you summarize that?*. + {{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-chat/feedback-section.png" alt="" width="250px" >}} + +Click **Submit feedback** to send your feedback. Maia Chat then returns you to the main chat interface, where you can continue asking questions. -{{% alert color="info" %}} -Maia Chat will lose track of the conversation history if you exit Studio Pro. -{{% /alert %}} - -##### New Chat - -There is a **New chat** option at the top left of the chat interface. It allows you to clear the messages and start a new conversation which does not reference your current chat. - ## Read More -Under the **Maia** pane, there is also a tab called **Learn**. For more information, see [Maia Learn](/refguide/maia-learn/). +The **Maia** pane also includes a **Learn** tab. For more information, see [Maia Learn](/refguide/maia-learn/). 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 76690e11d56..4fc5a2b0b6c 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 @@ -6,24 +6,37 @@ weight: 10 description: "Describes the features in Maia Explain." --- -## Introduction +## Introduction {{% alert color="info" %}} -To use Maia Explain, an internet connection and signing in to Studio Pro are required. +To use Maia Explain, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} ## Using Maia Explain +The initial answer consists of two parts: + +* **Explanation** – provides a high-level overview of the logic, including its overall purpose +* **Technical Highlights** – highlights the technical and functional details of the logic, including any input parameters and return value, if available + +Maia Explain supports follow-up questions. You can modify the tone of the answer, request further clarification, or ask for suggestions to improve the logic. Below are examples of what you can type as follow-up questions or requests: + +* *Explain again, but in 10 words.* +* *Explain again, but in much greater detail. Be very thorough.* +* *What are your suggestions to improve this microflow?* + ### In Studio Pro 11.8 and Above -In Studio Pro 11.8 and above, Maia Explain is incorporated into the unified Maia Make capabilities, which are enabled by default. There is no dedicated interface only for Maia Explain. For more information, see [Maia Make Capabilities](/refguide/maia-make/). +In Studio Pro 11.8 and above, Maia Explain is part of the unified Maia Make capabilities, which are enabled by default. Maia Explain does not have a dedicated interface. For more information, see [Maia Make Capabilities](/refguide/maia-make/). There are two ways to use Maia Explain: -* Use the chat interface directly to get explanations of your document (for instance, a microflow or a page). +* Use the chat interface directly to get explanations of your document (for example, a microflow or a page). * In the App Explorer, right-click a document to open its context menu, and click **Maia Explain**. -Nanoflows are currently not supported by Maia Make. +{{% alert color="info" %}} +Maia Make does not currently support nanoflows. +{{% /alert %}} ### In Studio Pro 11.7 and Below @@ -34,23 +47,12 @@ There are two ways to use Maia Explain: * In the toolbar of the microflow or nanoflow editor, click **Explain**. * In the App Explorer, right-click a microflow or a nanoflow to open its context menu, and click **Explain**. -A message is sent to Maia and a chat interface with an initial answer appears on the right side of Studio Pro under the **Maia** tab: - -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-explain/maia-explain-interface.png" width="300px">}} - -The initial answer consists of two parts: - -* **Explanation** - provides a high-level overview of the logic, including its overall purpose -* **Technical Highlights** - highlights the technical and functional details of the logic, including any input parameters and return value, if available +Studio Pro sends a message to Maia, and a chat interface with an initial answer appears on the right side under the **Maia** tab: -Maia Explain supports follow-up questions. You can modify the tone of the answer, request further clarification, or ask for suggestions to improve the logic. Below are examples of what you could type as follow-up questions or requests: - -* *Explain again, but in 10 words.* -* *Explain again, but in much greater detail. Be very thorough.* -* *What are your suggestions to improve this microflow?"* +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-explain/maia-explain-interface.png" alt="" width="300px">}} {{% alert color="info" %}} -In this dedicated chat, only requests related to Maia Explain will be properly handled. If you have other questions, close this chat and go back to the general [Maia Chat](/refguide/maia-chat/) interface. +In this dedicated chat, only requests related to Maia Explain are properly handled. If you have other questions, close this chat and go back to the general [Maia Chat](/refguide/maia-chat/) interface. {{% /alert %}} ## Read More 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 080bdd25f86..598d0c1bc06 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 @@ -11,71 +11,51 @@ aliases: ## Introduction {{% alert color="info" %}} -To use Maia for Domain Model, an internet connection and signing in to Studio Pro are required. +To use Maia for Domain Model, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} -Maia for Domain Model helps you generate new [domain model](/refguide/domain-model/), and explain and provide suggestions for existing domain models. It has some limitations. For more information, see the [Limitations](#limitation) section below. +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. ## Using Maia for Domain Model +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. + ### 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. There is no dedicated interface only for Maia for Domain Model. For more information, see [Maia Make Capabilities](/refguide/maia-make/). +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.7 and Below -In Studio Pro 11.7 and below, Maia for Domain Model is enabled by default. You can find it in the the toolbar of a domain model: +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: -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model/maia-for-domain-model.png" max-width=80% >}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model/maia-for-domain-model.png" alt="" max-width=80% >}} If you want to disable this feature, go to **Edit** > **Preferences** > the **Maia** tab and clear the **Enable Maia for Domain Model** checkbox. -After clicking **Maia for Domain Model**, a dedicated chat interface will appear at the right side of Studio Pro under the **Maia** tab: - -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model/chat-interface.png" max-width=42% >}} +After clicking **Maia for Domain Model**, a dedicated chat interface appears on the right side of Studio Pro under the **Maia** tab: -Describe your application or its main goals in the chat. Maia will use this information to generate a relevant domain model for you. In Studio Pro 11.1 and above, you can also attach maximally one image and one PDF to help Maia better understand your request. For more information, see the [Attachment Requirements](#attachment-requirements) section below. - -After a domain model is generated and if the dedicated chat is still active, you can continue asking Maia to add more entities and associations to the generated domain model. It also supports adding more attributes to an existing entity in the generated domain model.You can also ask Maia to explain or improve the generated domain model through further requests. +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model/chat-interface.png" alt="" max-width=42% >}} {{% alert color="info" %}} Maia for Domain Model does not support deleting items in the domain model. You can always delete them manually. {{% /alert %}} {{% alert color="info" %}} -In this dedicated chat, only requests related to domain model will be properly handled. If you have other questions, close this chat and go back to the general [Maia Chat](/refguide/maia-chat/) interface. +In this dedicated chat, only requests related to the domain model are handled. If you have other questions, close this chat and go back to the general [Maia Chat](/refguide/maia-chat/) interface. {{% /alert %}} - -#### Best Practices for Text Input - -To achieve optimal results, provide context about your application by describing its main use cases, customer needs, or other relevant details. The more Maia knows about your application, the more tailored and accurate the generated domain model will be. - -Below are some examples of prompts you can use as a starting point: - -* The app will help users ... -* This module handles ... -* Customers need to be able to ... -* I want to send notifications when ... -* The app will analyze and report on ... -* This feature allows users to ... - -Below are examples of prompts you can use to ask Maia for explanations or suggestions to improve a domain model: - -* Can you explain the function and purpose of this domain model? -* I want to add an attribute `ATTRIBUTE_NAME` to the entity `ENTITY_NAME`. -* I want to make the domain model more efficient. Can you suggest optimizations? -* Could you identify any potential issues with this domain model and recommend solutions? #### Attachment Requirements {#attachment-requirements} -In Studio Pro 11.1 and above, Maia for Domain Model supports adding a maximal of one image and one PDF as attachments. The attachments must meet the following requirements: +In Studio Pro 11.1 and above, Maia for Domain Model supports adding up to one image and one PDF as attachments. The attachments must meet the following requirements: * The image format must be PNG or JPG. * The image file size must not exceed 512 KB. * The image resolution must be no greater than 3840 × 2400 pixels. * The PDF file size must not exceed 1024 KB. -#### Limitations {#limitation} +## Limitations {#limitation} Maia for Domain Model has the following limitations: diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-microflows.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-microflows.md index 2688da0bb3a..6dd902f005f 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-microflows.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-microflows.md @@ -4,29 +4,26 @@ url: /refguide/maia-for-microflows/ weight: 75 description: "Describes the features in Maia for Microflows." --- + ## Introduction {{% alert color="info" %}} -This feature was released as part of [Make Make](/refguide/maia-make/) capabilities in Studio Pro 11.8. +This feature was released as part of [Maia Make](/refguide/maia-make/) capabilities in Studio Pro 11.8. -To use Maia for Microflows, an internet connection and signing in to Studio Pro are required. +To use Maia for Microflows, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} -Maia for Microflows is an AI-powered capability that is available when using [Maia Make](/refguide/maia-make/) in Studio Pro. Maia Make is a unified conversational interface within Studio Pro that consolidates all AI-assisted development capabilities into a single chat experience. +Maia for Microflows is an AI-powered capability available in [Maia Make](/refguide/maia-make/) in Studio Pro. Maia Make is a unified conversational interface within Studio Pro that consolidates all AI-assisted development capabilities into a single chat experience. -With the microflow generation capability, you can leverage Maia to generate microflow logic efficiently from your text input. It is a powerful tool for quickly setting up both simple and complex microflows, with the goal of providing ready-to-use logic that minimizes the need for manual adjustments. +With the microflow generation capability, you can use Maia to generate microflow logic from your text input. It quickly sets up both simple and complex microflows and provides ready-to-use logic that reduces the need for manual adjustments. ## Using Maia for Microflows -Open the Maia Make conversational interface in Studio Pro to access its microflow generation capability. Use natural language to describe your goal, Maia will generate the microflows for you, including XPath constraints and expressions. See the section below for text input best practices. - -### Best Practices for Text Input +Open the Maia Make conversational interface in Studio Pro to access its microflow generation capability. Use natural language to describe your goal. Maia generates the microflows for you, including XPath constraints and expressions. -To achieve the best results when using Maia to generate microflows, consider the following guidelines for your text input: - -* Be specific: Clearly describe the desired outcome and the steps involved. For example, instead of using *Create a user*, use *Create a new user object, set its name attribute to 'John Doe', and commit it*. -* Use keywords: Incorporate terms relevant to microflow activities, such as *create object*, *retrieve*, *change object*, *show message*, *loop*, or *decision*. This can help with correct microflow generation. -* Provide context: If your microflow interacts with existing entities or attributes, mention them in your text input. +{{% alert color="warning" %}} +Due to the nature of AI generation, the exact microflow logic produced can vary between separate runs, even with identical input. Review the generated output carefully. The visual layout and positioning of elements may not always be optimally organized; you may need to adjust the arrangement of activities for better readability and structure. +{{% /alert %}} ## Limitations @@ -38,14 +35,6 @@ In Studio Pro 11.9 and above, Maia can delete flows and microflow objects. Howev In Studio Pro 11.8, Maia cannot delete objects or flows. For existing objects, Maia can change variable names, move objects, or reconnect flows, but it cannot delete objects or flows, or change the activity types. -### Variability in Results - -Due to the nature of AI generation, the exact microflow logic produced can vary between separate runs, even with identical input. It is recommended to review the generated output carefully. - -### Layout and Positioning - -While Maia aims to create functional logic, the visual layout and positioning of elements within the generated microflow may not always be optimally organized. You may need to adjust the arrangement of activities for better readability and structure. - ## Read More * [Microflows](/refguide/microflows/) 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 4040e20fd34..a07577b1680 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 @@ -8,16 +8,20 @@ description: "Describes the features in Maia for OQL Generation." ## Introduction {{% alert color="info" %}} -To use Maia for OQL, an internet connection and signing in to Studio Pro are required. +To use Maia for OQL, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} -Maia for OQL is a powerful feature that enables you to generate and manage OQL (Object Query Language) queries through an intuitive interface. It is designed to simplify query creation and reduce manual effort. Currently it has some limitations. For more details, see the [Limitations](#limitations) section below. +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. ## Using Maia for OQL +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. + +Maia interprets your intent and provides a query that fits your requirements, helping you avoid manual query creation and common syntax errors. + ### 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. There is no dedicated interface only for Maia for OQL. For more information, see [Maia Make Capabilities](/refguide/maia-make/). +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/). {{% 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**. @@ -25,19 +29,15 @@ Studio Pro 11.13 and above, and 11.12.2 and above, include a setting to enable o ### In Studio Pro 11.8 and Below -In Studio Pro 11.8 and below, to enable Maia for OQL, navigate to **Edit** > **Preferences** > the **Maia** tab and select **Enable Maia for OQL Generation**. +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**. -Once enabled, you can access it from the toolbar in the **OQL Editor**: +After you enable it, you can access it from the toolbar in the **OQL Editor**: -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-oql-generator/maia-for-oql-button.png" max-width=80% >}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-oql-generator/maia-for-oql-button.png" alt="" max-width=80% >}} Clicking **Maia for OQL** opens a dedicated chat interface on the right side of Studio Pro, under the **Maia** tab: -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-oql-generator/maia-pane-for-oql-generator.png" max-width=42% >}} - -To use Maia for OQL, simply describe the data you need. For example, if you type *Show all active orders with customer names*, Maia will generate the most relevant OQL query based on the data available in the same module. - -Maia interprets your intent and provides a query that fits your requirements, helping you avoid manual query creation and common syntax errors. +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-oql-generator/maia-pane-for-oql-generator.png" alt="" max-width=42% >}} ## Limitations {#limitations} 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 bfb859a60bf..46838df5fa6 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 @@ -11,20 +11,26 @@ aliases: ## Introduction {{% alert color="info" %}} -To use Maia for Pages, an internet connection and signing in to Studio Pro are required. +To use Maia for Pages, 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. It can also be used to edit or remove existing widgets. Moreover, you can ask it to provide further improvements and explanations. For information on the current limitations of Maia for Pages, see the [Limitations](#limitation) section below. +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. ## Using Maia for Pages +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. + ### 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. There is no dedicated interface only for Maia for Pages. For more information, see [Maia Make Capabilities](/refguide/maia-make/). +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, only overview pages can be generated. -In Studio Pro 11.9 and above, custom pages can be generated from scratch and modifying existing pages is also supported. Moreover, local variables, additional data sources, client actions, XPath constraints, and expressions are supported. +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 @@ -38,53 +44,19 @@ Once enabled, you can find it in the the toolbar of a page: Maia for Pages is available in both the **Structure mode** and **Design mode**. {{% /alert %}} -After clicking **Maia for Pages**, a dedicated chat interface appears at the right side of Studio Pro under the **Maia** tab: +After clicking **Maia for Pages**, a dedicated chat interface appears on the right side of Studio Pro under the **Maia** tab: -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-for-pages/chat-interface.png" max-width=42% >}} - -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. +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-for-pages/chat-interface.png" alt="" max-width=42% >}} {{% alert color="info" %}} -In this dedicated chat, only requests related to Pages will be properly handled. If you have other questions, close this chat and go back to the general [Maia Chat](/refguide/maia-chat/) interface. +In this dedicated chat, only requests related to Pages are handled. If you have other questions, close this chat and go back to the general [Maia Chat](/refguide/maia-chat/) interface. {{% /alert %}} -#### Best Practices for Text Input - -To achieve optimal results, provide context about your page by describing its main use cases, customer needs, or other relevant details. The more Maia knows about your page, the more tailored and accurate the generated page will be. - -Below are examples of prompts you can use as a starting point: - -* The page will be used to ... -* I need a page to be able to edit my entity ... -* Create a page based on the image. -* Base the page on the image, but change ... to ... - -Below are examples of prompts you can use to ask Maia to make further edits or request suggestions for improving a page: - -* Can you add a button called `BUTTON_NAME` to the page? -* I want an area on the page where users can ... -* Make the save button a primary button. -* Change the page header to use Heading 1. -* Remove the ... widget. -* Delete all widgets on the page. -* How can I make this page more user-friendly or visually appealing? -* Could you suggest ways to optimize the performance of this page? - -#### Best Practices for Image Input - -The image size is limited to 512 KB. Make sure to select a clear image to help Maia better understand your request. For example, you can provide a screenshot, a photo, a design mock-up, or a close-up picture of a drawing. Avoid heavily compressed or low quality images, as these may result in the loss of important details. - -Keep in mind that Maia analyzes only the structure of the image. The theming of your app, such as the color scheme, will not be changed. This can cause some differences between the provided image and the generated page. - -### Limitation {#limitation} +## Limitations {#limitation} -Maia for Pages does not support all widgets. +Maia for Pages does not support all widgets. -Currently the following widgets are supported: +The following widgets are supported: * [Container](/refguide/container/) * [Layout Grid](/refguide/layout-grid/) 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 33f429c09fa..ec6d7bda4cd 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 @@ -9,14 +9,14 @@ description: "Describes the features in Maia for Workflows." ## Introduction {{% alert color="info" %}} -To use Maia for Workflows, an internet connection and signing in to Studio Pro are required. +To use Maia for Workflows, 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 further improvements based on the generated elements. The current version has some known limitations. For more details, see the [Limitations](#limitation) section below. +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. ## Using Maia for Workflows -Describe a business process you want to model. Maia uses this information to add relevant workflow activities, and tries to configure them where possible. For more information on how to communicate with Maia to achieve better results when configuring a workflow, see the [Best Practices for Text Input](#text-input-best-practice) section below. +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*. ### Version Availability @@ -30,43 +30,16 @@ Maia for Workflows 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**. Once enabled, you can find it in the toolbar of a workflow: +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" max-width=80% >}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-for-workflows/maia-for-workflows.png" alt="" max-width=80% >}} -After clicking **Maia for Workflow**, a chat interface appears at the right side of Studio Pro under the **Maia** tab: +After clicking **Maia for Workflows**, a chat interface appears on the right side of Studio Pro under the **Maia** tab: -{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-for-workflows/chat-interface.png" max-width=42% >}} - -### Best Practices for Text Input {#text-input-best-practice} - -To achieve optimal results, provide context about your workflow by describing its main use cases, customer needs, or other relevant details. The more Maia knows about your workflow, the more tailored and accurate the generated workflow will be. - -Below are some examples of prompts you can use as a starting point: - -* Please generate a workflow for a process that... -* Create a workflow based on the image. -* Base the workflow on the image, but change ... to ... - -Maia for Workflows can analyze a BPMN image representing employee onboarding, rework it using Mendix Workflows terminology, and generate the corresponding activities for you. Alongside the image, you can also use text input to specify how the generated workflow should differ from the provided image. For example, you might write: *Generate a workflow based on this BPMN image, but make sure it waits before sending an email to the new employee.* - -Make sure to select a clear image to help Maia better understand your request. For example, you can provide a screenshot, a photo, BPMN schema, or a close-up picture of a drawing. Avoid heavily compressed or low quality images, as these may result in the loss of important details. - -Below are some examples of prompts you can use to ask Maia for further explanations or suggestions to improve the generated workflow: - -* Can you explain this workflow to me? -* Can you give me suggestions to improve this workflow? -* Can you make the timer wait for 5 days? -* I want the process to run in parallel. - -{{% alert type="info" %}} -Workflow generation may take longer than other Maia features. Performance improvements are planned for a future release. -{{% /alert %}} +{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-for-workflows/chat-interface.png" alt="" max-width=42% >}} ## Limitations {#limitation} -Maia for Workflows currently has some limitations. - ### Not All Properties Can Be Configured Due to the complex cross-document nature of a workflow, not all properties of the workflow elements can be generated yet. The following properties cannot be configured yet: diff --git a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-instructions.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-instructions.md index 81348f43906..f6830f4df6e 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-instructions.md +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-instructions.md @@ -10,14 +10,14 @@ description: "Describes how to create and manage Maia Instructions (AGENTS.md) t ## Introduction {{% alert color="info" %}} -This feature was released as part of [Maia Make](/refguide/maia-make/) capabilities in Studio Pro 11.12. +This feature is part of [Maia Make](/refguide/maia-make/) and was introduced in Studio Pro 11.12. -To use Maia Agent Instructions, an internet connection and signing in to Studio Pro are required. +To use Maia Agent Instructions, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} Maia Instructions are agent instructions that are automatically added to the conversation context. They let you define shared prompt context, such as company conventions or environment restrictions, once and reuse it when needed. -They can be provided at the project level or module level. Project-level instructions are included in every conversation in the project. Module-level instructions are included whenever Maia starts working in the given module. +They can be provided at the project level or module level. Project-level instructions are included in every conversation in the project. Module-level instructions are included whenever Maia starts working in that module. Maia Instructions follow the [AGENTS.md standard](https://agents.md) for agent instructions. @@ -29,29 +29,28 @@ Maia supports both [agent skills](/refguide/maia-agent-skills/) and agent instru | ------------- | --------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | Loading | Deterministically loaded, whenever working with the given project or module. | Agent decides to load skills on demand, based on their name and description. | | Applicability | Project or module-wide instructions that should always be part of context (for example, company preferences). | Instructions that are applicable only in certain situations (for example, microflow conventions). | -| Organization | Single file, should be kept as short as possible. | Allows you to split instructions into the core skill and additional references that Maia reads on demand as needed. | +| Organization | Single file, should be kept as short as possible. | Allows you to split instructions into the core skill and additional references that Maia reads on demand. | ## Creating a New Maia Instruction {#creating-instructions} To create a new Maia Instruction, follow these steps: -1. In the **App Explorer**, find either the **Maia** node under **App** for project-level instructions, or the **Maia** node under a module if you wish to add a module-level instruction. +1. In the **App Explorer**, find either the **Maia** node under **App** for project-level instructions, or the **Maia** node under a module if you want to add a module-level instruction. 2. Right-click this node and click **Add** > **Agent instructions**. -Studio Pro creates the `AGENTS.md` file. You can continue adding the instruction content. +Studio Pro creates the `AGENTS.md` file. You can now add the instruction content. -{{% alert color="info" %}}Newly added instructions or changes to existing instructions are discovered only when new session is started.{{% /alert %}} +{{% alert color="info" %}}New instructions and changes to existing instructions take effect only when you start a new session.{{% /alert %}} ### Instructions Content {#instructions-content} Maia Instructions are arbitrary Markdown files that follow the AGENTS.md standard. You can structure them any way you like. -However, it is recommended to include only instructions that are applicable to every prompt in the given project or module. For example, you can add naming conventions, limitations of your environment, or language preferences to the agent instructions. If the instructions are applicable only when working with a single module in the project, you should add instructions at the module level. +However, Mendix recommends including only instructions that are applicable to every prompt in the given project or module. For example, you can add naming conventions, environment limitations, or language preferences. If the instructions apply only to a single module, add them at the module level. ### Directory Structure {#directory-structure} -Project-level instructions are stored as `skillssource/AGENTS.md`, while module-level instructions are stored as -`skillssource/_modules//AGENTS.md`. You can add only one instructions file per project or per module. +Project-level instructions are stored as `skillssource/AGENTS.md`, while module-level instructions are stored as `skillssource/_modules//AGENTS.md`. You can add only one instructions file per project or per module. ## Read More 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 305904a8603..b6aec826c89 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 @@ -10,14 +10,14 @@ description: "Describes the features in Maia MCP Client." ## Introduction {{% alert color="info" %}} -This feature was released as part of [Maia Make](/refguide/maia-make/) capabilities in Studio Pro 11.8. +This feature is part of [Maia Make](/refguide/maia-make/) and was introduced in Studio Pro 11.8. -To use Maia MCP Client, an internet connection and signing in to Studio Pro are required. +To use Maia MCP Client, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} Maia MCP Client, available from Studio Pro 11.8, helps you connect Maia to external [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) servers. Once connected, Maia can call tools provided by these servers during chat — for example, querying an external API, looking up design assets, or interacting with third-party services. You can find available MCP servers on the [MCP servers directory](https://modelcontextprotocol.io/examples). -For information on the current limitations, see the [Limitations](#limitations) section below. +For details on the current limitations, see the [Limitations](#limitations) section below. ## Using MCP Client {#using-mcp-client} @@ -28,11 +28,11 @@ There are two ways to open the MCP Client panel: ### Preset Servers {#preset-servers} -Preset MCP servers allow you connect to common services without entering URLs or credentials. +Preset MCP servers allow you to connect to common services without entering URLs or credentials. #### Mendix Marketplace {#mendix-marketplace-preset} -Studio Pro adds the **Mendix Marketplace** connection automatically when you open the MCP Client panel. It authenticates with your Mendix ID, so no extra credentials are needed. Marketplace tools are disabled by default; enable the ones you need from the expanded card. +Studio Pro adds the **Mendix Marketplace** connection automatically when you open the MCP Client panel. It authenticates using your Mendix ID, so no extra credentials are needed. Marketplace tools are disabled by default; enable the ones you need from the expanded card. Mendix manages this connection. You cannot remove it, but you can enable or disable it using the checkbox on the **Mendix Marketplace** card. @@ -40,8 +40,8 @@ Mendix manages this connection. You cannot remove it, but you can enable or disa Click **Add MCP Server** to open the catalog alongside the manual entry form. Each preset appears as a tile. Click a tile to select it. Studio Pro sets the URL, connection type, and authentication type automatically. Only the server name remains editable. -* For OAuth presets: click **Authenticate** to authorize in your browser, then click **OK** to save -* For bearer token presets: enter your token, then click **OK** +* For OAuth presets: click **Authenticate** to authorize in your browser, then click **OK** to save. +* For bearer token presets: enter your token, then click **OK**. Tools from new preset connections are disabled by default. Enable the tools you need from the expanded connection card. @@ -60,7 +60,7 @@ Choose how Studio Pro authenticates with the MCP server: * **No Auth** — select this for servers that do not require credentials. * **Bearer Token** — paste an API token or personal access token. The token is stored securely and is not exposed after entry. -* **Mendix Identity** — authenticates using the Mendix account you are already signed in to Studio Pro with. No extra credentials are needed. Use this option when connecting to MCP services provided by Mendix. +* **Mendix Identity** — authenticates using the Mendix account you use to sign in to Studio Pro. No extra credentials are needed. Use this option when connecting to MCP services provided by Mendix. * **OAuth 2.1** — a browser window opens so you can authorize Studio Pro with the server's provider. Two optional fields appear: * **Client ID** — required if the server does not support automatic client registration. * **Client Secret** — required by some providers (for example, GitHub). @@ -80,7 +80,7 @@ Most major providers — including GitHub and Figma — do not support automatic * **URL** — `https://api.githubcopilot.com/mcp/` * **Authentication** — **OAuth 2.1** * **Client ID** and **Client Secret** — from the steps above -6. Click **Add**, authorize in the browser, and the connection completes. +6. Click **Add** and authorize in the browser to complete the connection. {{% alert color="info" %}} For Figma MCP, the simplest option is to generate a personal access token in Figma and use **Bearer Token** authentication. If you need OAuth, register an app at [Figma Developers](https://www.figma.com/developers), add the callback URL, and request the `mcp:connect` scope. @@ -134,7 +134,7 @@ If a connection drops, Studio Pro reconnects automatically. During reconnection, After connecting, the server's tools appear in the expanded card. Each tool shows a name and description from the server. -Tools from a new server are **disabled by default**. Select a tool's checkbox to enable it. Use the **select all** checkbox to enable or disable all tools at once. Only enabled tools are available to Maia. +Tools from a new server are disabled by default. Select a tool's checkbox to enable it. Use the **select all** checkbox to enable or disable all tools at once. Only enabled tools are available to Maia. ### How Maia Uses MCP Tools {#using-tools} @@ -150,7 +150,7 @@ You see the answer from Maia, not the raw tool output. | Problem | Solution | | --- | --- | -| "This server requires manual OAuth client registration" | Register an OAuth app with the provider and enter the Client ID. See the [GitHub example](#github-example) given above. | +| "This server requires manual OAuth client registration" | Register an OAuth app with the provider and enter the Client ID. See the [GitHub example](#github-example) section above. | | "Token exchange failed" or "incorrect_client_credentials" | Verify your Client ID and Client Secret. Check that the callback URL matches. | | Authentication stuck in "Authenticating..." | Check that no firewall blocks localhost. Remove the server and add it again to restart the flow. | | Connection fails immediately | Verify the URL. Try switching between **HTTP (Streamable)** and **SSE (Legacy)**. | 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 90306b3b91b..393dfdeddc4 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 @@ -10,9 +10,9 @@ description: "Describes Maia's web fetch capability for retrieving content from ## Introduction {{% alert color="info" %}} -This feature was released as part of [Maia Make](/refguide/maia-make/) capabilities in Studio Pro 11.10. +This feature is part of [Maia Make](/refguide/maia-make/) and was introduced in Studio Pro 11.10. -To use Maia Web Fetch, an internet connection and signing in to Studio Pro are required. +To use Maia Web Fetch, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} Maia can fetch and read content from public websites and APIs. It can retrieve documentation, access API endpoints, read configuration files, and gather information from the web to assist with your development tasks. @@ -23,7 +23,7 @@ When Maia wants to fetch content from the web, it asks for your permission first ## Enabling or Disabling Web Tools -In Studio Pro 11.11 and above, you can enable or disable this feature by navigating to **Preferences** > **Maia**, and selecting or deselecting **Enable web tools**. Restart Studio Pro for the change to take effect. +In Studio Pro 11.11 and above, you can enable or disable this feature by going to **Preferences** > **Maia** and selecting or clearing **Enable web tools**. Restart Studio Pro for the change to take effect. For Studio Pro 11.12 and above, the changes take effect immediately and do not require restart. @@ -40,8 +40,8 @@ Maia can retrieve the following types of content: Maia cannot access the following: -* **Internal or private addresses** — Maia does not fetch from localhost, private IP ranges (like 192.168.x.x or 10.0.0.x), or your local machine's internal services. -* **Binary content** — Images, videos, PDFs, and archives cannot be fetched. If a URL serves binary content, Maia is not able to read it. +* **Internal or private addresses** — Maia does not fetch from localhost, private IP ranges (such as 192.168.x.x or 10.0.0.x), or your local machine's internal services. +* **Binary content** — Images, videos, PDFs, and archives cannot be fetched. If a URL serves binary content, Maia cannot read it. * **Very large responses** — Responses larger than 1 MB are rejected. * **Non-HTTPS URLs** — Only secure HTTPS connections are supported. 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 dd721ae08c3..ec983118393 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 @@ -10,17 +10,17 @@ description: "Describes the features in Studio Pro MCP Server." ## Introduction {{% alert color="info" %}} -This feature was released in Studio Pro 11.10. +This feature is available from Studio Pro 11.10. -To use Studio Pro MCP Server, an internet connection and signing in to Studio Pro are required. +To use Studio Pro MCP Server, you need an internet connection and must be signed in to Studio Pro. {{% /alert %}} -Studio Pro MCP Server enables bring your own agent (BYO Agent) capabilities, allowing you to leverage Maia's capabilities directly from external clients, including AI coding assistants, agents, and other MCP-based LLM tools. +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. -It has the following key highlights: +It has the following highlights: * Full Maia feature parity — The MCP Server exposes the same capabilities that Maia offers within Studio Pro. -* Live updates — Any changes made through Maia via the MCP Server are reflected in real time within Studio Pro. +* Live updates — Changes made through Maia via the MCP Server appear in real time in Studio Pro. {{% alert color="info" %}} 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. @@ -28,7 +28,7 @@ When you connect external agents or AI tools to Studio Pro's MCP Server, those t ## Enabling the MCP Server -To enable the MCP Server, navigate to **Preferences** > **AI** > **MCP Server**, and check **Enable MCP Server**. You can also configure the port in this menu. +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. ### Connecting External Clients @@ -43,7 +43,7 @@ Replace `` with your preferred server name and `` with the port conf The following limitations apply only to Studio Pro 11.10: * The MCP Server cannot generate pages. -* Web fetch is blocking — When a web fetch tool call is performed by the MCP Client, the operation awaits user approval in Studio Pro. For more information, see [Maia Web Fetch](/refguide/maia-web-fetch/). +* Web fetch is blocking — When the MCP Client performs a web fetch tool call, the operation awaits user approval in Studio Pro. For more information, see [Maia Web Fetch](/refguide/maia-web-fetch/). ## Read More