Skip to content

Commit 930025d

Browse files
committed
Add Maia Agent Skills documentation
1 parent 57486e5 commit 930025d

3 files changed

Lines changed: 105 additions & 0 deletions

File tree

content/en/docs/refguide/mendix-ai-assistance/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ Guidance:
5252
* **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/).
5353
* **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/).
5454
* **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+
* **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/).
5556

5657
Recommenders:
5758

content/en/docs/refguide/mendix-ai-assistance/maia-make/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ For more information on how each Maia Make capability work, refer to the followi
8787
* [Maia MCP Client](/refguide/maia-mcp/)
8888
* [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/)
8989
* [Maia Web Fetch](/refguide/maia-web-fetch/)
90+
* [Maia Agent Skills](/refguide/maia-agent-skills/)
9091

9192
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.
9293

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
title: "Maia Agent Skills"
3+
linktitle: "Agent Skills"
4+
url: /refguide/maia-agent-skills/
5+
weight: 88
6+
description: "Describes how to create and manage agent skills that equip Maia with domain-specific knowledge, applied automatically whenever relevant."
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 is released as part of [Maia Make](/refguide/maia-make/) capabilities in Studio Pro 11.11 and above.
14+
15+
To use agent skills, an internet connection and signing in to Studio Pro are required.
16+
{{% /alert %}}
17+
18+
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.
19+
20+
Instead of typing the same context into every chat, you define agent skills once and Maia applies them automatically whenever relevant, eliminating the need to repeat the same guidance across conversations.
21+
22+
Use agent skills to equip Maia with the domain knowledge and conventions it needs—whether that is 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+
24+
For guidance on writing effective skills, see [Best Practices](https://agentskills.io/skill-creation/best-practices) and [Optimizing Descriptions](https://agentskills.io/skill-creation/optimizing-descriptions) in the [Agent Skills documentation](https://agentskills.io/).
25+
26+
## How Agent Skills Work
27+
28+
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.
29+
30+
If you add or edit a skill while a session is active, those changes take effect the next time you start a chat.
31+
32+
For more on how skills load and when they apply, see the [Agent Skills specification](https://agentskills.io/specification).
33+
34+
## Directory Structure {#directory-structure}
35+
36+
Skills are stored in a `skillssource/` directory at the root of your app 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** (shortcut: <kbd>F4</kbd>) to make the changes visible in Studio Pro.
37+
38+
```
39+
skillssource/
40+
your-skill/
41+
SKILL.md
42+
references/
43+
GLOSSARY.md
44+
NOTES.md
45+
```
46+
47+
### SKILL.md Format {#skill-md-format}
48+
49+
Each `SKILL.md` file must include YAML frontmatter at the top, followed by the skill content in Markdown:
50+
51+
```yaml
52+
---
53+
name: your-skill
54+
description: Applies company-wide naming conventions for entities, attributes, and microflows.
55+
---
56+
57+
Write your skill instructions here in plain Markdown. Use the `references/` subdirectory
58+
to add supplementary content and refer to it from here as needed.
59+
60+
See [my-reference](references/my-reference.md) for details.
61+
```
62+
63+
| Field | Required | Description |
64+
| --- | --- | --- |
65+
| `name` | Yes | Must match the skill's parent directory name exactly. See the [Agent Skills specification](https://agentskills.io/specification#name-field) for full naming rules. |
66+
| `description` | Yes | See the [Agent Skills specification](https://agentskills.io/specification#description-field). |
67+
68+
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`.
69+
70+
## Creating a Skill {#creating-a-skill}
71+
72+
To create a new agent skill:
73+
74+
1. In the **App Explorer**, expand **Maia** > **skills**.
75+
2. Right-click **skills** and click **Add** > **Skill**.
76+
3. Enter a name for the skill.
77+
78+
Studio Pro creates the new skill. Open the skill from the **App Explorer** to add your content.
79+
80+
## Adding Reference Files {#reference-files}
81+
82+
Reference files let you keep your skill focused by moving supplementary content into separate documents—a glossary of domain terms, a data dictionary, or detailed architecture notes, for example. Maia accesses reference file content on demand, only when relevant to your request.
83+
84+
To add a reference file to a skill:
85+
86+
1. In the **App Explorer**, under **Maia** > **skills**, right-click the skill you want to add a reference to.
87+
2. Click **Add** > **Reference**.
88+
3. Enter a name for the reference file.
89+
90+
For more on how skills and reference files load, see the [Agent Skills specification](https://agentskills.io/specification#progressive-disclosure).
91+
92+
## Limitations {#limitations}
93+
94+
* Only Markdown files are supported as reference files. Files in other formats are ignored.
95+
* Changes you make to skills take effect the next time you start a chat.
96+
97+
## Read More
98+
99+
* [Maia Make Capabilities](/refguide/maia-make/)
100+
* [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/)
101+
* [Maia Chat](/refguide/maia-chat/)
102+
* [Agent Skills Best Practices](https://agentskills.io/skill-creation/best-practices) – guidance on writing effective skill content
103+
* [Agent Skills Specification](https://agentskills.io/specification) – the full specification for the agent skills format

0 commit comments

Comments
 (0)