-
Notifications
You must be signed in to change notification settings - Fork 791
Custom skills and instructions on module level #11408
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
55ff4e7
Add information about custom skills
713a6cb
Add instructions information.
956b0b4
Link instructions
6ce8508
Skill overview and improvements of instructions
e3c0311
Improve syncing descriptions.
982ab33
Add instructions loading note.
b82aa41
Change heading.
fe74b7d
Language review
MariaShaposhnikova cbc4ebe
Review
MariaShaposhnikova d8bad0a
Add information about custom skills
petarvukmirovic ecd92a6
Add instructions information.
petarvukmirovic d47149f
Link instructions
petarvukmirovic d091d82
Skill overview and improvements of instructions
petarvukmirovic bff5fa5
Improve syncing descriptions.
petarvukmirovic 6c0fde5
Add instructions loading note.
petarvukmirovic 3106c98
Change heading.
petarvukmirovic 23ef4e5
Language review
MariaShaposhnikova 30e713b
Review
MariaShaposhnikova 0054ab5
Remove redundant conent.
petarvukmirovic a89ecbf
Merge branch 'development' of https://github.com/petarvukmirovic/docs…
MariaShaposhnikova 00e446a
Review Skills pane
MariaShaposhnikova 24f0d08
Add Skills pane image
MariaShaposhnikova 23186d6
Remove redundant content
MariaShaposhnikova 9a35706
Fix image
MariaShaposhnikova File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
60 changes: 60 additions & 0 deletions
60
content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-instructions.md
|
petarvukmirovic marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| title: "Maia Agent Instructions (AGENTS.md)" | ||
| linktitle: "Maia Instructions" | ||
| url: /refguide/maia-instructions/ | ||
| weight: 95 | ||
| description: "Describes how to create and manage Maia Instructions (AGENTS.md) to steer agent behavior at the project or module level." | ||
| #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.12. | ||
|
|
||
| To use Maia Agent Instructions, an internet connection and signing in to Studio Pro are required. | ||
| {{% /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. | ||
|
|
||
| Maia Instructions follow the [AGENTS.md standard](https://agents.md) for agent instructions. | ||
|
|
||
| ## Maia Instructions vs. Agent Skills {#instructions-vs-skills} | ||
|
|
||
| Maia supports both [agent skills](/refguide/maia-agent-skills/) and agent instructions. The following table summarizes their differences: | ||
|
|
||
| | Aspects | Instructions | Skills | | ||
| | ------------- | --------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | ||
| | 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. | | ||
|
|
||
| ## 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. | ||
|
petarvukmirovic marked this conversation as resolved.
|
||
| 2. Right-click this node and click **Add** > **Agent instructions**. | ||
|
|
||
| Studio Pro creates the `AGENTS.md` file. You can continue adding the instruction content. | ||
|
|
||
| {{% alert color="info" %}}Newly added instructions or changes to existing instructions are discovered only when new session is started.{{% /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. | ||
|
|
||
| ### Directory Structure {#directory-structure} | ||
|
|
||
| Project-level instructions are stored as `skillssource/AGENTS.md`, while module-level instructions are stored as | ||
| `skillssource/_modules/<module_name>/AGENTS.md`. You can add only one instructions file per project or per module. | ||
|
|
||
| ## Read More | ||
|
|
||
| - [Agent Skills](/refguide/maia-agent-skills/) | ||
| - [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) | ||
| - [Maia Chat](/refguide/maia-chat/) | ||
Binary file added
BIN
+69.5 KB
...ments/refguide/mendix-ai-assistance/maia-make/maia-agent-skills/skills-pane.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.