docs(uipath-maestro-flow): refresh validate error quality#640
Conversation
flow-workbench [#1479](UiPath/flow-workbench#1479) and cli [#1896](UiPath/cli#1896) materially sharpen the diagnostics that `uip maestro flow validate` emits. Two updates so the skill no longer describes the pre-fix behaviour: 1. **`editing-operations-json.md` + `file-format.md`** — `sourceHandle`-vs- `sourcePort` and missing-`targetPort` mistakes were previously called out as producing a "vague root error". Post-fix, the validator returns the precise edge path (`[error] [edges[N].sourcePort] expected string, received undefined`), so the gotchas now describe the real path the agent sees and reinforce that the path identifies the offending edge entry exactly. 2. **`failure-modes.md` — "validate passes, debug faults"** — the "connector input fields with hand-written `inputs.detail` (missing `essentialConfiguration` block)" failure mode was incorrectly listed as a debug-only fault. The IS SDK's `validateConfiguration` rule has always caught the structural cases (empty configuration, missing envelope, invalid JSON) at validate time; cli #1896 also adds shape hints pointing at `uip maestro flow node configure`. Move that family into a new "structural rules **do** catch" section so agents look at the validate output (not `flow debug`) for those titles. No CLI flow / behavior change required of skill consumers — these are documentation-fidelity edits that align the diagnostic phrasings with what the validator actually emits today.
|
Claude finished @tmatup's task in 1m 31s —— View job PR Review: docs(uipath-maestro-flow): refresh validate error quality
SummaryUpdates three Change-by-Change Review1.
|
| Area | Status | Notes |
|---|---|---|
| Frontmatter | OK | Not touched — no changes needed |
| E2E Tests | OK | Doc-only change; no new CLI workflows introduced |
| Skill Body | OK | Not touched |
| References & Assets | OK | All three changed files are accurate and internally consistent |
| Repo Hygiene | OK | No cross-skill refs, no secrets, no personal paths, changes scoped to one skill |
Issues for Manual Review
- Verify the exact error message format emitted by cli #1896 matches what's documented (specifically whether the
Invalid input:prefix is present in the[edges[N].*]messages — this reviewer cannot run the CLI to confirm).
Conclusion
Clean, well-scoped PR. All three changes correctly align documentation with the new structured error output from the validator. No issues found that would block merge.
…gotchas Address github-actions[bot] PR #640 review (Severity: Low) — the two edge-port gotchas in file-format.md quoted the Zod error as bare `expected string, received undefined`, while editing-operations-json.md and the actual runtime output carry the `Invalid input:` prefix that Zod 4 emits. Harmonize the wording so agents pattern-match the same string across both files. Pre-existing inconsistency (predates this PR's earlier commits) but a trivial edit to land alongside.
Review Response1. No change required — bot rated OK. The new wording precisely describes what the validator now emits post-cli #1896. 2. No change required — bot rated OK. The structural rules subsection correctly enumerates the three cases the IS SDK already catches at validate time. 3. No change required — bot rated OK on the bracket fix. 4. Minor inconsistency: Fixed in cde8f5f. Both gotchas in 🤖 Generated with Claude Code Co-Authored-By: Claude noreply@anthropic.com |
Summary
Two documentation-fidelity updates so the
uipath-maestro-flowskill stops describing pre-fixuip maestro flow validatebehaviour. Pairs with:parseIssues+ JSON parse line:colChanges
1.
sourceHandle/sourcePortandtargetPort"vague root error" wordingediting-operations-json.mdandfile-format.mdpreviously told the agent that writingsourceHandleinstead ofsourcePort(or omittingtargetPort) produces a "vague root-level errorInvalid input: expected string, received undefined". Post-fix the validator returns the precise edge path:The gotchas are rewritten to describe what the agent will actually see, and reinforce that the path identifies the offending edge entry exactly.
2.
failure-modes.md— "validate passes, debug faults" listThe
connector inputs.detail (missing essentialConfiguration block)family was incorrectly listed as a debug-only fault. The IS SDK'svalidateConfigurationrule has always caught the structural cases (empty configuration, missing envelope, invalid JSON) at validate time; cli #1896 additionally appends shape hints pointing atuip maestro flow node configure.Reorganized the section so the "validate doesn't catch" list contains only items that genuinely manifest at debug time, plus a new "structural rules do catch (validate exits non-zero, with a shape hint)" subsection covering the connector configuration family. Agents that see one of those titles should now look at the validate output, not
flow debug.Test plan
🤖 Generated with Claude Code