You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/refguide/mendix-ai-assistance/_index.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,6 +53,7 @@ Guidance:
53
53
***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/).
54
54
***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/).
55
55
***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/).
56
+
***Maia Agent Instructions** – allows you to define project- or module-level instructions (AGENTS.md) that steer agent behavior. You can use them to set common context for your prompts, such as company conventions or environment restrictions. For more information, see [Maia Agent Instructions](/refguide/maia-instructions/).
Copy file name to clipboardExpand all lines: content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-agent-skills.md
+39-5Lines changed: 39 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,15 +21,19 @@ Instead of typing the same context into every chat, you define agent skills once
21
21
22
22
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.
23
23
24
+
Starting from Studio Pro 11.12, Maia supports not only project-level skills, but also skills for all application (non-protected) modules. These skills are exportable together with the module in which they are kept
25
+
and can help you split your skills better.
26
+
24
27
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/).
25
28
26
29
## Creating an Agent Skill {#creating-a-skill}
27
30
28
31
To create a new agent skill in Studio Pro, follow these steps:
29
32
30
-
1. In the **App Explorer**, expand **Maia** > **skills**.
31
-
2. Right-click **skills** and click **Add** > **Skill**.
32
-
3. Enter a name for the skill.
33
+
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.
34
+
1. Expand this node to **Maia** > **skills**.
35
+
1. Right-click **skills** and click **Add** > **Skill**.
36
+
1. Enter a name for the skill.
33
37
34
38
Studio Pro creates the `SKILL.md` file. You can continue adding the skill content.
35
39
@@ -58,7 +62,10 @@ The `name` field must match the skill's parent directory name exactly. A mismatc
58
62
59
63
### Directory Structure {#directory-structure}
60
64
61
-
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: <kbd>F4</kbd>) to make the changes visible in Studio Pro.
65
+
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: <kbd>F4</kbd>) to make the changes visible in Studio Pro.
66
+
You can also sync the changes by pressing the **Sync** button in the **Maia skills** overview pane.
67
+
68
+
Project-level skills are stored directly under `skillssource` directory:
62
69
63
70
```
64
71
skillssource/
@@ -69,13 +76,26 @@ skillssource/
69
76
NOTES.md
70
77
```
71
78
79
+
Skills for particular modules are stored under `_modules` subdirectory:
80
+
81
+
```
82
+
skillssource/
83
+
_modules/
84
+
<module_name>/
85
+
your-skill/
86
+
SKILL.md
87
+
references/
88
+
GLOSSARY.md
89
+
NOTES.md
90
+
```
91
+
72
92
## Adding Reference Files {#reference-files}
73
93
74
94
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.
75
95
76
96
To add a reference file to a skill, follow these steps:
77
97
78
-
1. In the **App Explorer**, under **Maia** > **skills**, right-click the skill you want to add a reference to.
98
+
1. In the **App Explorer**, under **Maia** > **skills** (either under **App** or for a particular module), right-click the skill you want to add a reference to.
79
99
2. Click **Add** > **Reference**.
80
100
3. Enter a name for the reference file.
81
101
@@ -85,8 +105,22 @@ For more information on how skills and reference files load, and when they apply
85
105
86
106
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.
87
107
108
+
Make sure to provide informative description of a skill as this is the leading information Maia uses to decide whether to read your skill.
109
+
88
110
If you add or edit a skill while a session is active, those changes take effect the next time you start a chat.
89
111
112
+
## Skill Overview {#skill-overview}
113
+
114
+
Since Studio Pro 11.12, Maia lets you list all registered agent skills. Click the **Skills** button next to
115
+
**Add** in the Maia input area to open the **Skills** pane. The pane shows whether each skill has loaded
116
+
successfully, including any error message, references found, and the module the skill belongs to.
description: "Describes how to create and manage Maia Instructions (AGENTS.md) to steer agent behavior at the project or module level."
7
+
#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.
8
+
---
9
+
10
+
## Introduction
11
+
12
+
{{% alert color="info" %}}
13
+
This feature was released as part of [Maia Make](/refguide/maia-make/) capabilities in Studio Pro 11.12.
14
+
15
+
To use Maia Agent Instructions, an internet connection and signing in to Studio Pro are required.
16
+
{{% /alert %}}
17
+
18
+
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.
19
+
20
+
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.
21
+
22
+
Maia Instructions follow the [AGENTS.md standard](https://agents.md) for agent instructions.
23
+
24
+
## Maia Instructions vs. Agent Skills {#instructions-vs-skills}
25
+
26
+
Maia supports both [agent skills](/refguide/maia-agent-skills/) and agent instructions. The following table summarizes their differences:
| Loading | Deterministically loaded, whenever working with the given project or module. | Agent decides to load skills on demand, based on their name and description. |
31
+
| 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). |
32
+
| 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. |
33
+
34
+
## Creating a New Maia Instruction {#creating-instructions}
35
+
36
+
To create a new Maia Instruction, follow these steps:
37
+
38
+
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.
39
+
2. Right-click this node and click **Add** > **Agent instructions**.
40
+
41
+
Studio Pro creates the `AGENTS.md` file. You can continue adding the instruction content.
42
+
43
+
{{% alert color="info" %}}Newly added instructions or changes to existing instructions are discovered only when new session is started.{{% /alert %}}
44
+
45
+
### Instructions Content {#instructions-content}
46
+
47
+
Maia Instructions are arbitrary Markdown files that follow the AGENTS.md standard. You can structure them any way you like.
48
+
49
+
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.
50
+
51
+
### Directory Structure {#directory-structure}
52
+
53
+
Project-level instructions are stored as `skillssource/AGENTS.md`, while module-level instructions are stored as
54
+
`skillssource/_modules/<module_name>/AGENTS.md`. You can add only one instructions file per project or per module.
55
+
56
+
## Read More
57
+
58
+
-[Agent Skills](/refguide/maia-agent-skills/)
59
+
-[Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/)
0 commit comments