|
| 1 | +--- |
| 2 | +title: "Maia Instructions (AGENTS.md)" |
| 3 | +linktitle: "Custom Instructions" |
| 4 | +url: /refguide/maia-instructions/ |
| 5 | +weight: 95 |
| 6 | +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 a [standard-compliant](https://agents.md) way to steer the behavior of the agent for your project or module. They allow you to define common |
| 19 | +context of your prompts only once as they are automatically loaded when necessary. |
| 20 | + |
| 21 | +They can be provided on the project level or on the module level. Project-level instructions are automatically included in every conversation started within the given project. Module-level instructions are automatically included whenever documents in the given module are read, updated, or created. |
| 22 | + |
| 23 | +## Maia Instructions vs. Agent Skills {#instructions-vs-skills} |
| 24 | + |
| 25 | +Maia supports both [agent skills](/refguide/maia-agent-skills/) and agent instructions. The following table summarizes their differences: |
| 26 | + |
| 27 | +| | Instructions | Skills | |
| 28 | +| ------------- | --------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | |
| 29 | +| Loading | Deterministically loaded, whenever working with the given project or module | Agent decides to load skills on demand, based on their description | |
| 30 | +| Applicability | Project or module-wide instructions that should always be part of context (e.g. preferred language) | Instructions that are applicable only in certain situations (e.g. microflow conventions) | |
| 31 | +| Organization | Single file, should be kept as short as possible | Allows you to split instructions into multiple files that Maia reads on demand as needed | |
| 32 | + |
| 33 | +## Creating a New Maia Instruction {#creating-instructions} |
| 34 | + |
| 35 | +To create a new Maia Instruction, follow these steps: |
| 36 | + |
| 37 | +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. |
| 38 | +1. Right-click this node and click **Add** > **Agent instructions**. |
| 39 | + |
| 40 | +Studio Pro creates the `AGENTS.md` file. You can continue adding the instruction content. |
| 41 | + |
| 42 | +### Instructions Content {#instructions-content} |
| 43 | + |
| 44 | +Maia Instructions are arbitrary Markdown files that follow the AGENTS.md standard. You can structure them any way you like. |
| 45 | + |
| 46 | +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. |
| 47 | + |
| 48 | +### Directory Structure {#directory-structure} |
| 49 | + |
| 50 | +Project-level instructions are stored as `skillssource/AGENTS.md`, while module-level instructions are stored as |
| 51 | +`skillssource/_modules/<module_name>/AGENTS.md`. You can add only one instructions file per project or per module. |
| 52 | + |
| 53 | +## Read More |
| 54 | + |
| 55 | +- [Agent Skills](/refguide/maia-agent-skills/) |
| 56 | +- [Maia Make Capabilities](/refguide/maia-make/) |
| 57 | +- [Mendix AI Assistance (Maia)](/refguide/mendix-ai-assistance/) |
| 58 | +- [Maia Chat](/refguide/maia-chat/) |
| 59 | +- [Agent Instructions Standard](https://agents.md) – the full specification for the agent instructions |
0 commit comments