Skip to content

GUI agent tools (gui-mcp)

Agent-callable tools the running bxp-gui exposes over localhost StreamableHTTP.

Tool What it does
get_state Read the live GUI state: loaded config path, unsaved-changes flag, run status, a diagnostics summary, and the active template. validation carries the same error/warning badges the user sees in the config tree — counts per severity plus the first findings with their config path and message. Use this to "see the screen" before acting.
edit_node Edit a scalar leaf in the loaded config. path is the list of keys/indices from the config root to the leaf; value is the new scalar. Routed through the same live, undoable edit action the UI uses. Blocked when the config was loaded with errors.
save Save the edited config back to disk (atomic + validated). Asks the user to confirm before writing. No-op when there are no unsaved changes. Refused while the config carries validation errors — the same block the toolbar SAVE button applies; call get_state and read validation to see them.
open_config Load a config file from disk into the editor, replacing the current one. path is an absolute filesystem path.
reload Reload the active config from disk, discarding unsaved edits. Fails when no config is open.
dry_run Run the conversion in dry-run mode (no output files written). Returns the run status and exit code.
full_run Run the full conversion, writing output files to the configured data_dir. Asks the user to confirm first.
delete_node Delete the config entry at path (the same action as the tree delete button). Asks the user to confirm. Blocked when the config was loaded with errors.
insert_node Insert a new entry into a container in the loaded config. path is the keys/indices to the CONTAINER (object or array); pass [] for the root object. For an object container pass key (the new property name); for an array omit key to append or pass index for the position. value is the new entry (scalar, object, or array). Routed through the same live, undoable insert the UI uses. Blocked when the config was loaded with errors.
rename_key Rename the object key at path to new_key (the same action as the tree rename). path ends at the property being renamed. Blocked when the config was loaded with errors.
move_node Reorder the entry at path among its siblings by delta (+1 = down/later, -1 = up/earlier). Works for both object properties and array elements. Blocked when the config was loaded with errors.
set_template Set the active conversion template that dry_run / full_run target. Pass an empty string to run ALL templates. Returns the available template ids so the agent can pick a valid one.
get_row_detail Drill into one input row of the most recent run: its source field values, every input_schema/row_rules variable evaluation (value or error), the rule-match decisions, and any output rows produced. file_row is the 1-based source line number (as reported in the trace); file optionally disambiguates by path or template when the run spanned several files. Requires a prior dry_run / full_run.
get_trace Summarise the most recent dry/full run captured via btrace: per-file row counts + file_end stats, total traced rows, exit code, and any parse issues. trace is null when no run has happened yet.
exit Quit the bxp-gui application. Asks the user to confirm.