@formio/uag 1.3.0 → 1.4.0

package/README.md

@@ -60,7 +60,7 @@ try {
 There is also a way to extend the functionality of the UAG through the use of modules, which is documented in the [Modules Readme](./module/Readme.md)
 
 ### Docker
-In addition to running the UAG in node.js, you can also run the UAG within the Docker environment. This enables a wide range of deployment options into common hosting environments such as AWS and Azure as well as allow for the use in common orchestration runtimes such as Kubernetes and Docker Compose. The container that you will use for running the UAG is as follows.
+In addition to running the UAG in Node.js, you can also run the UAG within the Docker environment. This enables a wide range of deployment options into common hosting environments such as AWS and Azure as well as allow for the use in common orchestration runtimes such as Kubernetes and Docker Compose. The container that you will use for running the UAG is as follows.
 
 ```
 formio/uag

package/lib/UAGFormInterface.d.ts

@@ -53,8 +53,12 @@ export declare class UAGFormInterface extends FormInterface {
     getComponentFormat(component: Component): string;
     getComponentInfo(component: Component, path: string): UAGComponentInfo;
     isMultiple(component: Component | undefined): boolean;
+    getParentInfoFromComponent(parent: Component | undefined, parent_path?: string): ParentInfo | undefined;
+    getParentInfo(parent_path?: string): ParentInfo | undefined;
+    getParentLabel(parent?: ParentInfo): string;
+    getParentDataPath(parent: ParentInfo | undefined, rowIndex?: number): string;
     getParentToolDescription(parent: ParentInfo | undefined): string;
-    getComponentValueRule(component: Component): string;
+    getComponentValueRule(component: Component, data_path?: string): string;
     /**
      * Determine if the component is a nested data components. For these components, the UAG treats them as
      * separate data collection units where the agent will explicitely call out to collect data for these components.

package/lib/UAGFormInterface.js

@@ -66,33 +66,75 @@ class UAGFormInterface extends appserver_1.FormInterface {
             return false;
         return !!component.multiple || component.type === 'selectboxes' || component.type === 'tags';
     }
+    getParentInfoFromComponent(parent, parent_path) {
+        if (!parent || !parent_path)
+            return undefined;
+        const parentInfo = {
+            type: parent.type,
+            label: parent.label || parent.key,
+            data_path: parent_path
+        };
+        if (parent.tree ||
+            parent.type === 'datagrid' ||
+            parent.type === 'editgrid') {
+            parentInfo.isTable = true;
+            return parentInfo;
+        }
+        if (parent.type === 'form') {
+            parentInfo.isForm = true;
+            return parentInfo;
+        }
+        if (parent.type === 'container') {
+            parentInfo.isContainer = true;
+            return parentInfo;
+        }
+        return parentInfo;
+    }
+    getParentInfo(parent_path) {
+        if (!parent_path)
+            return undefined;
+        const parent = this.getComponent(parent_path);
+        return this.getParentInfoFromComponent(parent, parent_path);
+    }
+    getParentLabel(parent) {
+        if (parent?.isTable) {
+            return `this row within the **${parent.label}** component`;
+        }
+        else if (parent?.isForm) {
+            return `the **${parent.label}** nested form`;
+        }
+        else if (parent?.isContainer) {
+            return `the **${parent.label}** container component`;
+        }
+        return `the **${this.form.title} (${this.form.name})** form`;
+    }
+    getParentDataPath(parent, rowIndex = -1) {
+        if (parent?.isTable) {
+            return (rowIndex >= 0) ? `${parent.data_path}[${rowIndex}]` : `${parent.data_path}[0]`;
+        }
+        if (parent?.isForm) {
+            return `${parent.data_path}.data`;
+        }
+        return parent?.data_path || '';
+    }
     getParentToolDescription(parent) {
         if (!parent)
             return '';
-        return `To collect data for this component, separately use the \`collect_field_data\` tool with the following set for the \`parent\` parameter: \`parent=${JSON.stringify(parent)}\`. Use the \`get_form_fields\` tool with the same \`parent\` parameter to retrieve all the fields within this parent field. `;
+        return `To determine what fields are within this component, use the \`get_form_fields\` tool with \`parent_path\`="<data_path>" (e.g. \`parent_path\`="${parent.data_path}"). To collect data for this component, use the \`collect_field_data\` tool with the \`parent_path\` set for the parent's data_path.`;
     }
