@uipath/skills 1.195.0 → 1.196.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/CODEOWNERS +16 -10
- package/README.md +39 -4
- package/assets/skill-status.json +189 -0
- package/assets/uip-catalog-snapshot.json +67 -97
- package/commands/install-permissions.md +46 -2
- package/hooks/suggest-permissions.sh +0 -0
- package/hooks/validate-skill-descriptions.sh +0 -0
- package/package.json +1 -1
- package/skills/uipath-admin/SKILL.md +6 -7
- package/skills/uipath-admin/references/audit-commands.md +32 -10
- package/skills/uipath-admin/references/audit-workflow-guide.md +25 -6
- package/skills/uipath-admin/references/ip-restriction/ip-restriction-commands.md +1 -1
- package/skills/uipath-agents/SKILL.md +5 -3
- package/skills/uipath-agents/references/coded/embedding-in-flows.md +6 -0
- package/skills/uipath-agents/references/coded/flow-integration.md +1 -0
- package/skills/uipath-agents/references/coded/frameworks/langgraph-integration.md +2 -2
- package/skills/uipath-agents/references/coded/frameworks/llamaindex-integration.md +1 -1
- package/skills/uipath-agents/references/coded/frameworks/openai-agents-integration.md +5 -1
- package/skills/uipath-agents/references/coded/lifecycle/build.md +1 -0
- package/skills/uipath-agents/references/coded/lifecycle/evaluate.md +8 -6
- package/skills/uipath-agents/references/coded/quickstart.md +17 -12
- package/skills/uipath-agents/references/lowcode/agent-definition.md +17 -16
- package/skills/uipath-agents/references/lowcode/capabilities/built-in-tools/analyze-attachments.md +2 -2
- package/skills/uipath-agents/references/lowcode/capabilities/built-in-tools/batch-transform/impl-json.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/built-in-tools/built-in-tools.md +4 -4
- package/skills/uipath-agents/references/lowcode/capabilities/built-in-tools/deeprag/impl-json.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/context/context.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/context/datafabric.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/context/index.md +12 -12
- package/skills/uipath-agents/references/lowcode/capabilities/escalation/escalation.md +14 -14
- package/skills/uipath-agents/references/lowcode/capabilities/guardrails/guardrails-recommend.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/guardrails/guardrails.md +23 -20
- package/skills/uipath-agents/references/lowcode/capabilities/inline-in-flow/inline-in-flow.md +27 -26
- package/skills/uipath-agents/references/lowcode/capabilities/integration-service/integration-service.md +12 -13
- package/skills/uipath-agents/references/lowcode/capabilities/mcp/mcp.md +133 -0
- package/skills/uipath-agents/references/lowcode/capabilities/memory/memory.md +9 -9
- package/skills/uipath-agents/references/lowcode/capabilities/process/process.md +25 -24
- package/skills/uipath-agents/references/lowcode/capabilities/process/solution-files.md +6 -6
- package/skills/uipath-agents/references/lowcode/critical-rules.md +17 -17
- package/skills/uipath-agents/references/lowcode/debug.md +55 -0
- package/skills/uipath-agents/references/lowcode/evaluations/evaluate.md +6 -6
- package/skills/uipath-agents/references/lowcode/evaluations/evaluation-sets.md +1 -1
- package/skills/uipath-agents/references/lowcode/evaluations/evaluators.md +3 -3
- package/skills/uipath-agents/references/lowcode/evaluations/running-evaluations.md +8 -8
- package/skills/uipath-agents/references/lowcode/lowcode.md +18 -12
- package/skills/uipath-agents/references/lowcode/model-selection-guide.md +3 -3
- package/skills/uipath-agents/references/lowcode/project-lifecycle.md +53 -33
- package/skills/uipath-agents/references/lowcode/solution-resources.md +8 -8
- package/skills/uipath-api-workflow/SKILL.md +32 -83
- package/skills/uipath-api-workflow/references/cli-reference.md +40 -26
- package/skills/uipath-api-workflow/references/connector-activity-discovery.md +75 -23
- package/skills/uipath-api-workflow/references/troubleshooting.md +4 -12
- package/skills/uipath-automation-discovery/SKILL.md +234 -0
- package/skills/uipath-automation-discovery/references/intake-guide.md +85 -0
- package/skills/uipath-automation-discovery/references/mining-guide.md +156 -0
- package/skills/uipath-automation-discovery/references/report-template.md +95 -0
- package/skills/uipath-coded-apps/SKILL.md +0 -2
- package/skills/uipath-data-fabric/SKILL.md +0 -2
- package/skills/uipath-feedback/SKILL.md +1 -1
- package/skills/uipath-governance/SKILL.md +0 -2
- package/skills/uipath-human-in-the-loop/SKILL.md +2 -3
- package/skills/uipath-maestro-bpmn/.maintenance/check-all.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-anchors.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-depth.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-link-text.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-links.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-orphans.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-plugin-pairs.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-template.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-uip-commands.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-validation-fixtures.py +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-validation-fixtures.sh +0 -0
- package/skills/uipath-maestro-bpmn/references/author/references/task-recipes/api-workflow.md +1 -1
- package/skills/uipath-maestro-bpmn/references/operate/references/run.md +1 -1
- package/skills/uipath-maestro-bpmn/references/shared/local-metadata-regeneration-guide.md +2 -2
- package/skills/uipath-maestro-bpmn/references/shared/wrapper-shells.md +1 -1
- package/skills/uipath-maestro-case/SKILL.md +22 -27
- package/skills/uipath-maestro-case/references/bindings-and-expressions.md +7 -1
- package/skills/uipath-maestro-case/references/bindings-v2-sync.md +7 -16
- package/skills/uipath-maestro-case/references/case-commands.md +9 -9
- package/skills/uipath-maestro-case/references/case-editing-operations.md +51 -67
- package/skills/uipath-maestro-case/references/case-schema.md +74 -138
- package/skills/uipath-maestro-case/references/connector-integration.md +32 -5
- package/skills/uipath-maestro-case/references/connector-trigger-common.md +39 -12
- package/skills/uipath-maestro-case/references/evals/evals.json +9 -23
- package/skills/uipath-maestro-case/references/implementation.md +24 -24
- package/skills/uipath-maestro-case/references/phased-execution.md +24 -38
- package/skills/uipath-maestro-case/references/placeholder-tasks.md +9 -9
- package/skills/uipath-maestro-case/references/planning.md +20 -79
- package/skills/uipath-maestro-case/references/plugins/case/impl-json.md +15 -122
- package/skills/uipath-maestro-case/references/plugins/case/planning.md +3 -1
- package/skills/uipath-maestro-case/references/plugins/conditions/case-exit-conditions/impl-json.md +10 -22
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-entry-conditions/impl-json.md +7 -5
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-entry-conditions/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/impl-json.md +5 -5
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/planning.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/conditions/task-entry-conditions/impl-json.md +4 -4
- package/skills/uipath-maestro-case/references/plugins/logging/impl-json.md +10 -0
- package/skills/uipath-maestro-case/references/plugins/sla/impl-json.md +10 -42
- package/skills/uipath-maestro-case/references/plugins/sla/planning.md +5 -5
- package/skills/uipath-maestro-case/references/plugins/stages/impl-json.md +8 -79
- package/skills/uipath-maestro-case/references/plugins/stages/planning.md +7 -14
- package/skills/uipath-maestro-case/references/plugins/tasks/agent/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/agent/planning.md +3 -2
- package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/planning.md +3 -2
- package/skills/uipath-maestro-case/references/plugins/tasks/case-management/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/case-management/planning.md +4 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/impl-json.md +2 -2
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/planning.md +12 -7
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-trigger/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-trigger/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/process/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/process/planning.md +4 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/rpa/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/rpa/planning.md +4 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/wait-for-timer/impl-json.md +3 -0
- package/skills/uipath-maestro-case/references/plugins/triggers/event/impl-json.md +6 -7
- package/skills/uipath-maestro-case/references/plugins/triggers/event/planning.md +4 -2
- package/skills/uipath-maestro-case/references/plugins/triggers/manual/impl-json.md +4 -27
- package/skills/uipath-maestro-case/references/plugins/triggers/timer/impl-json.md +8 -20
- package/skills/uipath-maestro-case/references/plugins/variables/bindings/impl-json.md +6 -11
- package/skills/uipath-maestro-case/references/plugins/variables/global-vars/impl-json.md +15 -30
- package/skills/uipath-maestro-case/references/plugins/variables/global-vars/planning.md +4 -4
- package/skills/uipath-maestro-case/references/plugins/variables/io-binding/impl-json.md +8 -7
- package/skills/uipath-maestro-case/references/registry-discovery.md +4 -4
- package/skills/uipath-maestro-case/references/sdd-generation-rules.md +12 -10
- package/skills/uipath-maestro-case/references/troubleshooting-guide.md +1 -1
- package/skills/uipath-maestro-flow/.maintenance/check-all.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-anchors.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-depth.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-link-text.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-links.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-orphans.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-plugin-pairs.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-template.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-uip-commands.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-versions.sh +0 -0
- package/skills/uipath-maestro-flow/SKILL.md +9 -6
- package/skills/uipath-maestro-flow/references/author/CAPABILITY.md +4 -4
- package/skills/uipath-maestro-flow/references/author/references/brownfield.md +17 -2
- package/skills/uipath-maestro-flow/references/author/references/editing-operations-cli.md +1 -1
- package/skills/uipath-maestro-flow/references/author/references/editing-operations-json.md +3 -3
- package/skills/uipath-maestro-flow/references/author/references/editing-operations.md +9 -9
- package/skills/uipath-maestro-flow/references/author/references/greenfield.md +13 -10
- package/skills/uipath-maestro-flow/references/author/references/planning-arch.md +75 -5
- package/skills/uipath-maestro-flow/references/author/references/planning-impl.md +2 -1
- package/skills/uipath-maestro-flow/references/author/references/plugins/connector/impl.md +14 -4
- package/skills/uipath-maestro-flow/references/author/references/plugins/connector-trigger/impl.md +20 -4
- package/skills/uipath-maestro-flow/references/author/references/plugins/hitl/impl.md +5 -5
- package/skills/uipath-maestro-flow/references/author/references/plugins/hitl/planning.md +5 -5
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/impl-connector.md +81 -0
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/impl-manual.md +63 -0
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/impl.md +59 -57
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/planning.md +8 -7
- package/skills/uipath-maestro-flow/references/author/references/plugins/inline-agent/impl.md +23 -23
- package/skills/uipath-maestro-flow/references/author/references/plugins/inline-agent/planning.md +2 -2
- package/skills/uipath-maestro-flow/references/diagnose/CAPABILITY.md +1 -1
- package/skills/uipath-maestro-flow/references/diagnose/references/failure-modes.md +6 -6
- package/skills/uipath-maestro-flow/references/evaluate/CAPABILITY.md +2 -2
- package/skills/uipath-maestro-flow/references/evaluate/references/upload-safety.md +1 -1
- package/skills/uipath-maestro-flow/references/operate/CAPABILITY.md +8 -8
- package/skills/uipath-maestro-flow/references/operate/references/run.md +2 -2
- package/skills/uipath-maestro-flow/references/operate/references/ship.md +7 -7
- package/skills/uipath-maestro-flow/references/shared/cli-commands.md +19 -17
- package/skills/uipath-maestro-flow/references/shared/cli-conventions.md +1 -1
- package/skills/uipath-maestro-flow/references/shared/file-format.md +1 -1
- package/skills/uipath-maestro-flow/references/shared/ux-narration-and-todos.md +7 -7
- package/skills/uipath-planner/SKILL.md +110 -74
- package/skills/{uipath-solution → uipath-planner}/assets/templates/agent-sdd-template.md +3 -3
- package/skills/{uipath-solution → uipath-planner}/assets/templates/api-workflow-sdd-template.md +4 -4
- package/skills/{uipath-solution → uipath-planner}/assets/templates/case-sdd-template.md +4 -4
- package/skills/{uipath-solution → uipath-planner}/assets/templates/coded-app-sdd-template.md +3 -3
- package/skills/{uipath-solution → uipath-planner}/assets/templates/flow-sdd-template.md +4 -4
- package/skills/{uipath-solution → uipath-planner}/assets/templates/rpa-sdd-template.md +11 -11
- package/skills/uipath-planner/references/multi-skill-patterns-guide.md +3 -3
- package/skills/uipath-planner/references/non-pdd-lane-guide.md +10 -6
- package/skills/uipath-planner/references/pdd-driven-lane-guide.md +17 -7
- package/skills/uipath-planner/references/plan-and-tasks-format.md +2 -2
- package/skills/{uipath-solution/references/design → uipath-planner/references}/product-selection-guide.md +8 -8
- package/skills/{uipath-solution/references/design → uipath-planner/references}/rpa-product-guide.md +1 -1
- package/skills/{uipath-solution/references/design → uipath-planner/references}/sdd-generation-guide.md +26 -39
- package/skills/{uipath-solution/references/design → uipath-planner/references}/tenant-library-search-guide.md +7 -7
- package/skills/uipath-platform/SKILL.md +21 -48
- package/skills/uipath-platform/references/integration-service/http-request.md +5 -2
- package/skills/uipath-platform/references/integration-service/reference-resolution.md +19 -1
- package/skills/uipath-platform/references/integration-service/triggers.md +21 -5
- package/skills/uipath-platform/references/licensing/consumables-report.md +1 -1
- package/skills/uipath-platform/references/licensing/tenant-allocations.md +1 -1
- package/skills/uipath-platform/references/licensing/user-licenses-allocations.md +1 -1
- package/skills/uipath-platform/references/{resources → orchestrator}/manage-assets.md +37 -34
- package/skills/uipath-platform/references/orchestrator/manage-sessions.md +1 -1
- package/skills/uipath-platform/references/orchestrator/orchestrator.md +4 -31
- package/skills/uipath-platform/references/{resources → orchestrator}/process-queues.md +61 -50
- package/skills/uipath-platform/references/{resources → orchestrator}/resources.md +21 -21
- package/skills/uipath-platform/references/orchestrator/run-jobs.md +26 -14
- package/skills/uipath-platform/references/orchestrator/setup-environment.md +20 -16
- package/skills/uipath-platform/references/orchestrator/tenant-admin.md +7 -7
- package/skills/uipath-platform/references/{resources → orchestrator}/triggers-and-webhooks.md +41 -37
- package/skills/uipath-platform/references/{resources → orchestrator}/work-with-storage.md +56 -34
- package/skills/uipath-platform/references/uip-commands.md +20 -19
- package/skills/uipath-review/SKILL.md +81 -7
- package/skills/uipath-review/references/agents/agent-common-issues.md +42 -0
- package/skills/uipath-review/references/agents/agent-review-checklist.md +79 -57
- package/skills/uipath-review/references/agents/agents-coded-rules.md +160 -0
- package/skills/uipath-review/references/agents/agents-common-rules.md +32 -0
- package/skills/uipath-review/references/agents/agents-lowcode-rules.md +128 -0
- package/skills/uipath-review/references/platform/platform-resources-checklist.md +2 -2
- package/skills/uipath-review/references/review-workflow-guide.md +1 -1
- package/skills/uipath-review/references/rpa/rpa-review-checklist.md +2 -2
- package/skills/uipath-review/references/rule-catalog-workflow.md +90 -0
- package/skills/uipath-review/references/rule-format.md +91 -0
- package/skills/uipath-rpa/SKILL.md +16 -6
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/CreateEntityRecord.md +149 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/CreateMultipleEntityRecords.md +67 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/DeleteEntityRecord.md +44 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/DeleteFileFromRecordField.md +56 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/DeleteMultipleEntityRecords.md +65 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/DownloadFileFromRecordField.md +115 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/GetEntityRecordById.md +50 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/QueryEntityRecords.md +69 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/UpdateEntityRecord.md +120 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/UpdateMultipleEntityRecords.md +67 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/UploadFileToRecordField.md +103 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/guides/data-service-filter-builder-guide.md +461 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/overview.md +355 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/AppendRangeX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/AutoFillX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/AutoFitX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ChangeDataRangeModification.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ChangePivotTableDataSourceX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ClearRangeX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/CopyPasteRangeX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/CreatePivotTableXv2.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/CreateTableX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/DeleteColumnX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/DeleteRowsX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/DeleteSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/DuplicateSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ExecuteMacroArgumentX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ExecuteMacroX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ExportExcelToCsvX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FillRangeX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FilterPivotTableX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FilterX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FindFirstLastDataRowX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FindReplaceValueX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FormatRangeX.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InsertColumnX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InsertExcelChartX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InsertRowsX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InsertSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InvokeVBAArgumentX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InvokeVBAX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/LookupX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/PivotTableFieldX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ProtectSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ReadCellFormulaX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ReadCellValueX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/RefreshPivotTableX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/RemoveDuplicatesX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/RenameSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/SaveAsPdfX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/SaveExcelFileX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/SortColumnX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/SortX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/UnprotectSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/UpdateChartX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/VLookupX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/WriteCellX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.GSuite.Activities/3.8/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.Mail.Activities/2.8/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.MicrosoftOffice365.Activities/3.8/activities/SendMailConnections.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.MicrosoftOffice365.Activities/3.8/activities/overview.md +3 -3
- package/skills/uipath-rpa/references/activity-docs/UiPath.Presentations.Activities/2.5/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.System.Activities/25.10/activities/overview.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Word.Activities/2.5/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/cli-reference.md +108 -554
- package/skills/uipath-rpa/references/coded/coding-guidelines.md +1 -1
- package/skills/uipath-rpa/references/coded/operations-guide.md +3 -3
- package/skills/uipath-rpa/references/coded/third-party-packages-guide.md +1 -1
- package/skills/uipath-rpa/references/connector-capabilities.md +3 -2
- package/skills/uipath-rpa/references/debugging.md +43 -36
- package/skills/uipath-rpa/references/environment-setup.md +3 -3
- package/skills/uipath-rpa/references/is-connector-xaml-guide.md +3 -3
- package/skills/uipath-rpa/references/library-authoring-guide.md +226 -0
- package/skills/uipath-rpa/references/project-structure-guide.md +43 -0
- package/skills/uipath-rpa/references/publishing-guide.md +5 -5
- package/skills/uipath-rpa/references/tenant-library-search-guide.md +18 -14
- package/skills/uipath-rpa/references/testing-guide.md +6 -6
- package/skills/uipath-rpa/references/trigger-pattern-guide.md +2 -2
- package/skills/uipath-rpa/references/ui-automation-guide.md +43 -6
- package/skills/uipath-rpa/references/uia-configure-target-workflows.md +2 -2
- package/skills/uipath-rpa/references/uia-prerequisites.md +1 -1
- package/skills/uipath-rpa/references/validation-guide.md +4 -4
- package/skills/uipath-rpa/references/xaml/canvas-layout-guide.md +4 -1
- package/skills/uipath-rpa/references/xaml/common-pitfalls.md +18 -6
- package/skills/uipath-rpa/references/xaml/long-running-workflow-guide.md +304 -0
- package/skills/uipath-rpa/references/xaml/xaml-basics-and-rules.md +3 -0
- package/skills/uipath-solution/SKILL.md +23 -125
- package/skills/uipath-solution/references/{operate/activate-and-manage.md → activate-and-manage.md} +1 -1
- package/skills/uipath-solution/references/{operate/develop-solution.md → develop-solution.md} +43 -37
- package/skills/uipath-solution/references/{operate/pack-and-deploy.md → pack-and-deploy.md} +3 -3
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/intra-solution-references.md +2 -2
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/manual-edits.md +4 -4
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/same-name-across-folders.md +2 -2
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/shared-cloud-resource.md +3 -3
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/virtual-resource.md +4 -4
- package/skills/uipath-solution/references/{operate/scenarios.md → scenarios.md} +5 -5
- package/skills/uipath-solution/references/{operate/solution-overview.md → solution-overview.md} +3 -3
- package/skills/uipath-tasks/SKILL.md +0 -2
- package/skills/uipath-test/SKILL.md +26 -7
- package/skills/uipath-troubleshoot/agents/triage.md +6 -4
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/overview.md +55 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/add-queue-item-failed.md +58 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/application-launch-failed.md +56 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/browser-open-or-attach-failed.md +59 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/file-operation-failed.md +60 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/foreach-row-failed.md +56 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/image-target-not-found.md +56 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/invoke-code-failed.md +54 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/invoke-workflow-failed.md +58 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/kill-process-failed.md +49 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/ui-activity-configuration-error.md +80 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/ui-activity-timeout.md +61 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/ui-element-interaction-failed.md +61 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/ui-element-not-found.md +64 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/summary.md +24 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-file-locked.md +142 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-file-not-found.md +140 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-null-reference.md +119 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-sheet-not-found.md +146 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/write-cell-failures.md +131 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/summary.md +5 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/investigation_guide.md +1 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/overview.md +16 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/activity-configuration-error.md +42 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/ambiguous-selector.md +131 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/application-not-found.md +84 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/application-open-failed.md +46 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/browser-navigation-failed.md +45 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/click-coordinate-off-screen.md +120 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/disabled-element.md +0 -2
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/element-found-not-actionable.md +43 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/healing-agent-no-license.md +12 -12
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/healing-agent-orch-issues.md +108 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/inject-js-failed.md +41 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/scope-container-wrong-page.md +7 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/select-item-no-items.md +37 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/selector-failure-manual.md +2 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/timeout-issue.md +2 -2
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/verify-execution-failure.md +120 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/wrong-target-application.md +41 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/summary.md +12 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/guardrail-violation.md +111 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-connection-disabled.md +90 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-invalid-credentials.md +123 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-invalid-element-instance.md +96 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/llm-insufficient-information.md +1 -1
- package/skills/uipath-troubleshoot/references/products/agents/summary.md +4 -0
- package/skills/uipath-troubleshoot/references/products/orchestrator/investigation_guide.md +7 -7
- package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-pending-no-host.md +3 -1
- package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-pending-stale-dispatch.md +2 -0
- package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-stopped-exit-code-0x40010004.md +104 -0
- package/skills/uipath-troubleshoot/references/products/orchestrator/summary.md +1 -0
- package/skills/uipath-troubleshoot/references/summary.md +10 -1
- package/version-manifest.json +2 -2
- package/skills/uipath-ixp/SKILL.md +0 -84
- package/skills/uipath-ixp/references/cli-reference.md +0 -113
- package/skills/uipath-ixp/references/improve-prompts-guide.md +0 -283
- package/skills/uipath-ixp/references/label-documents-guide.md +0 -175
- package/skills/uipath-ixp/references/project-setup-guide.md +0 -90
- package/skills/uipath-maestro-case/references/plugins/edges/impl-json.md +0 -152
- package/skills/uipath-maestro-case/references/plugins/edges/planning.md +0 -93
- /package/skills/{uipath-solution/references/design → uipath-planner/references}/package-selection-guide.md +0 -0
- /package/skills/{uipath-solution/references/design → uipath-planner/references}/pdd-analysis-guide.md +0 -0
- /package/skills/uipath-solution/references/{operate/scenarios → scenarios}/failure-modes.md +0 -0
|
@@ -4,9 +4,9 @@ These rules are the canonical source for low-code agent authoring. Capability fi
|
|
|
4
4
|
|
|
5
5
|
## Critical Rules (22)
|
|
6
6
|
|
|
7
|
-
1. **Edit JSON files directly, except CLI-managed memory features** — the CLI supports `init` (scaffold), `
|
|
7
|
+
1. **Edit JSON files directly, except CLI-managed memory features** — the CLI supports `init` (scaffold), `refresh` (apply migrations + regenerate derived files), `validate` (strict read-only check), and `memory` (writes memory feature files). Agent configuration (prompts, schemas, settings) is done by editing `agent.json`. Resources (tools, contexts, escalations) are added as individual files in `resources/{ResourceName}/resource.json` inside the agent project directory — **not** inline in `agent.json`. Memory spaces are added with `uip agent memory` and live in `features/{FeatureName}/feature.json`. The root `agent.json` should not contain `resources` or manually-authored memory feature entries. The `refresh` command reads `agent.json` and these resource files to generate `entry-points.json` and `bindings_v2.json`.
|
|
8
8
|
|
|
9
|
-
2. **
|
|
9
|
+
2. **Refresh and validate after every bulk of edits** — run `uip agent refresh --output json` to apply pending migrations and regenerate derived files (`entry-points.json`, `bindings_v2.json`), then `uip agent validate --output json` to verify the project is clean. Refresh applies writes only when all checks pass; validate is strict read-only (never writes files, fails if migration is pending or derived files are out of sync). Always run both in sequence after a cohesive set of related changes.
|
|
10
10
|
|
|
11
11
|
3. **Use `--output json`** on all `uip` commands when parsing output.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ These rules are the canonical source for low-code agent authoring. Capability fi
|
|
|
16
16
|
|
|
17
17
|
6. **Keep contentTokens in sync with content** — every message has both a `content` string and a `contentTokens` array. Update both when editing. See [agent-definition.md](agent-definition.md) § contentTokens Construction.
|
|
18
18
|
|
|
19
|
-
7. **Do not manually
|
|
19
|
+
7. **Do not manually edit `entry-points.json` or `bindings_v2.json`** — they are generated by `uip agent refresh`. Edit `agent.json` and `resources/{Name}/resource.json`, then re-run refresh.
|
|
20
20
|
|
|
21
21
|
8. **Do not publish or deploy without user consent** — ask before running `uip solution upload`, `uip solution publish`, or `uip solution deploy`.
|
|
22
22
|
|
|
@@ -24,13 +24,13 @@ These rules are the canonical source for low-code agent authoring. Capability fi
|
|
|
24
24
|
|
|
25
25
|
10. **Solution must exist first** — create one with `uip solution init` before scaffolding an agent.
|
|
26
26
|
|
|
27
|
-
11. **Set `folderPath` to the literal `Folder` returned by `uip solution
|
|
27
|
+
11. **Set `folderPath` to the literal `Folder` returned by `uip solution resources list`.** Applies to both local (`Source: "Local"`) and external (`Source: "Remote"`) resources, and to tool `properties.folderPath`, context-index top-level `folderPath`, escalation `channel.properties.folderName`, and guardrail escalation `action.app.folderName`. Local resources typically carry `"solution_folder"` (their declared folder in the solution); external resources carry the human-readable, slash-separated Orchestrator folder (e.g., `"Shared"`, `"Shared/Sales/Region-EU"`). The author writes the value verbatim into `resource.json` (or into the guardrail action under `agent.json`); `uip agent refresh` propagates it into `bindings_v2.json` as `folderPath` (App resources translate `folderName` → binding `folderPath`). See [capabilities/process/process.md](capabilities/process/process.md) § Tool resource.json Shape.
|
|
28
28
|
|
|
29
|
-
12. **Tools carry a `location` field.** Use `"solution"` when the row from `uip solution
|
|
29
|
+
12. **Tools carry a `location` field.** Use `"solution"` when the row from `uip solution resources list` has `Source: "Local"` (resource is in the same solution); use `"external"` when `Source: "Remote"` (already deployed in Orchestrator). All other resource fields (`type`, `referenceKey`, `folderPath`, schemas, `exampleCalls`) follow the same rules in both cases. Connection (Integration Service) bindings are bound by `connection.id` and are exempt — no `folderPath` propagation.
|
|
30
30
|
|
|
31
|
-
13. **Process tools require solution-level resource files and `debug_overwrites.json`.** Whether local or external, you need the agent-level `resources/{ToolName}/resource.json`, solution-level files under `resources/solution_folder/`, AND a `userProfile/<userId>/debug_overwrites.json` for folder resolution. `uip solution
|
|
31
|
+
13. **Process tools require solution-level resource files and `debug_overwrites.json`.** Whether local or external, you need the agent-level `resources/{ToolName}/resource.json`, solution-level files under `resources/solution_folder/`, AND a `userProfile/<userId>/debug_overwrites.json` for folder resolution. `uip solution resources refresh` generates these from the bindings; for in-solution agents the package + process declarations are pre-created when the project is registered with the solution (auto-registered by `uip agent init` when run inside the solution directory; falls back to `uip solution project add` if registration was `NotInSolution` / `Skipped` / `Failed` — `OptedOut` means `--skip-solution-registration` was passed and the skip was intentional), and refresh resolves the binding against them. Without these, Studio Web will show "resource is missing in this environment". See [capabilities/process/solution-files.md](capabilities/process/solution-files.md).
|
|
32
32
|
|
|
33
|
-
14. **Never manually edit `storageVersion`.** It is managed by `uip agent
|
|
33
|
+
14. **Never manually edit `storageVersion`.** It is managed by `uip agent refresh` (which writes the latest version on success) and by Studio Web on import. `uip agent validate` fails with `AgentValidationOutdated` if the version is behind — run `uip agent refresh` to migrate. If validate reports a `storageVersion` newer than supported, upgrade uipcli rather than editing the field by hand.
|
|
34
34
|
|
|
35
35
|
15. **Inline agents in flows use `uipath.agent.autonomous` nodes.** The node's `inputs.source` references the inline agent's `projectId` UUID. Attached resource nodes (`uipath.agent.resource.tool.*`, `uipath.agent.resource.escalation`, `uipath.agent.resource.context.*`) use the same `inputs.source` convention to reference their `<RES_UUID>` subdirectory under `<projectId>/resources/`. The definition still declares `model.source: true`, but flow-core hoists the source identity onto `inputs.source` for the node instance; no node instance carries an instance `model` block. The agent definition lives in a subdirectory inside the flow project. See [capabilities/inline-in-flow/inline-in-flow.md](capabilities/inline-in-flow/inline-in-flow.md).
|
|
36
36
|
|
|
@@ -44,20 +44,20 @@ These rules are the canonical source for low-code agent authoring. Capability fi
|
|
|
44
44
|
|
|
45
45
|
20. **Built-in tools require explicit configuration.** Tools like `analyze-attachments` are not implicitly available — add them as `resources/{Name}/resource.json` with `type: "internal"` and `properties.toolType: "<kebab-lowercase-id>"`. The `toolType` discriminator is fixed per tool — copy from the capability reference, do not invent. See [capabilities/built-in-tools/built-in-tools.md](capabilities/built-in-tools/built-in-tools.md).
|
|
46
46
|
|
|
47
|
-
21. **Built-in tools need no solution-level files and no resource refresh.** Unlike external process tools, built-in tools (`type: "internal"`) are self-contained at the agent level. Do not run `uip solution
|
|
47
|
+
21. **Built-in tools need no solution-level files and no resource refresh.** Unlike external process tools, built-in tools (`type: "internal"`) are self-contained at the agent level. Do not run `uip solution resources refresh` for them; do not author solution-level resource files. Validate the agent and bundle.
|
|
48
48
|
|
|
49
|
-
22. **Use `uip agent memory` for memory spaces and seed items.** The memory commands own `features/{FeatureName}/feature.json`,
|
|
49
|
+
22. **Use `uip agent memory` for memory spaces and seed items.** The memory commands own `features/{FeatureName}/feature.json`, memory item type validation, and generated `memorySpace` bindings. Attach existing memory spaces by `--memory-space` plus literal `--folder-path`; seed items require `--memory-type episodic|escalation`, and episodic seed items require `--feedback-id`. Run `uip agent refresh --output json`, `uip agent validate --output json`, and then `uip solution resources refresh --output json` after memory changes in a solution. See [capabilities/memory/memory.md](capabilities/memory/memory.md).
|
|
50
50
|
|
|
51
51
|
## What NOT to Do (24)
|
|
52
52
|
|
|
53
|
-
1. **Do not manually
|
|
53
|
+
1. **Do not manually edit `entry-points.json` or `bindings_v2.json`** — they are generated by `uip agent refresh`. Edit source files (`agent.json`, `resources/{Name}/resource.json`) and re-run refresh.
|
|
54
54
|
2. **Do not use `=js:` or `$vars` in agent messages** — use `{{input.fieldName}}` only
|
|
55
55
|
3. **Do not skip schema sync** — agent.json and entry-points.json must match
|
|
56
56
|
4. **Do not skip validation after a bulk of related edits** — validate after each cohesive set of changes (not after every line, but always before moving on to a new capability or publishing)
|
|
57
57
|
5. **Do not publish/deploy without validating** — always validate first
|
|
58
58
|
6. **Do not forget contentTokens** — editing `content` without updating `contentTokens` causes rendering issues
|
|
59
|
-
7. **Do not forget `uip solution
|
|
60
|
-
8. **`uip solution
|
|
59
|
+
7. **Do not forget `uip solution resources refresh` after adding a process tool** — applies to both local and external. Creating only the agent-level `resources/{ToolName}/resource.json` is not enough. After `uip agent refresh` generates `bindings_v2.json`, run `uip solution resources refresh` from the solution root to import the bindings into the solution. For `Connection` bindings refresh also generates `debug_overwrites.json`. For `Process`, `App`, and `Index` bindings refresh imports the resource but does not hand-write the rich solution-level files — check the output and hand-author missing files per [capabilities/process/solution-files.md](capabilities/process/solution-files.md).
|
|
60
|
+
8. **`uip solution resources list` returns identity only (Source/Key/Name/Type/Folder/FolderKey)** — for the full configuration run `uip solution resources get <KEY> --output json` and read `Data.spec`. Applies to `--kind Process` (argument schemas, package keys, entry-point IDs — see [capabilities/process/process.md § Discovery](capabilities/process/process.md#discovery)) and `--kind Index` (data source type, storage bucket reference — see [capabilities/context/index.md § Discovery](capabilities/context/index.md#discovery)).
|
|
61
61
|
9. **Do not copy-paste UUIDs from one resource to another** — every resource (including each guardrail) needs a unique UUID.
|
|
62
62
|
10. **Do not bump `storageVersion` manually** — breaks packager compatibility.
|
|
63
63
|
11. **Do not call raw Automation.Solutions REST APIs** — always use `uip solution` commands.
|
|
@@ -66,11 +66,11 @@ These rules are the canonical source for low-code agent authoring. Capability fi
|
|
|
66
66
|
14. **Do not omit discriminator fields in guardrails** — every action needs `$actionType` (not `type`), every validator parameter needs `$parameterType` and `id` (not `name`), every custom rule needs `$ruleType`, every field selector needs `$selectorType`. Missing any discriminator causes `uip agent validate` to fail.
|
|
67
67
|
15. **Do not use lowercase scope values in guardrails** — use `"Agent"`, `"Llm"`, `"Tool"` (PascalCase), not `"agent"`, `"llm"`, `"tool"`.
|
|
68
68
|
16. **Always include `"guardrail": { "policies": [] }` in every tool resource.json, and never populate `policies` with entries** — the field must be present for backward-compatible solution loading; omitting it causes the runtime to fail. All guardrails are configured at the agent.json root `guardrails` array with `selector.scopes` and `selector.matchNames`.
|
|
69
|
-
17. **Do not expect `uip solution
|
|
69
|
+
17. **Do not expect `uip solution resources refresh` to wire non-StorageBucket index data sources** — GoogleDrive/OneDrive/Dropbox/Confluence/Attachments indexes, `attachments` contexts, and `datafabricentityset` contexts are not auto-generated. Refresh warns + skips them; any solution-level files for these must be hand-authored. See [capabilities/context/index.md](capabilities/context/index.md).
|
|
70
70
|
18. **Do not add a Tool-scoped guardrail before the tool exists** — run `uip agent tool list` first and confirm every name in `selector.matchNames` is present. `uip agent validate` will fail with an error if a guardrail targets a tool that has not been added to the agent.
|
|
71
|
-
19. **Set `folderPath` on process tool resources to the literal `Folder` from `uip solution
|
|
72
|
-
20. **Do not hand-edit `bindings_v2.json`** — the file is generated by `uip agent
|
|
71
|
+
19. **Set `folderPath` on process tool resources to the literal `Folder` from `uip solution resources list`** — applies whether `Source` is `Local` or `Remote`. `uip agent validate` reads it from the agent-level `resource.json` during the schema check; `uip agent refresh` propagates it verbatim into `bindings_v2.json`. The same value goes into the matching solution-level process declaration's `folders[].fullyQualifiedName`.
|
|
72
|
+
20. **Do not hand-edit `bindings_v2.json`** — the file is generated by `uip agent refresh` from the agent-level `resource.json` (including `folderPath`). Edit `resource.json` and re-run refresh; never patch the binding directly.
|
|
73
73
|
21. **Do not pass attachments via the `uip` CLI** — runtime file inputs are not supported by `uip agent run` or solution-level CLI run paths. Test attachment-aware agents from Studio Web or via Orchestrator job invocation.
|
|
74
74
|
22. **Do not assume `{{input.<job-attachment>}}` lets the agent read the file** — it renders metadata only. Pair the file field with a file-handling built-in tool (e.g. `analyze-attachments`) so the agent has a way to read contents.
|
|
75
|
-
23. **Do not run final inline-agent
|
|
76
|
-
24. **Do not hand-edit memory feature files for routine changes** — use `uip agent memory add/list/remove` and `uip agent memory item add/list/remove`. Hand-writing `features/{Name}/feature.json
|
|
75
|
+
23. **Do not run final inline-agent refresh or validation before flow graph edits for inline-in-flow agents** — direct `.flow` authoring of the inline-agent node, capability-resource nodes, and edges is owned by the `uipath-maestro-flow` skill. Always run `uip agent refresh --inline-in-flow --bindings-target <FlowProjectDir>/bindings_v2.json` and then `uip agent validate --inline-in-flow` **after** those flow graph edits are complete. Refresh is what propagates the inline agent's bindings into the flow project's `bindings_v2.json`; without it, `uip solution resources refresh` cannot discover them. Never hand-edit `bindings_v2.json`. See [capabilities/inline-in-flow/inline-in-flow.md](capabilities/inline-in-flow/inline-in-flow.md).
|
|
76
|
+
24. **Do not hand-edit memory feature files for routine changes** — use `uip agent memory add/list/remove` and `uip agent memory item add/list/remove`. Hand-writing `features/{Name}/feature.json` or `bindings_v2.json` can desynchronize generated state and skip CLI validation for search mode, field weights, metadata JSON, and memory item type.
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# Debug a Low-Code Agent
|
|
2
|
+
|
|
3
|
+
Run a low-code agent end-to-end on Studio Web and stream the result — without publishing it to Orchestrator. Use this to test an agent against real inputs during iteration. `uip agent debug` **uploads the agent's enclosing solution** to Studio Web, starts it on the serverless debug runtime, polls to completion, and returns the agent's output.
|
|
4
|
+
|
|
5
|
+
## Pre-flight
|
|
6
|
+
|
|
7
|
+
1. **Logged in.** `uip login status --output json` returns success.
|
|
8
|
+
2. **Solution resources refreshed — only if the agent has solution-level bindings.** If it uses external process/IS tools, index contexts, memory spaces, or escalations, refresh first so those declarations stay in sync with its bindings. Agents with only built-in tools (or no resources) don't need this (see [critical-rules.md](critical-rules.md) Rule 21):
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
uip solution resources refresh --solution-folder <SOLUTION_DIR> --output json
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Consent gate
|
|
15
|
+
|
|
16
|
+
`uip agent debug` **executes the agent for real** — it calls its tools, escalations, and external APIs, and consumes model tokens. It also overwrites the agent's Studio Web solution. Per [critical-rules.md](critical-rules.md) Rule 8 (consent before upload/publish/deploy — debug uploads), confirm with the user before running it.
|
|
17
|
+
|
|
18
|
+
## Debug — controlled end-to-end run
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
uip agent debug <AGENT_PROJECT_DIR> --inputs '<json>' --output json
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
The argument is the agent **project directory** (the folder with `agent.json` / `project.uiproj`), inside its solution. The command uploads the enclosing solution and runs it — there is **no separate `uip solution upload` step**.
|
|
25
|
+
|
|
26
|
+
- `--inputs '<json>'` — the agent's input object, matching its `inputSchema` (e.g. `'{"input":"What is 2+2?"}'`). Omit for empty input.
|
|
27
|
+
- `--timeout <seconds>` / `--poll-interval <ms>` — wait budget and polling cadence; the command polls until a terminal state.
|
|
28
|
+
|
|
29
|
+
State changes (`Pending → Running → Successful`) stream to stderr while it waits.
|
|
30
|
+
|
|
31
|
+
Every debug run re-uploads the local solution, so the debugged copy always reflects your local edits — there is no "debug the cloud version" mode (if you don't have it locally, `uip solution download` first).
|
|
32
|
+
|
|
33
|
+
## Report the result
|
|
34
|
+
|
|
35
|
+
On success the envelope is `Code: "AgentDebug"` with `Data`:
|
|
36
|
+
|
|
37
|
+
| Field | Meaning |
|
|
38
|
+
|---|---|
|
|
39
|
+
| `State` | terminal job state (`Successful`) |
|
|
40
|
+
| `Output` | the agent's output object |
|
|
41
|
+
| `TraceId` | execution trace id — use to inspect the run |
|
|
42
|
+
| `JobKey` | the debug job key |
|
|
43
|
+
|
|
44
|
+
Show the user the `Output` and the `TraceId`.
|
|
45
|
+
|
|
46
|
+
A run that ends `Faulted` / `Stopped` returns `Result: "Failure"` (exit 1). The terminal state alone often lacks a reason — inspect the trace:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
uip traces spans get <TraceId> --output json
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Anti-patterns
|
|
53
|
+
|
|
54
|
+
- **Never use `uip agent debug` as a validation step.** Use `uip agent validate` for correctness; debug is for end-to-end execution.
|
|
55
|
+
- **Don't skip `uip solution resources refresh` before debug when the agent has solution-level bindings** (external tools, IS, indexes, memory spaces, escalations). Stale declarations cause runtime binding failures even when `agent.json` is correct. Agents with only built-in tools don't need it.
|
|
@@ -20,7 +20,7 @@ uip agent eval run results <run_id> --set "Default Evaluation Set" --only-failed
|
|
|
20
20
|
- Agent project initialized (`uip agent init <path>`)
|
|
21
21
|
- `entry-points.json` present (defines `input`/`output` schema that test case `--inputs`/`--expected` must conform to)
|
|
22
22
|
- `uip agent validate --output json` passes (validate also checks evals and evaluators)
|
|
23
|
-
- Agent
|
|
23
|
+
- Agent's solution uploaded to Studio Web (`uip solution upload`) — required for running evals (the Agent Runtime executes test cases in the cloud)
|
|
24
24
|
|
|
25
25
|
Local operations (managing evaluators, eval sets, test cases) do **not** require authentication or a cloud connection. Only `uip agent eval run *` commands require cloud connectivity.
|
|
26
26
|
|
|
@@ -61,7 +61,7 @@ CLI-added evaluators are written as `evaluator-<uuid8>.json` (first 8 hex chars
|
|
|
61
61
|
|--------|-------------------------------|------------------------------|
|
|
62
62
|
| Execution | Local Python process | Cloud-based via Agent Runtime |
|
|
63
63
|
| Auth required | Only for `--report` | Always (cloud execution) |
|
|
64
|
-
| Prerequisite | `entry-points.json` | `uip
|
|
64
|
+
| Prerequisite | `entry-points.json` | `uip solution upload` |
|
|
65
65
|
| Mocking | `@mockable()` decorator + declarative | Simulation instructions only |
|
|
66
66
|
| CLI prefix | `uip codedagent eval` | `uip agent eval` |
|
|
67
67
|
|
|
@@ -69,7 +69,7 @@ CLI-added evaluators are written as `evaluator-<uuid8>.json` (first 8 hex chars
|
|
|
69
69
|
|
|
70
70
|
| Error | Cause | Fix |
|
|
71
71
|
|-------|-------|-----|
|
|
72
|
-
| Solution ID could not be resolved | Agent not
|
|
72
|
+
| Solution ID could not be resolved | Agent's solution not uploaded to Studio Web | Run `uip solution upload . --output json` (add `--force` to replace an existing cloud solution), or pass `--solution-id <id>` explicitly to `uip agent eval run start` |
|
|
73
73
|
| `No evaluators found` | Empty `evals/evaluators/` directory | Run `uip agent eval evaluator add` or re-init with `uip agent init` |
|
|
74
74
|
| `No test cases in eval set` | Eval set has no evaluations | Run `uip agent eval add` to add test cases |
|
|
75
75
|
| `Unknown evaluator type "X"` | Wrong case on `--type` value | Use kebab-case only: `semantic-similarity`, `trajectory` |
|
|
@@ -79,12 +79,12 @@ CLI-added evaluators are written as `evaluator-<uuid8>.json` (first 8 hex chars
|
|
|
79
79
|
| Eval run timeout (with `--wait`) | Agent taking too long or stuck | Increase `--timeout` or check agent health in Studio Web. Note: this only stops the local CLI from blocking; the run continues server-side — query with `uip agent eval run status <run_id>` |
|
|
80
80
|
| Validate fails with eval errors | Eval set references an evaluator that no longer exists, OR evaluator JSON missing required field, OR `category`/`type` mismatch (see [evaluators.md](evaluators.md) § What `uip agent validate` Checks) | Re-run `uip agent eval evaluator list` and reconcile `evaluatorRefs`; fix per the validate error message |
|
|
81
81
|
|
|
82
|
-
The two model-resolution errors above are **runtime checks in the cloud eval worker**, not validate-time checks — `uip agent validate` will not catch them. They surface only after `uip agent eval run start`. To pre-empt them, inspect each evaluator's `model` field locally before
|
|
82
|
+
The two model-resolution errors above are **runtime checks in the cloud eval worker**, not validate-time checks — `uip agent validate` will not catch them. They surface only after `uip agent eval run start`. To pre-empt them, inspect each evaluator's `model` field locally before uploading.
|
|
83
83
|
|
|
84
84
|
## Anti-patterns
|
|
85
85
|
|
|
86
|
-
- **Don't run `uip agent eval run start` before `uip
|
|
87
|
-
- **Don't skip `uip agent validate` before
|
|
86
|
+
- **Don't run `uip agent eval run start` before `uip solution upload`.** The Agent Runtime executes against the uploaded agent. Local edits to `agent.json` after the last upload will not be reflected in the run.
|
|
87
|
+
- **Don't skip `uip agent validate` before upload.** Validate checks `evals/` and `evaluators/`; broken eval JSON will not block upload but will surface as runtime errors.
|
|
88
88
|
- **Don't hand-edit `id` or `evaluatorRefs` UUIDs.** Eval sets reference evaluators by UUID. Renaming an evaluator file or copy-pasting a UUID across evaluators silently breaks resolution.
|
|
89
89
|
- **Don't expect filenames to match `<name>`.** CLI-generated evaluator files use `evaluator-<uuid8>.json`, not `<name>.json`. Look up evaluators by the `name` field inside the JSON, not by filename.
|
|
90
90
|
- **Don't pass `--type` in PascalCase.** The CLI rejects `SemanticSimilarity`. Only kebab-case is accepted.
|
|
@@ -148,6 +148,6 @@ The `source` field indicates how the test case was created. CLI-added test cases
|
|
|
148
148
|
## Anti-patterns
|
|
149
149
|
|
|
150
150
|
- **Don't hand-write `evalSetId` or test case `id` UUIDs.** Use `uip agent eval add` so the CLI keeps `evaluations[].evalSetId` consistent with the parent eval set's `id`.
|
|
151
|
-
- **Don't add `--inputs` keys that are not in `entry-points.json`.** The runtime will reject the test case at execution time. Run `uip agent validate` to catch this before
|
|
151
|
+
- **Don't add `--inputs` keys that are not in `entry-points.json`.** The runtime will reject the test case at execution time. Run `uip agent validate` to catch this before upload.
|
|
152
152
|
- **Don't set `--expected '{}'` (empty) and `--expected-agent-behavior ""` together.** The semantic-similarity evaluator scores against an empty `{{ExpectedOutput}}`; the trajectory evaluator scores against an empty `{{ExpectedAgentBehavior}}`. Every run scores low for non-actionable reasons.
|
|
153
153
|
- **Don't set the `source` field manually.** Owned by CLI and Studio Web; hand-edits may be overwritten on the next sync.
|
|
@@ -17,7 +17,7 @@ How to add each type:
|
|
|
17
17
|
|
|
18
18
|
- **Studio Web UI** — Evaluators tab → **Create New** → Add evaluator dialog → pick any of the four. UI is the canonical surface and supports all four with no special steps.
|
|
19
19
|
- **CLI** — `uip agent eval evaluator add <name> --type <flag>` for `semantic-similarity` or `trajectory`. The CLI does not have a `--type` value for Exact match or JSON similarity; create those in the UI or hand-write the JSON.
|
|
20
|
-
- **Hand-write JSON** — drop a file in `evals/evaluators/` matching the schema below; run `uip agent
|
|
20
|
+
- **Hand-write JSON** — drop a file in `evals/evaluators/` matching the schema below; run `uip agent refresh --output json` then `uip agent validate --output json` to confirm schema validity; reference the new `id` from your eval set's `evaluatorRefs`. Useful when you want to pin a specific model and prompt for the LLM-based types, or when you're scaffolding eval files programmatically.
|
|
21
21
|
|
|
22
22
|
### Why fewer than coded?
|
|
23
23
|
|
|
@@ -108,7 +108,7 @@ The CLI's `evaluator add --type semantic-similarity` writes a shorter prompt; ha
|
|
|
108
108
|
}
|
|
109
109
|
```
|
|
110
110
|
|
|
111
|
-
After hand-writing any evaluator, run `uip agent
|
|
111
|
+
After hand-writing any evaluator, run `uip agent refresh --output json` then `uip agent validate --output json` to confirm the file passes schema validation. Then reference the new evaluator's `id` from your eval set's `evaluatorRefs`. Watch for: `id` collisions with existing evaluators, missing required fields, and ISO-8601 formatting on the timestamps.
|
|
112
112
|
|
|
113
113
|
## Coded-only evaluators (NOT available on low-code)
|
|
114
114
|
|
|
@@ -261,7 +261,7 @@ These errors surface only after `uip agent eval run start` — `uip agent valida
|
|
|
261
261
|
| `Evaluator '<id>' is an LLM-based evaluator but 'model' is not set in its evaluatorConfig. Specify a valid model name (e.g. 'claude-haiku-4-5-20251001').` | Evaluator JSON has empty/missing `model` (and is not `same-as-agent`). The worker fail-fasts before calling the LLM gateway. | Set `model` in the evaluator JSON to a model available in your tenant, or set `"model": "same-as-agent"` and ensure `agent.json` has a model. |
|
|
262
262
|
| `'same-as-agent' model option requires agent settings. Ensure agent.json contains valid model settings.` | Evaluator uses `"same-as-agent"` but `agent.json` has no resolvable model. | Set `model` in `agent.json`, or override the evaluator with an explicit model. |
|
|
263
263
|
|
|
264
|
-
**Pre-empt locally:** before
|
|
264
|
+
**Pre-empt locally:** before upload, run
|
|
265
265
|
|
|
266
266
|
```bash
|
|
267
267
|
uip agent eval evaluator list --path ./my-agent --output json --output-filter '[?model==`""` || model==null]'
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Execute evaluations against the Agent Runtime, check status, view results, and compare runs.
|
|
4
4
|
|
|
5
|
-
All run commands require the agent to be
|
|
5
|
+
All run commands require the agent's solution to be uploaded to Studio Web first (`uip solution upload`). The Agent Runtime executes test cases in the cloud using the uploaded agent definition.
|
|
6
6
|
|
|
7
7
|
## Start an Eval Run
|
|
8
8
|
|
|
@@ -18,7 +18,7 @@ uip agent eval run start --set "<eval_set_name>" --path <agent_dir> --wait --out
|
|
|
18
18
|
| `--path <path>` | No | Agent project directory | `.` |
|
|
19
19
|
| `--wait` | No | Block until the run completes, then print results | `false` |
|
|
20
20
|
| `--timeout <seconds>` | No | Maximum time to block when `--wait` is set | `600` (10 min) |
|
|
21
|
-
| `--solution-id <id>` | No | Override solution ID for this run | Auto-resolved from the
|
|
21
|
+
| `--solution-id <id>` | No | Override solution ID for this run | Auto-resolved from the uploaded solution state |
|
|
22
22
|
|
|
23
23
|
Without `--wait`, the command returns immediately with `Code: AgentEvalRunStarted`:
|
|
24
24
|
|
|
@@ -174,8 +174,8 @@ uip agent eval add greeting-test \
|
|
|
174
174
|
# 2. Validate (catches schema drift, missing evaluator refs, broken eval JSON)
|
|
175
175
|
uip agent validate --path ./my-agent --output json
|
|
176
176
|
|
|
177
|
-
# 3.
|
|
178
|
-
uip
|
|
177
|
+
# 3. Upload the agent's solution to Studio Web (required before running evals)
|
|
178
|
+
uip solution upload . --output json # add --force to replace an existing cloud solution
|
|
179
179
|
|
|
180
180
|
# 4. Run and wait
|
|
181
181
|
uip agent eval run start \
|
|
@@ -189,9 +189,9 @@ uip agent eval run results <run_id> \
|
|
|
189
189
|
--only-failed --verbose \
|
|
190
190
|
--path ./my-agent --output json
|
|
191
191
|
|
|
192
|
-
# 6. Make changes, validate,
|
|
192
|
+
# 6. Make changes, validate, re-upload, re-run, compare
|
|
193
193
|
uip agent validate --path ./my-agent --output json
|
|
194
|
-
uip
|
|
194
|
+
uip solution upload . --force --output json # --force replaces the existing cloud solution in place
|
|
195
195
|
uip agent eval run start --set "Default Evaluation Set" --path ./my-agent --wait --output json
|
|
196
196
|
uip agent eval run compare <new_run_id> --compare-to <old_run_id> \
|
|
197
197
|
--set "Default Evaluation Set" --path ./my-agent --output json
|
|
@@ -199,9 +199,9 @@ uip agent eval run compare <new_run_id> --compare-to <old_run_id> \
|
|
|
199
199
|
|
|
200
200
|
## Anti-patterns
|
|
201
201
|
|
|
202
|
-
- **Don't run `eval run start` without `uip
|
|
202
|
+
- **Don't run `eval run start` without `uip solution upload` first.** The Agent Runtime executes against the uploaded agent, not local files. Local edits made after the last upload will not affect results.
|
|
203
203
|
- **Don't assume `--timeout` cancels the server-side run.** It only stops the local CLI from blocking. The run continues and can be inspected with `run status`.
|
|
204
|
-
- **Don't skip `uip agent validate` between edits and
|
|
204
|
+
- **Don't skip `uip agent validate` between edits and upload.** Validate catches eval-set / evaluator drift that upload will accept silently and the runtime will reject.
|
|
205
205
|
- **Don't compare runs from different eval sets.** `compare` aligns by test case `name` within the eval set; cross-set deltas are meaningless.
|
|
206
206
|
- **Don't rely on `Score` alone — inspect `EvaluatorScores`.** A 0.86 aggregate can mask a faithful-but-wrong agent (high semantic, low trajectory). Use `--verbose` to read justifications when scores look surprising.
|
|
207
207
|
- **Don't mix score scales across evaluators in the same eval set.** Defaults written by `uip agent init` use 0–100 prompts; defaults written by `evaluator add` use 0–1 prompts. The runtime DTO normalizes to 0–100, but mixed-scale prompts produce confusing per-evaluator scores. Decide on one scale per eval set and edit prompts to match.
|
|
@@ -6,22 +6,23 @@ Entry point for low-code agent work. Read this first after low-code mode is dete
|
|
|
6
6
|
|
|
7
7
|
- Create a new low-code agent project (standalone or inline in a flow)
|
|
8
8
|
- Edit `agent.json` — prompts, model, schemas, settings
|
|
9
|
-
- Add tools, contexts, or
|
|
9
|
+
- Add tools, contexts, escalations, or MCP servers as files in `resources/{Name}/resource.json`
|
|
10
10
|
- Add memory spaces or seed memory items with `uip agent memory`
|
|
11
11
|
- Wire agent-to-agent calls within a solution or to an external deployed agent
|
|
12
12
|
- Design input/output schemas and sync with `entry-points.json`
|
|
13
13
|
- Validate agent project structure
|
|
14
14
|
- Publish agent to Studio Web, pack and deploy to Orchestrator
|
|
15
|
+
- Debug / run a low-code agent end-to-end on Studio Web and inspect its output
|
|
15
16
|
|
|
16
17
|
## Critical Rules
|
|
17
18
|
|
|
18
19
|
[critical-rules.md](critical-rules.md) is the canonical source for low-code agent rules and anti-patterns. Read it every session. The rules below are the operational must-knows; the rest live in the canonical file.
|
|
19
20
|
|
|
20
|
-
1. **Edit JSON files directly, except CLI-managed memory features.** The CLI provides `init` (scaffold), `
|
|
21
|
+
1. **Edit JSON files directly, except CLI-managed memory features.** The CLI provides `init` (scaffold), `refresh` (apply migrations + regenerate derived files), `validate` (strict read-only check), and `memory` (writes memory feature files). Resources live in `resources/{Name}/resource.json`; memory features live in `features/{Name}/feature.json`.
|
|
21
22
|
2. **Use `--output json`** on every `uip` command.
|
|
22
|
-
3. **
|
|
23
|
-
4. **Keep `agent.json`
|
|
24
|
-
5. **
|
|
23
|
+
3. **Refresh and validate after every bulk of related edits**, not after each line. Run `uip agent refresh --output json` to apply pending migrations and regenerate `entry-points.json` and `bindings_v2.json`, then `uip agent validate --output json` to verify the project is clean.
|
|
24
|
+
4. **Keep `agent.json` schemas correct** — `uip agent refresh` regenerates `entry-points.json` from `agent.json`'s `inputSchema`/`outputSchema` automatically.
|
|
25
|
+
5. **Do not manually edit `entry-points.json` or `bindings_v2.json`** — they are generated by `uip agent refresh`. Edit source files and re-run refresh.
|
|
25
26
|
6. **Do not publish or deploy without user consent.** Ask before `uip solution upload`, `publish`, or `deploy`.
|
|
26
27
|
7. **Never invoke other skills automatically.** For Orchestrator setup, tell the user to use the `uipath-platform` skill; for flow wiring, tell them to use the `uipath-maestro-flow` skill.
|
|
27
28
|
|
|
@@ -32,10 +33,12 @@ Standard workflow for any low-code agent task:
|
|
|
32
33
|
1. **Scaffold** — `uip solution init` (if no solution exists), then `uip agent init "<AgentName>" --output json`. Full walkthrough in [project-lifecycle.md](project-lifecycle.md) § End-to-End Example.
|
|
33
34
|
2. **Edit** — open `agent.json` and `entry-points.json`. Schema reference in [agent-definition.md](agent-definition.md). **Override the scaffold model** (`gpt-4o-2024-11-20`) per [model-selection-guide.md](model-selection-guide.md) and write robust prompts per [agent-prompting-guide.md](agent-prompting-guide.md) — the scaffold ships a stale model and toy prompts.
|
|
34
35
|
3. **Add capabilities** — pick from the Capability Registry below. Most add `resources/{Name}/resource.json`; memory uses `uip agent memory` and writes `features/{Name}/feature.json`.
|
|
35
|
-
4. **
|
|
36
|
-
5. **
|
|
37
|
-
6. **Refresh solution resources** — `uip solution
|
|
38
|
-
7. **
|
|
36
|
+
4. **Refresh** — `uip agent refresh --output json`. Applies pending migrations and regenerates `entry-points.json` and `bindings_v2.json`. Confirm `MigrationApplied`, `StorageVersion`.
|
|
37
|
+
5. **Validate** — `uip agent validate --output json`. Strict read-only. Confirm `Status: "Valid"`, `Validated` counts.
|
|
38
|
+
6. **Refresh solution resources** — `uip solution resources refresh --output json` if any capability needs solution-level files (external tools, IS tools, index contexts, memory spaces, escalations).
|
|
39
|
+
7. **Upload** — `uip solution upload . --output json` (bundles and uploads in one pass; with user consent per Rule 6).
|
|
40
|
+
|
|
41
|
+
To **run the agent end-to-end** (test it live, not just upload), use `uip agent debug <AGENT_PROJECT_DIR> --inputs '<json>' --output json` — it uploads the enclosing solution and runs it on Studio Web in one step, so it's an alternative to the Upload step, not an addition. Executes the agent for real — confirm with the user first (Rule 6). See [debug.md](debug.md).
|
|
39
42
|
|
|
40
43
|
Capabilities are **orthogonal**: there is no ordering requirement among them. Adding a tool and an escalation in parallel is safe — they do not interact at the file level. Validate and refresh once after all capability edits are complete, not after each one.
|
|
41
44
|
|
|
@@ -46,10 +49,11 @@ Capabilities are **orthogonal**: there is no ordering requirement among them. Ad
|
|
|
46
49
|
| Read when... | File |
|
|
47
50
|
|---|---|
|
|
48
51
|
| Scaffolding, validating, or running solution lifecycle commands | [project-lifecycle.md](project-lifecycle.md) |
|
|
52
|
+
| Debugging / running a low-code agent end-to-end to test it | [debug.md](debug.md) |
|
|
49
53
|
| Editing `agent.json` (prompts, schemas, model, contentTokens) or `entry-points.json` | [agent-definition.md](agent-definition.md) |
|
|
50
54
|
| Choosing the LLM (`settings.model`) — discover tenant models, override the scaffold default | [model-selection-guide.md](model-selection-guide.md) |
|
|
51
55
|
| Writing a robust system/user prompt — skeleton, tool-call criteria, output contract, production checklist | [agent-prompting-guide.md](agent-prompting-guide.md) |
|
|
52
|
-
| External tools / IS tools / index contexts / memory spaces / escalations behave unexpectedly after `uip solution
|
|
56
|
+
| External tools / IS tools / index contexts / memory spaces / escalations behave unexpectedly after `uip solution resources refresh` | [solution-resources.md](solution-resources.md) |
|
|
53
57
|
| Running evaluations, adding test cases, managing evaluators | [evaluations/evaluate.md](evaluations/evaluate.md) |
|
|
54
58
|
|
|
55
59
|
### Capability Registry
|
|
@@ -62,11 +66,13 @@ Capabilities are **orthogonal**: there is no ordering requirement among them. Ad
|
|
|
62
66
|
| Add/remove input or output fields | [agent-definition.md](agent-definition.md) § entry-points.json | |
|
|
63
67
|
| Scaffold a new agent project | [project-lifecycle.md](project-lifecycle.md) § End-to-End Example | [agent-definition.md](agent-definition.md) |
|
|
64
68
|
| Validate, upload, pack, publish, or deploy | [project-lifecycle.md](project-lifecycle.md) | |
|
|
69
|
+
| Debug / run a low-code agent end-to-end | [debug.md](debug.md) | |
|
|
65
70
|
| Discover solution resources (processes/apps/indexes/buckets/connections) | [project-lifecycle.md](project-lifecycle.md) § Resource Discovery | |
|
|
66
71
|
| Add a tool — pick the right kind | [capabilities/process/process.md](capabilities/process/process.md) | applicable sibling |
|
|
67
72
|
| Add a process tool (RPA / agent / API / agentic) — local or external | [capabilities/process/process.md](capabilities/process/process.md) | [capabilities/process/solution-files.md](capabilities/process/solution-files.md) |
|
|
68
73
|
| Wire a multi-agent solution (parent + tool agents) | [capabilities/process/process.md](capabilities/process/process.md) § Multi-Agent Solution Example | |
|
|
69
74
|
| Add an Integration Service tool | [capabilities/integration-service/integration-service.md](capabilities/integration-service/integration-service.md) | |
|
|
75
|
+
| Add an MCP (Model Context Protocol) server tool | [capabilities/mcp/mcp.md](capabilities/mcp/mcp.md) | |
|
|
70
76
|
| Add a built-in tool (Analyze Files) | [capabilities/built-in-tools/built-in-tools.md](capabilities/built-in-tools/built-in-tools.md) | [capabilities/built-in-tools/analyze-attachments.md](capabilities/built-in-tools/analyze-attachments.md) |
|
|
71
77
|
| Accept a file as agent input or return a file as output | [agent-definition.md](agent-definition.md) § File Attachments | [capabilities/built-in-tools/built-in-tools.md](capabilities/built-in-tools/built-in-tools.md) |
|
|
72
78
|
| Add a context (Context Grounding / attachments / DataFabric) | [capabilities/context/context.md](capabilities/context/context.md) | applicable sibling |
|
|
@@ -85,7 +91,7 @@ Capabilities are **orthogonal**: there is no ordering requirement among them. Ad
|
|
|
85
91
|
See [critical-rules.md](critical-rules.md) § What NOT to Do for the canonical list. Most expensive to get wrong:
|
|
86
92
|
|
|
87
93
|
- Editing `content` without updating `contentTokens` (causes silent rendering failures)
|
|
88
|
-
- Skipping `uip solution
|
|
94
|
+
- Skipping `uip solution resources refresh` after adding external tools (`bindings_v2.json` never reaches the solution)
|
|
89
95
|
- Hand-editing memory feature JSON instead of using `uip agent memory`
|
|
90
96
|
- camelCasing `contextType` / `retrievalMode` enum values (validate accepts it, Studio Web silently drops the resource)
|
|
91
97
|
- Copy-pasting UUIDs across resources (every resource needs its own)
|
|
@@ -96,6 +102,6 @@ After completing a task, report:
|
|
|
96
102
|
|
|
97
103
|
1. **File paths** — which files were created or modified
|
|
98
104
|
2. **What was configured** — summary of agent settings and schemas
|
|
99
|
-
3. **Validation result** — output of `uip agent
|
|
105
|
+
3. **Validation result** — output of `uip agent refresh --output json` (`MigrationApplied`, `StorageVersion`) followed by `uip agent validate --output json` (`Status: "Valid"`, `Validated` counts)
|
|
100
106
|
4. **Schema sync status** — confirm agent.json and entry-points.json match
|
|
101
107
|
5. **Next steps** — suggest what the user should do next (publish, test in Studio Web, add resources)
|
|
@@ -59,11 +59,11 @@ If `uip agent model list` fails (not logged in, offline, command unavailable), p
|
|
|
59
59
|
|
|
60
60
|
## 5. Apply the choice
|
|
61
61
|
|
|
62
|
-
Edit `settings.model` (and `settings.maxTokens`) in `agent.json`, then
|
|
62
|
+
Edit `settings.model` (and `settings.maxTokens`) in `agent.json`, then refresh and validate:
|
|
63
63
|
|
|
64
64
|
1. Set `settings.model` to the discovered `Name`.
|
|
65
65
|
2. Set `settings.maxTokens` ≤ the model's `MaxTokens`.
|
|
66
|
-
3. `uip agent
|
|
67
|
-
4. `uip agent
|
|
66
|
+
3. `uip agent refresh --output json`
|
|
67
|
+
4. `uip agent validate --output json`
|
|
68
68
|
|
|
69
69
|
For inline-in-flow agents add `--inline-in-flow` to both commands. Full field reference: [agent-definition.md](agent-definition.md#change-model-settings).
|