diff --git a/content/en/docs/refguide/mendix-ai-assistance/_index.md b/content/en/docs/refguide/mendix-ai-assistance/_index.md index ca4b2a654f8..4702718b52c 100644 --- a/content/en/docs/refguide/mendix-ai-assistance/_index.md +++ b/content/en/docs/refguide/mendix-ai-assistance/_index.md @@ -45,13 +45,14 @@ 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. - This unified conversational interface is released in Studio Pro 11.8. For more information, see [Maia Make](/refguide/maia-make/). + This unified conversational interface was released in Studio Pro 11.8. For more information, see [Maia Make](/refguide/maia-make/). Guidance: * **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/). * **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](/refguide/maia-agent-skills/). Recommenders: 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 ef1778aefef..7cac57fcb38 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 @@ -10,33 +10,57 @@ description_list: true ## Introduction {{% alert color="info" %}} -Maia Make capabilities are grouped into a conversational interface, which is available in Studio Pro 11.8 and above. +Maia Make capabilities are available in Studio Pro 11.8 and above. -To use this interface and Maia Make capabilities, an internet connection and signing in to Studio Pro are required. +To use Maia Make capabilities, an internet connection and signing in to Studio Pro are required. {{% /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. 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. -The key Maia Make capabilities are as follows: +## Maia Capabilities Overview -* Conversational assistance for general Mendix development queries -* Explanations of documents to clarify existing implementation details -* Generation of documents from natural language descriptions, such as domain model, pages, and microflows -* Integration with external tools, such as Playwright and Figma, via compatible MCP Servers -* Story-based development to help realize existing user stories -* Support for PDF and image inputs to help Maia better understand your requirements -* Adding relevant documents, such as microflows and pages, to the interface to give Maia a more desired context -* Editing existing documents, including renaming elements inside of documents such as entities, attributes, and microflow parameters -* Removing elements from documents, enabling more advanced refactoring (in Studio Pro 11.9 and above) -* Undoing changes generated on a per-document basis (in Studio Pro 11.9 and above) +The following table lists the major Maia Make capabilities, their descriptions, and the Studio Pro versions in which they were introduced as part of Maia Make: -{{% alert color="info" %}} -Support for workflows, view entities, enumerations, constants, modules, Java actions, and JavaScript actions was introduced in Studio Pro 11.9. In this version, Java actions are read-only; they can be used in microflows and explained. JavaScript actions can only be explained. +| Capability | Description | Available in Maia Make from | +| --- | --- | --- | +| [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 such as microflows and pages. | Studio Pro 11.8 | +| [Maia for Domain Model](/refguide/maia-for-domain-model/) | Generates and explains domain models. | Studio Pro 11.8 | +| [Maia for Pages](/refguide/maia-for-pages/) | Generates pages and widgets from text or image input. | Studio Pro 11.8 | +| [Maia for Microflows](/refguide/maia-for-microflows/) | Generates microflow logic from natural language descriptions. | Studio Pro 11.8 | +| [Maia for Workflows](/refguide/maia-for-workflows/) | Generates workflows from natural language or image input. | Studio Pro 11.9 | +| [Maia for OQL](/refguide/maia-for-oql/) | Generates and manages OQL queries. | Studio Pro 11.9 | +| [Maia MCP Client](/refguide/maia-mcp/) | Connects Maia to external MCP servers, giving it access to third-party tools during chat. | 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 during chat. | Studio Pro 11.10 | +| [Maia Agent Skills](/refguide/maia-agent-skills/) | Extends Maia with reusable, domain-specific knowledge that applies automatically when relevant. | Studio Pro 11.11 | + +In addition to the core capabilities listed above, Maia Make includes the following features: + +| Capability | Description | Available in Maia Make from | +| --- | --- | --- | +| 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, such as microflows and pages, to provide Maia with additional context during chat. | Studio Pro 11.8 | +| Editing existing documents | Enables Maia to modify existing documents, including renaming elements such as entities, attributes, and microflow parameters. | 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 | + +### Other Supported Document Types + +In Studio Pro 11.9, support for enumerations, constants, modules, Java actions, and JavaScript actions was added. In this version, Java actions are read-only; they can be used in microflows and explained. JavaScript actions can only be explained. Starting with Studio Pro 11.10, Maia can generate JavaScript actions, add parameters to existing ones, and create or update the JavaScript file associated with a JavaScript action. -{{% /alert %}} + +### Support for Folder Structure + +In Studio Pro 11.10 and above, Maia understands and leverages the existing folder structure within your Mendix applications for all documents except for pages. This enables Maia to: + +* Organize documents into folders: When creating new documents, Maia can place them directly into relevant folders, respecting your project's organization. +* Follow existing folder structures: Maia works within your established folder hierarchy, making it easier to maintain consistency. +* Adhere to Mendix best practices: Maia can help organize documents according to the standard Mendix best practices for folder structure. For detailed guidance on optimal organization of folders, refer to the [Folder Structure](/refguide/naming-convention-best-practices/#folder-structure) section in *Naming Convention Best Practices*. ## Using Maia Make Capabilities @@ -67,29 +91,6 @@ The conversational interface includes the following options: * **{{% icon name="paperclip" %}} Add** (Image, Story, PDF) - With this option, you can attach images, PDFs, or user stories to help Maia understand your requirements better. * **Add file to Maia Chat** (@ icon) - It 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. -#### Support for Folder Structure - -In Studio Pro 11.10 and above, Maia understands and leverages the existing folder structure within your Mendix applications for all documents except for pages. This enables Maia to: - -* Organize documents into folders: When creating new documents, Maia can place them directly into relevant folders, respecting your project's organization. -* Follow existing folder structures: Maia works within your established folder hierarchy, making it easier to maintain consistency. -* Adhere to Mendix best practices: Maia can help organize documents according to the standard Mendix best practices for folder structure. For detailed guidance on optimal organization of folders, refer to the [Folder Structure](/refguide/naming-convention-best-practices/#folder-structure) section in *Naming Convention Best Practices*. - -For more information on how each Maia Make capability work, refer to the following documents: - -* [Maia Chat](/refguide/maia-chat/) -* [Maia Explain](/refguide/maia-explain/) -* [Maia for Domain Model](/refguide/maia-for-domain-model/) -* [Maia for Pages](/refguide/maia-for-pages/) -* [Maia for Microflows](/refguide/maia-for-microflows/) -* [Maia for Workflows](/refguide/maia-for-workflows/) (in Studio Pro 11.9 and above) -* [Maia for OQL](/refguide/maia-for-oql/) (in Studio Pro 11.9 and above) -* [Maia MCP Client](/refguide/maia-mcp/) -* [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/) -* [Maia Web Fetch](/refguide/maia-web-fetch/) - -In Studio Pro 11.8 and above, most of the features described in the documents above are available only through the chat interface. There are no separate entry points to these features in their respective editors. [Maia Explain](/refguide/maia-explain/) is an exception. You can still access this feature by right-clicking the documents (for example, microflows or pages) in the **App Explorer** and the **Maia Explain** option is in the context menu. - ## 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 new file mode 100644 index 00000000000..785e84a2243 --- /dev/null +++ b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-agent-skills.md @@ -0,0 +1,101 @@ +--- +title: "Maia Agent Skills" +linktitle: "Agent Skills" +url: /refguide/maia-agent-skills/ +weight: 95 +description: "Describes how to create and manage agent skills that equip Maia with domain-specific knowledge, applied automatically whenever relevant." +#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" %}} +This feature was released as part of [Maia Make](/refguide/maia-make/) capabilities in Studio Pro 11.11. + +To use Maia Agent Skills, an internet connection and signing in to Studio Pro are required. +{{% /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. + +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/). + +## Creating an Agent Skill {#creating-a-skill} + +To create a new agent skill in Studio Pro, follow these steps: + +1. In the **App Explorer**, expand **Maia** > **skills**. +2. Right-click **skills** and click **Add** > **Skill**. +3. Enter a name for the skill. + +Studio Pro creates the `SKILL.md` file. You can continue adding the skill content. + +### SKILL.md Format {#skill-md-format} + +Each `SKILL.md` file must include YAML frontmatter at the top, followed by the skill content in Markdown: + +```yaml +--- +name: your-skill +description: Applies company-wide naming conventions for entities, attributes, and microflows. +--- + +Write your skill instructions here in plain Markdown. Use the `references/` subdirectory +to add supplementary content and refer to it from here as needed. + +See [my-reference](references/my-reference.md) for details. +``` + +| Field | Required | Description | +| --- | --- | --- | +| `name` | Yes | Must match the skill's parent directory name exactly. For full naming rules, see [Agent Skills Specification](https://agentskills.io/specification#name-field). | +| `description` | Yes | See [Agent Skills Specification](https://agentskills.io/specification#description-field). | + +The `name` field must match the skill's parent directory name exactly. A mismatch prevents the skill from loading. For example, if the skill directory is `skillssource/your-skill/`, the `name` field must be `your-skill`. + +### 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. + +``` +skillssource/ + your-skill/ + SKILL.md + references/ + GLOSSARY.md + NOTES.md +``` + +## Adding Reference Files {#reference-files} + +Reference files let you keep your skill focused by moving supplementary content into separate documents, such as a glossary of domain terms, a data dictionary, or detailed architecture notes. Maia accesses reference file content on demand, only when relevant to your request. + +To add a reference file to a skill, follow these steps: + +1. In the **App Explorer**, under **Maia** > **skills**, right-click the skill you want to add a reference to. +2. Click **Add** > **Reference**. +3. Enter a name for the reference file. + +For more information on how skills and reference files load, and when they apply, see [Agent Skills Specification](https://agentskills.io/specification#progressive-disclosure). + +## How Agent Skills Work + +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. + +If you add or edit a skill while a session is active, those changes take effect the next time you start a chat. + +## Limitations {#limitations} + +* Only Markdown files are supported as reference files. Files in other formats are ignored. +* Changes you make to skills take effect the next time you start a chat. + +## Read More + +* [Maia Make Capabilities](/refguide/maia-make/) +* [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) +* [Maia Chat](/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-for-microflows.md b/content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-microflows.md index 4dcc78daaf2..2688da0bb3a 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 @@ -7,7 +7,9 @@ description: "Describes the features in Maia for Microflows." ## Introduction {{% alert color="info" %}} -This feature is released as part of [Make Make](/refguide/maia-make/) capabilities in Studio Pro 11.8. +This feature was released as part of [Make 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. {{% /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. 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 b174c5b4311..776f833d907 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,7 +8,7 @@ description: "Describes the features in Maia for OQL Generation." ## Introduction {{% alert color="info" %}} -An internet connection and signing in to Studio Pro are required to use Maia for OQL. +To use Maia for OQL, an internet connection and signing in to Studio Pro are required. {{% /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. 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 b8838a7265f..52fa90d35d2 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,7 +10,7 @@ description: "Describes the features in Maia MCP Client." ## Introduction {{% alert color="info" %}} -This feature is released as part of [Maia 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 MCP Client, an internet connection and signing in to Studio Pro are required. {{% /alert %}} 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 293a9a48bcf..bbfc8722f66 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,7 +10,7 @@ description: "Describes Maia's web fetch capability for retrieving content from ## Introduction {{% alert color="info" %}} -This feature is available in Studio Pro 11.10 and above. +This feature was released as part of [Maia Make](/refguide/maia-make/) capabilities in Studio Pro 11.10. To use Maia Web Fetch, an internet connection and signing in to Studio Pro are required. {{% /alert %}} 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 f328b60b9dd..09861bfe770 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,7 +10,7 @@ description: "Describes the features in Studio Pro MCP Server." ## Introduction {{% alert color="info" %}} -This feature is available in Studio Pro 11.10 and above. +This feature was released in Studio Pro 11.10. To use Studio Pro MCP Server, an internet connection and signing in to Studio Pro are required. {{% /alert %}}