-    getComponentValueRule(component) {
+    getComponentValueRule(component, data_path) {
         let rule = '';
-        const parent = {
-            type: component.type,
-            label: component.label || component.key,
-            data_path: '<data_path>'
-        };
-        if (component.tree ||
-            component.type === 'datagrid' ||
-            component.type === 'editgrid') {
-            parent.isTable = true;
-            rule += 'The value is a table of rows (array of objects). ' + this.getParentToolDescription(parent) + 'All `data_path`(s) for the components within this table should contain the current row index (e.g. `dataGrid[0].a`, `dataGrid[0].b`, `dataGrid[1].b`, etc.).';
+        const parent = this.getParentInfoFromComponent(component, data_path);
+        if (parent?.isTable) {
+            rule += 'The value is a table of rows (array of objects), where each row is a new instance of data values for the child components. ' + this.getParentToolDescription(parent) + ' All `data_path`(s) for the components within this table should contain the current row index (e.g. `dataGrid[0].a`, `dataGrid[0].b`, `dataGrid[1].b`, etc.).';
             return rule;
         }
-        if (component.type === 'form') {
-            parent.isForm = true;
-            rule += 'The value is a nested form submission in the format `{data: {...}}` where `{...}` is the values for the child components. ' + this.getParentToolDescription(parent) + 'All `data_path`(s) for the components within this nested form should be prefixed with `data` (e.g. `nestedForm.data.exampleField`).';
+        if (parent?.isForm) {
+            rule += 'The value is a nested form submission in the format `{data: {...}}` where `{...}` is the values for the child components. ' + this.getParentToolDescription(parent) + ' All `data_path`(s) for the components within this nested form should be prefixed with `data` (e.g. `nestedForm.data.exampleField`).';
             return rule;
         }
-        if (component.type === 'container') {
-            parent.isContainer = true;
-            rule += 'The value is an object/map of nested component values in the format `{...}`. ' + this.getParentToolDescription(parent) + 'All `data_path`(s) for the components within this container should be prefixed with the container\'s `data_path` (e.g. `container.exampleField`).';
+        if (parent?.isContainer) {
+            rule += 'The value is an object/map of nested component values in the format `{...}`. ' + this.getParentToolDescription(parent) + ' All `data_path`(s) for the components within this container should be prefixed with the container\'s `data_path` (e.g. `container.exampleField`).';
             return rule;
         }
         switch (component.type) {
@@ -268,7 +310,7 @@ class UAGFormInterface extends appserver_1.FormInterface {
                     }
                     // Add the component info to the appropriate list.
                     const criteria = component.validate?.required ? 'required' : 'optional';
-                    fieldInfo[criteria].rules[component.type] = this.getComponentValueRule(component);
+                    fieldInfo[criteria].rules[component.type] = this.getComponentValueRule(component, path);
                     fieldInfo[criteria].components.push(this.getComponentInfo(component, path));
                 }
             }

package/lib/config.d.ts

@@ -16,7 +16,6 @@ export type UAGTemplateConfig = {
     formSubmitted?: string;
     listAvailableForms?: string;
     confirmFormSubmission?: string;
-    getOptionalFields?: string;
     formNotFound?: string;
     noSubmissionsFound?: string;
     submissionsFound?: string;

package/lib/templates/allFieldsCollected.md

@@ -1,17 +1,15 @@
-**All required fields have been collected for <%= parentLabel %>!**
-<% if (parentDataPath) { %>
-This data was collected within the data path of **<%= parentDataPath %>**.
-<% } %>
-<%= dataSummary %>
+**All required fields have been collected for <%= parentLabel %>.**
 
+<%= dataSummary %>
 **Next Steps**:
 <% if (parent && parent.isTable) { %>
-1. Use the `get_form_fields` tool with the same `parent` parameter and `criteria` set to "optional" to check if there are optional fields. If so, ask the user if they wish to fill any of them out for this row.
-2. If there are no optional fields, or the user declines, then ask the user if they wish to "Add Another" (add another row to the table). If they affirm, then use the `collect_field_data` tool to collect the next row's data. Make sure to increment the row index for the fields within this parent component (e.g. <%= parent.data_path %>[<%= rowIndex %>] => <%= parent.data_path %>[<%= (rowIndex + 1) %>]) when collecting data for the next row.
-3. If they do not wish to "Add Another", then use the `get_form_fields` tool to determine if there are any more fields that need to be collected outside of the <%= parent.label %> component. If so, use the `collect_field_data` tool to collect that information (make sure to change the `parent` parameter to the level above the <%= parent.label %> field, or to `null` if we are at the root of the form).
+1. Use the `get_form_fields` tool with `parent_path`="<%= parent.data_path %>" and `criteria`="optional" to check if there are optional fields for this row. If so, ask the user if they wish to fill any of them out for this row.
+2. If no other optional fields need to be provided, and another row of information is required for the **<%= parent.label %>** component, then use the `collect_field_data` tool to collect any additional required rows.
+3. If no additionial required rows are needed, then ask the user if they wish to "Add Another" (add another row to the **<%= parent.label %>** component). If they affirm, then use the `collect_field_data` tool to collect the next row's data. Make sure to increment the row index for the fields within **<%= parent.data_path %>** data_path when collecting data for the next row (e.g. <%= parent.data_path %>[<%= rowIndex %>] => <%= parent.data_path %>[<%= (rowIndex + 1) %>]).
+4. If they do not wish to "Add Another", then use the `get_form_fields` tool to determine if there are any more fields that need to be collected outside of the **<%= parent.label %>** component. If so, use the `collect_field_data` tool to collect that information (make sure to change the `parent_path` parameter to the level above the **<%= parent.label %>** field, or leave empty if we are at the root of the form).
 <% } else if (parent && (parent.isForm || parent.isContainer)) { %>
-1. Use the `get_form_fields` tool with the same `parent` parameter and `criteria` set to "optional" to check if there are optional fields. If so, ask the user if they wish to fill any of them out.
-2. If there are no optional fields, or the user declines, then use the `get_form_fields` tool to determine if there are any more fields that need to be collected outside of the <%= parent.label %> component. If so, use the `collect_field_data` tool to collect that information (make sure to change the parent parameter to the level above the <%= parent.label %> field, or to `null` if we are at the root of the form).
+1. Use the `get_form_fields` tool with `parent_path`="<%= parent.data_path %>" and `criteria`="optional" to check if there are any optional fields. If so, ask the user if they wish to fill any of them out.
+2. If there are no optional fields, or the user declines, then use the `get_form_fields` tool to determine if there are any more fields that need to be collected outside of the <%= parent.label %> component. If so, use the `collect_field_data` tool to collect that information (make sure to change the parent parameter to the level above the <%= parent.label %> field, or leave empty if we are at the root of the form).
 <% } else { %>
-1. Use the `get_form_fields` tool with the `criteria` set to "optional" to check if there are optional fields. If so, ask the user if they wish to fill any of them out.
+1. Use the `get_form_fields` tool with `criteria`="optional" to check if there are optional fields. If so, ask the user if they wish to fill any of them out.
 2. If there are no optional fields, or the user declines, then use the `confirm_form_submission` tool to show summary and get confirmation to submit the form.<% } %>

package/lib/templates/confirmFormSubmission.md

@@ -1,8 +1,8 @@
 # Confirm Form Submission
 
-All the required information for your **<%= form.title %>** form has been collected.
+All the required information for <%= parentLabel %> has been collected.
 
-Please review the following data before submission:
+Display the following information to the user for them to confirm if it looks accurate.
 
 <%= dataSummary %>
 
@@ -12,7 +12,4 @@ Please review the following data before submission:
 - Say or type "no" or "cancel" to make changes
 - Tell me which field you'd like to modify if you need to make changes
 
-Only use `submit_completed_form` if the user explicitly confirms (says "yes", "confirm", "submit", etc.).
-
-**Current Data**:
-<%= JSON.stringify(currentData, null, 2) %>
+Only use `submit_completed_form` if the user explicitly confirms (says "yes", "confirm", "submit", etc.).

package/lib/templates/fieldCollectedNext.md

@@ -1,14 +1,17 @@
 <%= message %>
 <% if (parent) { %>
-The following data is being collected for the nested component **<%= parent.label %> (<%= parent.type %>)**.  The parent `data_path` is **parent.data_path**, and all of the child data is collected within the path of **<%= parentDataPath %>**.
+The following data is being collected for the nested component **<%= parent.label %> (<%= parent.type %>)**.  The parent `data_path` is **<%= parent.data_path %>**, and all of the child data is collected within the path of **<%= parentDataPath %>**.
 <% } %>
-## Progress: <%= progress.collected %>/<%= progress.total %> required fields collected for <%= parentLabel %>.
+## Progress: <%= progress.collected %>/<%= progress.total %> all fields (required and optional) collected for <%= parentLabel %>.
 
 ## Remaining required fields for <%= parentLabel %>:
 <%= fields %>
+<%= rules %>
+
 Use the `collect_field_data` tool to provide values for the remaining required fields for <%= parentLabel %>. You can collect multiple fields at once by providing an array of field updates.
 
 <%= dataSummary %>
 
 **Next Steps**:
-1. Ask the user for any remaining required fields for <%= parentLabel %>.
+1. Ask the user for any remaining required fields for <%= parentLabel %>.
+2. If all "required" fields have been collected, then use the `get_form_fields` with `criteria` set to "optional" to get any additional fields the user wishes to also provide.

package/lib/templates/getFormFields.md

@@ -1,16 +1,8 @@
-<%= message %>## <%= type %> fields for <%= parentLabel %>
-<% if (parent) { %>
-All values for these fields should be stored within the `data_path`="<%= parentDataPath %>" (e.g. "<%= parentDataPath %>.exampleField")
-<% } %>
-### Summary
-- Total fields for <%= parentLabel %>: <%= totalFields %>
-- Total fields collected for <%= parentLabel %>: <% totalCollected %>
-- Number of <%= type %> fields for <%= parentLabel %>: <%= totalType %>
-- Number of <%= type %> fields collected for <%= parentLabel %>: <%= totalTypeCollected %>
+## <%= type %> fields for <%= parentLabel %><% if (parent) { %>
 
-<%= rules %>
-
-### <%= type %> fields for <%= parentLabel %>
+All values for these fields should be stored within the `data_path`="<%= parentDataPath %>" (e.g. "<%= parentDataPath %>.exampleField")<% } %>
 <%= fieldList %>
 
-Once the user provides provides some context, use the `get_field_info` tool to understand how to validate and process the data that was collected. Make sure to set the `field_paths` to only the paths of the fields that the user has provided values for.
+<%= rules %>
+
+Once the user provides provides some context, use the `get_field_info` tool<% if (parent) { %> with the `parent_path`="<%= parent.data_path %>"<% } %> to understand how to validate and process the data that was collected. Make sure to set the `field_paths` to only the paths of the fields that the user has provided values for.

package/lib/templates/getFormFieldsEmpty.md

@@ -1,4 +1,14 @@
-No fields were found matching your specified `criteria` for <%= parentLabel %>.
-<% if (parent) { %>
-Considering the search was made within a `parent` context, try the search again at a higher `parent` context.
+No fields were found matching `criteria`="<%= criteria %>" for <%= parentLabel %>.
+
+**Next Steps**:
+<% if (parent && parent.isTable) { %>
+ - Ask the user if they wish to "Add Another" (add another row to the **<%= parent.label %>** component). If they affirm, then use the `collect_field_data` tool to collect the next row's data. Make sure to increment the row index for the fields within **<%= parent.data_path %>** data_path when collecting data for the next row (e.g. <%= parent.data_path %>[<%= rowIndex %>] => <%= parent.data_path %>[<%= (rowIndex + 1) %>]).
+<% } else if (parent) { %>
+ - Considering the search was made using a `parent_path` context, try the search again at a higher `parent_path` context.
+<% } else if (criteria === "optional") { %>
+ - Since there are no more "optional" fields, use the `confirm_form_submission` tool to ensure all the collected information is correct.
+<% } else if (criteria === "required") { %>
+ - Use the `get_form_fields` tool, with `criteria`="optional" to determine if there are any optional fields they wish to provide information for.
+<% } else { %>
+ - Use the `confirm_form_submission` tool to ensure all the collected information is correct.
 <% } %>

package/lib/templates/getFormFieldsInfo.md

@@ -1,6 +1,9 @@
-Here is the field information for the fields requested.
-
+## Detailed field field information for <%= parentLabel %>
+<% if (parent) { %>
+All values for these fields should be stored within the parent path of "<%= parent.data_path %>" (e.g. "<%= parentDataPath %>.childField")
+<% } %>
 ### Field Information
 <%= fields %>
+<%= rules %>
 
-Use the `collect_field_data` tool to collect field information that the user has provided.
+Use the `collect_field_data` tool<% if (parent) { %> with the `parent_path`="<%= parent.data_path %>"<% } %> to collect field information that the user has provided, or use the `submission_update` tool to update existing records with new or modified values.

package/lib/tools/SchemaBuilder.d.ts

@@ -103,18 +103,10 @@ export declare class SchemaBuilder {
      */
     submission_id_partial(): this;
     /**
-     * Optional parent component information if collecting data for a specific nested component within a form.
-     * If not provided, the tool assumes data is being collected for the root form.
-     *
-     * ```json
-     * {
-     *   "type": "datagrid",
-     *   "isTable": true,
-     *   "data_path": "children"
-     * }
-     * ```
+     * The path of the parent component that contains nested components to collect spcific data for.
+     * @returns
      */
-    parent(): this;
+    parent_path(): this;
     /**
      * An array of field updates to apply to the `form_data`.
      * Each update specifies the `data_path` and the complete new value.

package/lib/tools/SchemaBuilder.js

@@ -142,26 +142,11 @@ class SchemaBuilder {
         return this;
     }
     /**
-     * Optional parent component information if collecting data for a specific nested component within a form.
-     * If not provided, the tool assumes data is being collected for the root form.
-     *
-     * ```json
-     * {
-     *   "type": "datagrid",
-     *   "isTable": true,
-     *   "data_path": "children"
-     * }
-     * ```
+     * The path of the parent component that contains nested components to collect spcific data for.
+     * @returns
      */
-    parent() {
-        this.schema.parent = zod_1.default.object({
-            type: zod_1.default.string().describe('The type of the parent component that contains nested components to collect data for. To find the type, you can use the `get_form_fields` tool for this path and look at the **Type** of that field.'),
-            label: zod_1.default.string().optional().describe('The label of the parent component that contains nested components to collect data for. This comes from the **Label** property of the field provided by the `get_form_fields` tool.'),
-            isTable: zod_1.default.boolean().optional().describe('Indicates if the parent component is a table-like component (datagrid or editgrid). This means that the value of this component is an array of objects, where each row is a new context of data for the fields within. Set this value to `true` if the `get_form_fields` tool says to use `parent.isTable=true`.'),
-            isForm: zod_1.default.boolean().optional().describe('Indicates if the parent component is a nested form-like component. This means that the value of this component is in the format of `{data: {...}}` where `{...}` is the context of data for the fields within. Set this value to `true` if the `get_form_fields` tool says to use `parent.isForm=true`.'),
-            isContainer: zod_1.default.boolean().optional().describe('Indicates if the parent component is a container-like component. This means that the value of this component is in the format of `{...}` where `{...}` is the context of data for the fields within. Set this value to `true` if the `get_form_fields` tool says to use `parent.isContainer=true`.'),
-            data_path: zod_1.default.string().describe('The `data_path` of the parent component that contains nested components to collect data for. To find the data_path, you can use the `get_form_fields` tool.')
-        }).optional().describe('Optional parent component information if collecting data for a specific nested component within a form. If not provided, the tool assumes data is being collected for the root form.');
+    parent_path() {
+        this.schema.parent_path = zod_1.default.string().optional().describe('The `data_path` of the parent component that contains nested components. Use this parameter if collecting data for fields within a specific nested component within a form. To find the `parent_path`, you can use the `get_field_info` tool, and use the `data_path` of any component that ****Has Nested Components**** = ✅ Yes. If not provided, the tool assumes data is being collected for the root form.');
         return this;
     }
     /**

package/lib/tools/collectData.js

@@ -2,10 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.collectData = void 0;
 const template_1 = require("../template");
-const utils_1 = require("./utils");
 const lodash_1 = require("lodash");
 const SchemaBuilder_1 = require("./SchemaBuilder");
-const lodash_2 = require("lodash");
 const collectData = async (project) => {
     return (0, lodash_1.defaultsDeep)(project.config?.toolOverrides?.collect_field_data || {}, {
         name: 'collect_field_data',
@@ -14,17 +12,15 @@ const collectData = async (project) => {
         inputSchema: (new SchemaBuilder_1.SchemaBuilder(project))
             .form_name()
             .form_data()
-            .parent()
+            .parent_path()
             .updates().schema,
-        execute: async ({ form_name, form_data, parent, updates }, extra) => {
+        execute: async ({ form_name, form_data, parent_path, updates }, extra) => {
             const form = await project.getForm(form_name);
             if (!form) {
                 return project.mcpResponse(template_1.ResponseTemplate.formNotFound, { formName: form_name }, true);
             }
             // Ensure the parent is undefined if the type or data_path is missing.
-            if (!parent?.data_path || !parent.type) {
-                parent = undefined;
-            }
+            const parent = form.getParentInfo(parent_path);
             // Merge the updates into the current data.
             for (const { data_path, new_value } of updates) {
                 form_data[data_path] = new_value;
@@ -36,34 +32,33 @@ const collectData = async (project) => {
             if (fields.errors.length > 0) {
                 return project.mcpResponse(template_1.ResponseTemplate.fieldValidationErrors, { invalidFields: fields.errors });
             }
-            const collectedData = parent ? (0, lodash_2.get)(submission, parent.data_path || '') : submission.data;
             // If no required fields remain, then we can move onto a new tool.
             if (!fields.required.components.length) {
                 return project.mcpResponse(template_1.ResponseTemplate.allFieldsCollected, {
                     form: form.form,
                     parent,
-                    parentDataPath: (0, utils_1.getParentDataPath)(parent, fields.rowIndex),
-                    parentLabel: (0, utils_1.getParentLabel)(parent),
+                    parentDataPath: form.getParentDataPath(parent, fields.rowIndex),
+                    parentLabel: form.getParentLabel(parent),
                     rowIndex: fields.rowIndex,
                     dataSummary: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.collectedData, {
-                        data: form.formatData(collectedData)
+                        data: form.formatData(submission.data)
                     })
                 });
             }
             // Collect more required fields.
             return project.mcpResponse(template_1.ResponseTemplate.fieldCollectedNext, {
                 parent,
-                parentDataPath: (0, utils_1.getParentDataPath)(parent, fields.rowIndex),
-                parentLabel: (0, utils_1.getParentLabel)(parent, form.form),
+                parentDataPath: form.getParentDataPath(parent, fields.rowIndex),
+                parentLabel: form.getParentLabel(parent),
                 message: 'Form data collected successfully!',
                 rules: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.fieldRules, { rules: Object.entries(fields.required.rules) }),
                 fields: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.fields, { fields: fields.required.components }),
                 dataSummary: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.collectedData, {
-                    data: form.formatData(collectedData)
+                    data: form.formatData(submission.data)
                 }),
                 progress: {
                     collected: Object.keys(form_data).length,
-                    total: fields.required.components.length + Object.keys(form_data).length
+                    total: fields.total
                 }
             });
         }

package/lib/tools/confirmSubmission.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.confirmSubmission = void 0;
 const template_1 = require("../template");
-const utils_1 = require("./utils");
 const lodash_1 = require("lodash");
 const SchemaBuilder_1 = require("./SchemaBuilder");
 const confirmSubmission = async (project) => {
@@ -29,7 +28,7 @@ const confirmSubmission = async (project) => {
             if (fields.required.components.length) {
                 return project.mcpResponse(template_1.ResponseTemplate.fieldCollectedNext, {
                     parent: undefined,
-                    parentLabel: (0, utils_1.getParentLabel)(undefined, form.form),
+                    parentLabel: form.getParentLabel(),
                     message: 'There is additional data that needs to be collected before submission.',
                     rules: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.fieldRules, { rules: Object.entries(fields.required.rules) }),
                     fields: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.fields, { fields: fields.required.components }),
@@ -44,11 +43,10 @@ const confirmSubmission = async (project) => {
             }
             // Confirm the submission.
             return project.mcpResponse(template_1.ResponseTemplate.confirmFormSubmission, {
-                form,
+                parentLabel: form.getParentLabel(),
                 dataSummary: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.collectedData, {
                     data: form.formatData(submission.data)
-                }),
-                currentData: form_data
+                })
             });
         }
     });

package/lib/tools/getFieldInfo.js

@@ -12,17 +12,25 @@ const getFieldInfo = async (project) => {
         description: 'Get detailed information about a specific field(s) that have been provided from the user. It is used to understand the properties, validation rules, and options of the specific field(s) the user has provided values for. This purpose of this tool is to provide detailed information for any field(s) (provided using the `field_paths` parameter) to help understand the structure and requirements of a form. PREREQUISITE: This tool should be called after the `get_form_fields` tool has been called AND once the user has provided some values for the provided fields.',
         inputSchema: (new SchemaBuilder_1.SchemaBuilder(project))
             .form_name()
-            .field_paths().schema,
-        execute: async ({ form_name, field_paths }, extra) => {
+            .field_paths()
+            .parent_path().schema,
+        execute: async ({ form_name, field_paths, parent_path }, extra) => {
             const form = await project.getForm(form_name);
             if (!form) {
                 return project.mcpResponse(template_1.ResponseTemplate.formNotFound, { formName: form_name }, true);
             }
             try {
+                // Get the parent info if a parent_path was provided.
+                const parent = form.getParentInfo(parent_path);
                 // Get the fields at the specified data path (or root if not provided).
                 const fields = await form.getFields({ data: {} }, extra.authInfo, field_paths);
+                const allRules = { ...fields.required.rules, ...fields.optional.rules };
                 // Show the form fields based on the criteria.
                 return project.mcpResponse(template_1.ResponseTemplate.getFormFieldsInfo, {
+                    parent,
+                    parentLabel: form.getParentLabel(parent),
+                    parentDataPath: form.getParentDataPath(parent, fields.rowIndex),
+                    rules: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.fieldRules, { rules: Object.entries(allRules) }),
                     fields: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.fields, {
                         fields: fields.required.components.concat(fields.optional.components)
                     }),

package/lib/tools/getFormFields.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFormFields = void 0;
 const template_1 = require("../template");
-const utils_1 = require("./utils");
 const lodash_1 = require("lodash");
 const SchemaBuilder_1 = require("./SchemaBuilder");
 const error = require('debug')('formio:uag:getFormFields:error');
@@ -13,30 +12,18 @@ const getFormFields = async (project) => {
         description: 'Get high level overview of the fields that are present in a form, and to understand the "rules" on how the data for each field type should be collected. The purpose of this tool is to determine what fields the user is requesting (and to understand how to format that values for that data), and use that to create a list of field data_path\'s that the user is providing context for. This list can then be provided to the `get_field_info` tool to determine the specific field level information for those fields (validation, required, collection rules, etc). PREREQUISITE: You must call the `get_forms` tool first to understand what forms are available to submit and the permissions associated with those forms.',
         inputSchema: (new SchemaBuilder_1.SchemaBuilder(project))
             .form_name()
-            .form_data()
             .criteria()
-            .parent().schema,
-        execute: async ({ form_name, form_data, criteria, parent }, extra) => {
+            .parent_path().schema,
+        execute: async ({ form_name, criteria, parent_path }, extra) => {
             const form = await project.getForm(form_name);
             if (!form) {
                 return project.mcpResponse(template_1.ResponseTemplate.formNotFound, { formName: form_name }, true);
             }
             try {
-                // Ensure the parent is null if the type or data_path is missing.
-                if (!parent?.data_path || !parent.type) {
-                    parent = undefined;
-                }
-                // Get the submission data.
-                const submission = form.convertToSubmission(form_data);
+                // Get the parent info if a path was provided.
+                const parent = form.getParentInfo(parent_path);
                 // Get the fields at the specified data path (or root if not provided).
-                const fields = await form.getFields(submission, extra.authInfo, parent?.data_path);
-                // If the agent requests optional fields, but there are still requird fields to fill out, then force required
-                // and inform the agent of this change.
-                let message = '';
-                if (criteria == 'optional' && fields.required.components.length > 0) {
-                    criteria = 'required';
-                    message = 'You requested "optional" fields, but the user is not finished collecting required information. Please finish collecting the following required fields first.\n\n';
-                }
+                const fields = await form.getFields({ data: {} }, extra.authInfo, parent?.data_path);
                 // Determine which fields to show based on the criteria.
                 const criteriaFields = criteria === 'all' ?
                     [...fields.required.components, ...fields.optional.components] :
@@ -44,7 +31,8 @@ const getFormFields = async (project) => {
                 if (criteriaFields.length === 0) {
                     return project.mcpResponse(template_1.ResponseTemplate.getFormFieldsEmpty, {
                         parent,
-                        parentLabel: (0, utils_1.getParentLabel)(parent),
+                        parentLabel: form.getParentLabel(parent),
+                        criteria,
                         type: (0, lodash_1.upperFirst)(criteria),
                         form: form.form,
                     });
@@ -53,37 +41,14 @@ const getFormFields = async (project) => {
                 const criteriaRules = criteria === 'all' ?
                     { ...fields.required.rules, ...fields.optional.rules } :
                     criteria === 'required' ? fields.required.rules : fields.optional.rules;
-                let totalType = fields.total;
-                if (criteria === 'required') {
-                    totalType = fields.totalRequired;
-                }
-                else if (criteria === 'optional') {
-                    totalType = fields.total - fields.totalRequired;
-                }
-                const totalCollected = Object.keys(form_data || {}).length;
-                let totalTypeCollected = 0;
-                if (criteria === 'required') {
-                    totalTypeCollected = fields.totalRequiredCollected;
-                }
-                else if (criteria === 'optional') {
-                    totalTypeCollected = totalCollected - fields.totalRequiredCollected;
-                }
-                else {
-                    totalTypeCollected = totalCollected;
-                }
                 // Show the form fields based on the criteria.
                 return project.mcpResponse(template_1.ResponseTemplate.getFormFields, {
-                    message,
                     parent,
-                    parentLabel: (0, utils_1.getParentLabel)(parent, form.form),
-                    parentDataPath: (0, utils_1.getParentDataPath)(parent, fields.rowIndex),
+                    parentLabel: form.getParentLabel(parent),
+                    parentDataPath: form.getParentDataPath(parent, fields.rowIndex),
                     type: (0, lodash_1.upperFirst)(criteria),
                     rules: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.fieldRules, { rules: Object.entries(criteriaRules) }),
-                    fieldList: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.fieldList, { fields: criteriaFields }),
-                    totalFields: fields.total,
-                    totalType,
-                    totalCollected,
-                    totalTypeCollected
+                    fieldList: project.uagTemplate?.renderTemplate(template_1.ResponseTemplate.fieldList, { fields: criteriaFields })
                 });
             }
             catch (err) {

package/lib/tools/utils.d.ts

@@ -1,5 +1,4 @@
 import { ZodRawShape } from "zod";
-import { Form } from '@formio/core';
 export type ToolInfo = {
     name?: string;
     title?: string;
@@ -24,5 +23,3 @@ export type SearchQuery = {
     search_value: string;
     operator: string;
 };
-export declare function getParentLabel(parent?: ParentInfo, form?: Form): string;
-export declare function getParentDataPath(parent?: ParentInfo, rowIndex?: number): string;

package/lib/tools/utils.js

@@ -1,27 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getParentLabel = getParentLabel;
-exports.getParentDataPath = getParentDataPath;
-function getParentLabel(parent, form) {
-    let parentLabel = form ? `the **${form.title} (${form.name})** form` : 'this form';
-    if (parent?.isTable) {
-        parentLabel = `this row within the **${parent.label}** component`;
-    }
-    else if (parent?.isForm) {
-        parentLabel = `the **${parent.label}** nested form`;
-    }
-    else if (parent?.isContainer) {
-        parentLabel = `the **${parent.label}** container component`;
-    }
-    return parentLabel;
-}
-function getParentDataPath(parent, rowIndex = -1) {
-    let parentDataPath = parent?.data_path || '';
-    if (parentDataPath && (rowIndex >= 0)) {
-        parentDataPath += `[${rowIndex}]`;
-    }
-    if (parent?.isForm) {
-        parentDataPath += '.data';
-    }
-    return parentDataPath;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formio/uag",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "The Form.io Universal Agent Gateway (UAG).",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/lib/templates/getOptionalFields.md

@@ -1,19 +0,0 @@
-# Optional Fields Available
-
-All required fields have been collected for your **<%= form.title %>** form.
-
-**Would you like to fill out any optional fields?**
-
-There are <%= totalOptionalFields %> optional fields available:
-<%= optionalFields %>
-
-If values for any of these fields are already provided, then skip to the `collect_field_data` tool to add those additional fields. Otherwise, use the following options.
-
-**Options:**
-- Say "yes" or "I'd like to fill optional fields" to add optional information
-- Say "no" or "skip optional fields" to proceed with just the required information
-- Say the name of a specific field you'd like to fill (e.g., "email")
-
-Use the `collect_field_data` tool to collect any optional fields the user wants to fill.
-
-If they wish to skip the collection of optional fields, then use the `submit_completed_form` to submit the required data to the form.