- Contextualize your project: Give Maia Team context about your work so it is better able to understand your needs.
- Enforce naming conventions: Define how pipelines and resources should be named, in order to ensure consistency.
- Build awareness: Provide Maia Team with business-specific definitions, glossary terms, or standards so it can understand your data.
- Simplify reuse: Store connection information, such as usernames, for systems that you will frequently use to build data pipelines.
When to use skills and context files
Skills and context files should be used in different ways to help Maia Team understand your data and provide better responses to your prompts. The table below clarifies some of the differences between skills and context files.Context file best practices
- Keep content focused and actionable
- Prioritize rules over explanations: Focus on what Maia Team should do, not background information.
- Use imperative language: Write instructions as directives (e.g., “Always prefix staging tables with
stg_”) rather than descriptions. - Be concise: Maia Team reads all context files with every interaction. Verbose files slow down processing and may dilute important rules.
- Structure for clarity
- Use clear headers: Organize by topic (naming conventions, data standards, connection info) so Maia Team can quickly locate relevant rules.
- Use bullet points and tables: These formats are easier for Maia Team to parse than dense paragraphs.
- Provide examples: Include concrete examples alongside rules to reduce ambiguity.
- Maintain and update regularly
- Review periodically: Context files should evolve with your project. Outdated rules can lead to incorrect outputs.
- Remove obsolete content: Delete rules that no longer apply rather than letting them accumulate.
- Version with your project: Commit context file changes alongside related pipeline changes.
Formatting and storing context files
Context files must be.md (Markdown) files and must be stored in a folder with the following path: .matillion/maia/rules/. This folder is created automatically if you add a context file in the Maia Team interface. If you create a context file from scratch, you need to create this folder structure first. The rules folder can be accessed in the Files panel in Designer.
It is important to note:
- Maia Team enforces a strict 12,000-character limit across all Markdown context files stored in the
.matillion/maia/rules/directory. Maia Team can also read reference files stored in different folders, as described in Adding reference files, but these files don’t count toward the character limit. - It’s important to keep your context files updated. Maia Team won’t automatically prompt you to make updates unless you ask it to, so make sure you regularly review and update them as your project evolves.
We do not recommend storing reference files in the
.matillion/... folder, as this folder is a reserved location in your project. Storing anything other than context files in this folder may cause issues in the future.Add or edit context files in the Maia Team interface
You can work with context files directly in the Maia Team chat panel by clicking the corresponding option in the top right of the Maia Team chat panel:- Add context: This button appears at the top of the chat panel when no context file exists. Clicking this option automatically creates the
.matillion/maia/rules/folder and a Markdown file calledcontext.md. - Edit context: After a context file has been created, this button allows you to open and edit the file without switching views. If you have more than one context file in the
.matillion/maia/rules/folder, this button will open the context file that was created first.
Add or edit context files in the Files panel
To add a new context file if no context file exists, follow these steps. If you have already created at least one context file, skip steps 1 and 2.- Create a top-level folder called
.matillion. - In the
.matillionfolder, create a folder calledmaia. - In the
maiafolder, create a folder calledrules. - Click the three dots … next to the
rulesfolder, then Add, then Markdown file. - Write your context content in plain Markdown. Maia Team supports headings, lists, and tables.
Tracking the character limit
When editing a context file located in the.matillion/maia/rules/ folder, you can see its character count and status in the top right corner. The character count represents the number of characters in the open context file, not the total number of characters in all your context files.
If you have more than one context file in the .matillion/maia/rules/ folder, Maia Team reads them in the order they appear in the folder (alphabetical order by file name). If the total character count in all your context files exceeds the 12,000-character limit, Maia Team reads your context files in this order until it reaches 12,000 characters, at which point it can’t read any more context files.
The file’s status indicates how much of the context file Maia Team can read:
- Loaded: Maia Team can read all the information in the open context file.
- Partially loaded: Maia Team can only read some of the information in the open context file, because it exceeds the character limit.
- Not loaded: Maia Team can’t read any information in the open context file, because your other context files have already exceeded the character limit.
.matillion/maia/rules/ folder, their status, and how many characters of each file have been loaded. For example, let’s say you have three context files that collectively exceed the 12,000-character limit. Here’s an example of what you would see in the dialog, and what it means:
context.md, the file that Maia Team reads first, contains fewer than 12,000 characters, so it is loaded and Maia Team can read all its information.naming_conventions.md, the second file, contains fewer than 12,000 characters but causes the total character count to exceed the 12,000-character limit, so it is partially loaded. Maia Team can read and use the first 5,496 characters in this file, but nothing else.terminology.md, the third file, isn’t loaded because the previous two files already exceed the character limit. Maia Team can’t use any of its content when working on your prompts.
Adding reference files
Maia Team can also access reference files containing additional information for it to use when working on your prompts. For example, reference files could contain complex logic, detailed documentation, or full business process guides. Unlike your context files, which Maia Team always reads, Maia Team chooses when to refer to your reference files, based on your prompt. This allows Maia Team to use situational information and use-case-specific context to respond to your prompts. You can use your context files to tell Maia Team what information your reference files contain, and when to use them, as explained in the example below.Reference files should be stored outside the
.matillion/... directory. This means that they won’t count toward the 12,000-character limit on context files. Using reference files helps you to ensure that your main context file, which contains essential information, stays under the character limit so that Maia Team can read all the information it contains.- In a folder outside the
.matillion/...directory, create or import a.mdfile containing your reference information. - Click Edit context in the Maia Team chat panel to edit your context file.
- In your context file, tell Maia Team when to use your reference files, and where they’re stored.
- Create a new root folder in your project, e.g.
reference. - Add the Markdown files containing the standards to this folder, e.g.
orchestration_standards.mdandtransformation_standards.md. - Add the following instruction to your context file: “When building a pipeline, refer to the corresponding set of standards in the
referencefolder. Use the standards inorchestration_standards.mdwhen building orchestration pipelines, and use the standards intransformation_standards.mdwhen building transformation pipelines.”
Sample context files
Sample context files are available to help teams standardize project documentation, enforce naming conventions, and define best practices. These examples are intended to accelerate setup and ensure consistency across pipeline development. Example context files are available to download below. These files can be used to:- Apply consistent naming and modeling standards across teams.
- Embed reusable business logic and glossary terms into Maia Team‘s prompts.
- Simplify setup by reusing validated patterns and integration rules.
- Download a context file using the links below. Each file is a Markdown file.
- Replace any placeholder logic, metadata, and KPIs with your own standards.
- Save the file in the
.matillion/maia/rules/directory of your project. - Commit your changes.
- Once you have committed your changes, Maia Team will use the context file during future interactions.