arpeio-mcp

Official

Overview Schema Source Related Servers Discussions Admin

migratorxpress_preview_command

Read-onlyIdempotent

Build and preview a migration command without executing it. See the exact CLI command with passwords masked to review before execution.

Instructions

Build and preview a MigratorXpress migration command WITHOUT executing it. Shows the exact CLI command with passwords masked. Does NOT execute the migration or validate database connectivity. After reviewing, pass the command to migratorxpress_execute_command. Set upgrade_migdb=true (0.7.0+) to build the metadata-DB upgrade command instead (needs only auth_file and migration_db_auth_id).

Input Schema

TableJSON Schema

Name	Required	Description	Default
`force`	No	Force overwrite of existing migration data
`n_jobs`	No	Number of concurrent table transfers
`resume`	No	Resume a previous run by RUN_ID
`fk_mode`	No	How to handle foreign key constraints. trusted: create as trusted. untrusted: create and verify. disabled: skip FK creation.
`license`	No	License key (will be masked in display)
`log_dir`	No	Directory for log files
`os_type`	No	Target operating system for command formatting	linux
`p_query`	No	Parallelism degree for profiling queries
`project`	No	Project tag attached to this run, stored on the tracking tables for later filtering (0.6.30+)
`max_rows`	No	Maximum row count filter -- only migrate tables with at most this many rows
`min_rows`	No	Minimum row count filter -- only migrate tables with at least this many rows
`quiet_ft`	No	Suppress FastTransfer console output during data transfer
`auth_file`	Yes	Path to authentication/credentials JSON file
`load_mode`	No	How to load data into target tables. truncate: clear target before loading. append: add to existing data.
`log_level`	No	Logging verbosity level
`no_banner`	No	Suppress the startup banner
`task_list`	No	Tasks to run (e.g., ['translate', 'create', 'transfer'] for full migration, or ['diff'] for validation). Call `migratorxpress_info` with action='workflow' to get the recommended task sequence.
`basic_diff`	No	Use basic diff mode (row counts only, no checksum)
`no_progress`	No	Disable progress bar display
`without_xid`	No	Disable transaction ID tracking during transfer
`license_file`	No	Path to license key file
`aci_threshold`	No	Row count threshold for auto-created indexes on target
`cci_threshold`	No	Row count threshold for clustered columnstore index creation on target
`upgrade_migdb`	No	Upgrade the migration (tracking) DB metadata in place to the run_id schema introduced in 0.7.0, then exit (0.7.0+). Only auth_file and migration_db_auth_id are needed; cannot be combined with task_list or resume. Pre-0.7.0 tracking DBs are also auto-upgraded on the first regular 0.7.0+ run.
`compute_nbrows`	No	Compute row counts for source tables before transfer
`exclude_tables`	No	Table exclude patterns, comma-separated. Supports wildcards
`fasttransfer_p`	No	FastTransfer parallel degree (number of threads per table transfer)
`include_tables`	No	Table include patterns, comma-separated. Supports wildcards
`source_db_name`	No	Source database name to migrate from. Required before 0.7.2; deprecated and ignored from 0.7.2 (the source auth entry's database is used)
`target_db_name`	No	Target database name to migrate to. Required before 0.7.2; optional from 0.7.2, where it defaults to the target auth entry's database and must match it
`ft_large_table_th`	No	Row count threshold above which FastTransfer parallelism is used
`migration_db_mode`	No	How to handle existing target database objects. preserve: keep existing objects. truncate: empty tables before loading. drop: drop and recreate objects.
`source_db_auth_id`	No	Source database credential ID from the auth file
`target_db_auth_id`	No	Target database credential ID from the auth file
`source_schema_name`	No	Source schema name. If omitted, all schemas are migrated
`target_schema_name`	No	Target schema name. Defaults to source schema name if omitted
`profiling_sample_pc`	No	Percentage of rows to sample for data profiling (0-100)
`migration_db_auth_id`	Yes	Migration tracking database credential ID from the auth file
`drop_tables_if_exists`	No	Drop target tables before creating them. Before 0.7.2 any value, including 'false', is read as true: omit it instead of passing 'false'
`fasttransfer_dir_path`	No	Path to FastTransfer binary directory for parallel data transfer
`min_sample_pc_profile`	No	Minimum sample percentage for profiling small tables
`forced_int_id_prefixes`	No	Column name prefixes to force integer identity mapping
`forced_int_id_suffixes`	No	Column name suffixes to force integer identity mapping

Output Schema

TableJSON Schema

Name	Required	Description
`tips`	No	Suggested next tool calls to resolve errors.
`errors`	No	Field-level validation errors (status='error').
`status`	Yes	'ok' when the call succeeded; 'error' when the parameters failed validation or execution failed.
`command`	No	Full CLI argv with real credentials, ready to hand to the execute tool.
`warnings`	No	Version-compatibility warnings.
`explanation`	No	Human-readable summary of what the command does.
`preview_only`	No	True when no binary is configured (execution unavailable).
`command_string`	No	The argv joined into one command string (real credentials).
`command_display`	No	The command with the license key masked, safe to show the user.

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedv0.3.6Oct 18, 2026

changedInput schema / properties / drop_tables_if_exists / description

Previous value: -"Drop target tables before creating them"New value: +"Drop target tables before creating them. Before 0.7.2 any value, including 'false', is read as true: omit it instead of passing 'false'"

changedInput schema / properties / source_db_name / description

Previous value: -"Source database name to migrate from"New value: +"Source database name to migrate from. Required before 0.7.2; deprecated and ignored from 0.7.2 (the source auth entry's database is used)"

changedInput schema / properties / target_db_name / description

Previous value: -"Target database name to migrate to"New value: +"Target database name to migrate to. Required before 0.7.2; optional from 0.7.2, where it defaults to the target auth entry's database and must match it"

Changed3 schema fields changedv0.3.5Sep 27, 2026

addedInput schema / properties / project

Added value: +{
+  "description": "Project tag attached to this run, stored on the tracking tables for later filtering (0.6.30+)",
+  "pattern": "^[A-Za-z0-9_-]{1,64}$",
+  "type": "string"
+}

addedInput schema / properties / upgrade_migdb

Added value: +{
+  "default": false,
+  "description": "Upgrade the migration (tracking) DB metadata in place to the run_id schema introduced in 0.7.0, then exit (0.7.0+). Only auth_file and migration_db_auth_id are needed; cannot be combined with task_list or resume. Pre-0.7.0 tracking DBs are also auto-upgraded on the first regular 0.7.0+ run.",
+  "type": "boolean"
+}

changedInput schema / required

Previous value: -[
-  "auth_file",
-  "source_db_auth_id",
-  "source_db_name",
-  "target_db_auth_id",
-  "target_db_name",
-  "migration_db_auth_id"
-]New value: +[
+  "auth_file",
+  "migration_db_auth_id"
+]

Changed2 schema fields changedv0.3.2Jul 7, 2026

changedInput schema / properties / task_list / description

Previous value: -"Tasks to run (e.g., ['translate', 'create', 'transfer'] for full migration, or ['diff'] for validation). Call migratorxpress_suggest_workflow to get the recommended task sequence."New value: +"Tasks to run (e.g., ['translate', 'create', 'transfer'] for full migration, or ['diff'] for validation). Call `migratorxpress_info` with action='workflow' to get the recommended task sequence."

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "additionalProperties": true,
+  "properties": {
+    "command": {
+      "description": "Full CLI argv with real credentials, ready to hand to the execute tool.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "command_display": {
+      "description": "The command with the license key masked, safe to show the user.",
+      "type": "string"
+    },
+    "command_string": {
+      "description": "The argv joined into one command string (real credentials).",
+      "type": "string"
+    },
+    "errors": {
+      "description": "Field-level validation errors (status='error').",
+      "items": {
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "explanation": {
+      "description": "Human-readable summary of what the command does.",
+      "type": "string"
+    },
+    "preview_only": {
+      "description": "True when no binary is configured (execution unavailable).",
+      "type": "boolean"
+    },
+    "status": {
+      "description": "'ok' when the call succeeded; 'error' when the parameters failed validation or execution failed.",
+      "enum": [
+        "ok",
+        "error"
+      ],
+      "type": "string"
+    },
+    "tips": {
+      "description": "Suggested next tool calls to resolve errors.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "warnings": {
+      "description": "Version-compatibility warnings.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "status"
+  ],
+  "type": "object"
+}

First observedv0.3.1May 28, 2026

TDQS

A4.7/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnly/idempotent/non-destructive, but the description adds concrete behavior beyond them: passwords are masked in output, no execution or connectivity validation occurs, and upgrade_migdb cannot be combined with task_list or resume. These are actionable constraints an agent cannot derive from structured fields alone.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four tight sentences, front-loaded with what the tool does and immediately followed by its boundaries and the handoff to the execute tool. No filler; every clause carries routing or constraint information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, return values need not be described, and the description covers the key edge cases (masking, no execution, upgrade mode constraints). For a 43-param preview tool whose schema is fully documented, nothing an agent needs to invoke it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% across 43 parameters, so the schema already documents each parameter's meaning. The description explains the upgrade_migdb flag's reduced parameter requirement, but that detail is also present in the schema, so it adds marginal value. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: builds and previews a MigratorXpress migration command without executing it. It explicitly distinguishes itself from migratorxpress_execute_command and clarifies scope ('Does NOT execute the migration or validate database connectivity'), so an agent can tell it apart from siblings immediately.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It names the alternative ('pass the command to migratorxpress_execute_command') and gives the condition that selects it (after reviewing). It also flags a special mode (upgrade_migdb=true) with its prerequisites, leaving little to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server