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: .github/workflows/check-claude-settings.yml
+2-3Lines changed: 2 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ jobs:
18
18
19
19
You've modified Claude Code configuration files. These files contain the shared configuration for all contributors. Please revert this change if unintended. **ONLY modify these files if you need to change shared configurations that apply to everyone and have discussed this change with the TW team.**
20
20
21
-
To override the Claude settings locally, use \`.claude/settings.local.json\` instead.
21
+
To override the Claude settings locally, use \`.claude/settings.local.json\` instead. This local file is gitignored and overrides the repo default.
22
22
23
23
**For example, if you're changing AWS_PROFILE:**
24
24
The default profile name is \`my-sandbox\`. If your AWS profile has a different name, override it locally instead of changing the shared file.
@@ -32,8 +32,7 @@ jobs:
32
32
}
33
33
}
34
34
\`\`\`
35
-
36
-
This local file is gitignored and overrides the repo default.`;
For core resources, there are two sets of values. The **Request** value is the amount of core resources which are initially requested. The **Limit** value is the maximum amount of resource that the environment can use.
138
138
139
-
There are three pre-defined sets of resources, **Small**, **Medium**, and **Large**. Choosing these will set the **CPU** and **Memory** values automatically.
139
+
There are six pre-defined sets of resources, **XS**, **S**, **M**, **L**, **XL**, and **XXL**.
140
+
141
+
Legacy plans are still visible with a **Legacy** prefix.
| Custom | own choice | own choice | own choice | own choice | own choice | own choice |
147
155
148
-
Alternatively, you can choose **Custom**, and enter your own requirements for **CPU** and **Memory**. Ensure that these values are the same or greater than the values for a *Small* environment, otherwise you may run into problems running your app.
156
+
Alternatively, you can choose **Custom**, and enter your own requirements for **CPU** and **Memory**. Ensure that these values are the same or greater than the values for a *Legacy Small* environment, otherwise you may run into problems running your app. Existing environments will continue to utilize their legacy resources.
149
157
150
158
{{% alert color="info" %}}If the cluster manager has added and enabled customized core resource plan on Cluster manager page, only the configured custom core resource plans will be visible for selection. Once the custom core resources plans are enabled, environments cannot be created using the default plans until all the associated environments using the custom core resource plan are deleted and the custom resource plan is disabled on the **Cluster manager** page.{{% /alert %}}
151
159
@@ -521,7 +529,7 @@ For a *connected* cluster, the top level MendixApp CRD will be deleted from the
521
529
522
530
* The database will be dropped and the database user will be deleted from the database server — databases and users from other environments will remain untouched.
523
531
524
-
{{% alert color="info" %}}If the storage plan is using a JDBC plan (not Postgres or SQL Server), the database and the user will remain untouched).{{% /alert %}}
532
+
{{% alert color="info" %}}If the storage plan is using a JDBC plan (not Postgres or SQL Server), the database and the user will remain untouched.{{% /alert %}}
525
533
526
534
* Files related to that environment will be deleted from the S3/Minio storage bucket (or prefix if this is using a shared bucket).
527
535
@@ -539,6 +547,13 @@ Images are not deleted from the container registry. You should delete those imag
539
547
If any of these garbage collection steps fail, you will no longer see the environment in the Mendix Portal, and will have to [delete the storage instances](#delete-storage) manually.
540
548
{{% /alert %}}
541
549
550
+
##### Custom JVM Heap Memory
551
+
552
+
Adjust the JVM memory usage manually if the default settings are not fully utilizing available memory. The JVM's memory usage must always remain below the total core resource memory to prevent application crashloops.
553
+
For more information, see [JVM Memory Tuning for Mendix on Kubernetes](/developerportal/deploy/private-cloud-jvm-memory-tuning/).
[Read-only Root file system](/developerportal/deploy/private-cloud-cluster/#readonlyrootfs) can be enabled per environment. By default, this option is disabled.
{{% alert color="warning" %}} This feature is in Public Beta. For more information, refer to Release Status. {{% /alert %}}
@@ -98,11 +97,10 @@ If your company does not have company-approved components, Maia returns the foll
98
97
99
98
* platform-supported components
100
99
* all Private Marketplace components
101
-
-->
102
100
103
101
### Opening the App
104
102
105
-
Once you are happy with Maia's suggested project plan, click **Open in Studio Pro** in the top right of the page. This opens Studio Pro, where you can continue working on the new app. <!--Note that, at the moment, Studio Pro does not take into account [recommended components](#recommender). -->
103
+
Once you are happy with Maia's suggested project plan, click **Open in Studio Pro** in the top right of the page. This opens Studio Pro, where you can continue working on the new app. Note that, at the moment, Studio Pro does not take into account [recommended components](#recommender).
106
104
For details, refer to [Maia Make](/refguide/maia-make/) in the Studio Pro documentation.
107
105
108
-
You can also click **Open in Planning** to open the **Planning** window of the new app, which includes all the project's stories. <!--Note that, if you click **Open in Planning** before Maia is done [finding recommendations](#recommender), recommended components are not displayed in the **Planning** window. -->
106
+
You can also click **Open in Planning** to open the **Planning** window of the new app, which includes all the project's stories. Note that, if you click **Open in Planning** before Maia is done [finding recommendations](#recommender), recommended components are not displayed in the **Planning** window.
Copy file name to clipboardExpand all lines: content/en/docs/marketplace/genai/how-to/create-single-agent.md
+14-5Lines changed: 14 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,10 +23,11 @@ The type of agent you can build is a single-turn agent, which means that:
23
23
* It focuses on specific task completion.
24
24
* It uses a knowledge base and function calling to retrieve data or perform actions.
25
25
26
-
This document covers two approaches to defining an agent for your Mendix app. Both approaches leverage the capabilities of Mendix' Agents Kit:
26
+
This document covers three approaches to defining an agent for your Mendix app. Both approaches leverage the capabilities of Mendix' Agents Kit:
27
27
28
-
* The first approach uses the [Agent Builder UI to define agents](#define-agent-commons) at runtime by the principles of Agent Commons. It enables versioning, development iteration and refinement at runtime, separate from the traditional app logic development cycle.
29
-
* The second approach [defines the agent programmatically](#define-genai-commons) using the building blocks of GenAI Commons, and is more useful for very specific use cases and when the agent needs to be part of the code repository of the app.
28
+
* The first approach uses the [Agent Editor in Studio Pro](#define-agent-editor). It is used for creating and iterating on agent definitions as part of the app model, leveraging existing development capabilities of the platform to define, manage and deploy agents as part of a Mendix app.
29
+
* The second approach uses the [Agent Builder UI to define agents](#define-agent-commons) at runtime by the principles of Agent Commons. It enables versioning, development iteration and refinement at runtime, separate from the traditional app logic development cycle.
30
+
* The third approach [defines the agent programmatically](#define-genai-commons) using the building blocks of GenAI Commons. It is more useful for very specific use cases, especially when the agent needs to be part of the code repository of the app.
30
31
31
32
### Prerequisites {#prerequisites}
32
33
@@ -214,9 +215,17 @@ To get started:
214
215
215
216
This method provides greater flexibility in managing and sharing functions across different applications and environments.
216
217
218
+
## Define the Agent Using the Agent Editor {#define-agent-editor}
219
+
220
+
The main approach to create and manage agents makes use of the [Agent Editor](https://marketplace.mendix.com/link/component/257918) in the Studio Pro. This extension allows you to manage the lifecycle of your agents as part of the app model. You can define Agents as documents of type "Agent" in your app while working in Studio Pro, alongside related documents such as Large Language Models, Knowledge bases, and Consumed MCP services.
221
+
222
+
{{% alert color="warning" %}}
223
+
The Agent Editor will become available shortly after the Mendix Studio Pro 11.9 release as a downloadable extension on the Mendix Marketplace. Click **Add to Saved** on the [Marketplace listing](https://marketplace.mendix.com/link/component/257918) and stay tuned for updates!
224
+
{{% /alert %}}
225
+
217
226
## Define the Agent Using Agent Commons {#define-agent-commons}
218
227
219
-
The main approach to set up the agent and build logic to generate responses is based on the logic part of the Agent Commons module. Start by defining an agent with a prompt at runtime, then, through the same UI, add tools, (microflows as functions) and knowledge bases to the agent version.
228
+
An alternative approach to set up the agent and build logic to generate responses is based on the logic part of the Agent Commons module. Start by defining an agent with a prompt at runtime, then, through the same UI, add tools, (microflows as functions) and knowledge bases to the agent version.
220
229
221
230
### Set up the Agent with a Prompt
222
231
@@ -391,7 +400,7 @@ You can find examples for both Agent Commons and GenAI Commons in the `ExampleMi
391
400
392
401
## Define the Agent Using Microflows {#define-genai-commons}
393
402
394
-
This is an alternative approach to the steps described in the [Define the Agent Using Agent Commons](#define-agent-commons) section. Find out how to set up the agent and build logic to generate responses, using microflows for empowering the agent. You start with a prompt at runtime, and add functions and knowledge bases to the microflow at design time.
403
+
This is an additional approach as alternative to the steps described in previous sections. Find out how to set up the agent and build logic to generate responses, using microflows for empowering the agent. You start with a prompt at runtime, and add functions and knowledge bases to the microflow at design time.
description: "Describes the purpose, configuration, and usage of the Agents Editor and the Agent Editor Commons modules from the Mendix Marketplace that allows developers to build, define, and refine Agents, to integrate GenAI principles, and Agentic patterns into their Mendix app."
6
+
weight: 20
7
+
---
8
+
9
+
## Introduction
10
+
11
+
{{% alert color="warning" %}}
12
+
The Agent Editor will become available shortly after the Mendix Studio Pro 11.9 release as a downloadable extension on the Mendix Marketplace. Click **Add to Saved** on the [Marketplace listing](https://marketplace.mendix.com/link/component/257918) and stay tuned for updates!
13
+
{{% /alert %}}
14
+
15
+
The [Agent Editor](https://marketplace.mendix.com/link/component/257918) module enables users to develop, test, and optimize their GenAI use cases by creating effective agents that interact with large language models (LLMs). With the Agent Editor module, you can define Agents at design time in the Studio Pro (11.9.0 and above), and manage their lifecycle as part of your project by taking advantage of existing platform capabilities such as model documents, version control, and deployment capabilities. You can define and develop Agents locally and consecutively deploy them to cloud environments directly with the app model.
16
+
17
+
The Agent Editor is compatible with the Agent Commons module. Using this module, you can define and manage prompts, microflows (as tools), external MCP servers, knowledge bases, and large language models to build agentic patterns that support your business logic. Additionally, it allows you to define variables that act as placeholders for data from the app session context, which are replaced with actual values when the end user interacts with the app.
18
+
19
+
The Agent Editor module includes a Studio Pro extension that allows users to define GenAI Agents as documents in the app model. The Agent Editor Commons module, which is installed as part of the same package, includes logic and activities to call these agents from microflows in a running application.
0 commit comments