arpeio-mcp

Official

Overview Schema Source Related Servers Discussions Admin

fastbcp_preview_export

Read-onlyIdempotent

Build and preview a FastBCP export command without executing it; passwords are masked and parallelism is auto-suggested for review before execution.

Instructions

Build and preview a FastBCP export command WITHOUT executing it. Shows the exact CLI command with passwords masked. If no parallelism method is specified, one is auto-suggested based on the source database type. Does NOT test connectivity or execute the export. After reviewing, pass the command to fastbcp_execute_export.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`output`	Yes
`source`	Yes
`options`	No
`os_type`	No	Target operating system for command formatting	linux
`config_file`	No	Path to a YAML configuration file (--config parameter, requires FastBCP 0.30+)

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 passwords masked, safe to show the user.
`auto_parallelism`	No	Parallelism method auto-suggested when none was given.

Schema Changelog

Changes observed during successful MCP inspections.

Changed5 schema fields changedv0.3.5Sep 27, 2026

changedInput schema / properties / options / properties / log_level / enum

Previous value: -[
-  "Information",
-  "Debug"
-]New value: +[
+  "Information",
+  "Debug",
+  "Verbose"
+]

changedInput schema / properties / output / properties / bool_format / enum

Previous value: -[
-  "TrueFalse",
-  "OneZero",
-  "YesNo"
-]New value: +[
+  "automatic",
+  "true/false",
+  "1/0",
+  "t/f"
+]

changedInput schema / properties / output / properties / parquet_compression / enum

Previous value: -[
-  "None",
-  "Snappy",
-  "Gzip",
-  "Lz4",
-  "Lzo",
-  "Zstd"
-]New value: +[
+  "None",
+  "Snappy",
+  "Brotli",
+  "Gzip",
+  "Lz4",
+  "Lz4Raw",
+  "Zstd"
+]

changedInput schema / properties / source / properties / type / description

Previous value: -"Source database connection type (e.g., 'pgsql' for PostgreSQL, 'mssql' for SQL Server, 'oraodp' for Oracle, 'mysql' for MySQL)"New value: +"Source database connection type (e.g., 'pgsql' for PostgreSQL, 'mssql' for SQL Server, 'oraodp' for Oracle, 'mysql' for MySQL). ADBC types 'adbc_mssql' (1.0+), 'adbc_pgsql' (1.1+) and 'adbc_oracle' (1.2+) read the same databases through the Arpe ADBC drivers and write parquet output only."

changedInput schema / properties / source / properties / type / enum

Previous value: -[
-  "clickhouse",
-  "hana",
-  "mssql",
-  "msoledbsql",
-  "mysql",
-  "nzcopy",
-  "nzoledb",
-  "nzsql",
-  "odbc",
-  "oledb",
-  "oraodp",
-  "pgcopy",
-  "pgsql",
-  "teradata"
-]New value: +[
+  "clickhouse",
+  "hana",
+  "mssql",
+  "msoledbsql",
+  "mysql",
+  "nzcopy",
+  "nzoledb",
+  "nzsql",
+  "odbc",
+  "oledb",
+  "oraodp",
+  "pgcopy",
+  "pgsql",
+  "teradata",
+  "adbc_mssql",
+  "adbc_pgsql",
+  "adbc_oracle"
+]

Changed6 schema fields changedv0.3.2Jul 7, 2026

removedInput schema / properties / options / properties / batch_size

Removed value: -{
-  "description": "Batch size for export operations",
-  "type": "integer"
-}

removedInput schema / properties / options / properties / load_mode

Removed value: -{
-  "default": "Append",
-  "description": "How to handle existing output. Append: add to existing files. Truncate: overwrite existing output before writing.",
-  "enum": [
-    "Append",
-    "Truncate"
-  ],
-  "type": "string"
-}

removedInput schema / properties / options / properties / map_method

Removed value: -{
-  "default": "Position",
-  "description": "Column mapping method",
-  "enum": [
-    "Position",
-    "Name"
-  ],
-  "type": "string"
-}

changedInput schema / properties / options / properties / method / description

Previous value: -"Parallelism method. Ntile: even distribution on numeric key. DataDriven: distinct value partitions, works with any data type. Physloc: SQL Server physical location (no key needed). Ctid: PostgreSQL physical tuple ID (no key needed). Rowid: Oracle physical ROWID (no key needed). RangeId: numeric min/max range. Random: modulo-based approximate distribution. Timepartition: partition by time column (FastBCP 0.30+). NZDataSlice: Netezza native slicing. None: single-threaded. Call `fastbcp_suggest_parallelism` if unsure."New value: +"Parallelism method. Ntile: even distribution on numeric key. DataDriven: distinct value partitions, works with any data type. Physloc: SQL Server physical location (no key needed). Ctid: PostgreSQL physical tuple ID (no key needed). Rowid: Oracle physical ROWID (no key needed). RangeId: numeric min/max range. Random: modulo-based approximate distribution. Timepartition: partition by time column (FastBCP 0.30+). NZDataSlice: Netezza native slicing. None: single-threaded. Call `fastbcp_info` with action='parallelism' if unsure."

removedInput schema / properties / output / properties / storage_target

Removed value: -{
-  "default": "local",
-  "description": "Where to write output files. local: local filesystem. s3/s3compatible: Amazon S3 or compatible. azure_blob/azure_datalake: Azure storage. fabric_onelake: Microsoft Fabric. gcs: Google Cloud Storage. Cloud targets require a cloud_profile.",
-  "enum": [
-    "local",
-    "s3",
-    "s3compatible",
-    "azure_blob",
-    "azure_datalake",
-    "fabric_onelake",
-    "gcs"
-  ],
-  "type": "string"
-}

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "additionalProperties": true,
+  "properties": {
+    "auto_parallelism": {
+      "description": "Parallelism method auto-suggested when none was given.",
+      "type": "string"
+    },
+    "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 passwords 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.1/5.0

Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the safety profile is covered. The description adds real value beyond that: passwords are masked in the output, parallelism is auto-suggested when unspecified, and it does not touch the source system or test connectivity.

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

Conciseness4/5

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

Four short sentences, front-loaded with the core action and the 'WITHOUT executing' constraint. 'Does NOT test connectivity or execute the export' partially restates the opening clause, a minor redundancy.

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

Completeness4/5

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

An output schema exists, so return formatting need not be described, and the preview/execute handoff is made clear. Remaining gaps are secondary parameter behaviors (os_type, config_file, output directory handling) that an agent building the command might want.

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 only 40% across a deeply nested schema, so the description would need to compensate. It only touches two parameters indirectly — password masking (source.password) and auto-suggested method (options.method) — and says nothing about os_type, config_file, or the output/options objects. Baseline 3 for partial compensation.

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 ('Build and preview a FastBCP export command') plus the explicit scope boundary 'WITHOUT executing it.' That boundary alone distinguishes it from fastbcp_execute_export without opening either schema.

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

Usage Guidelines4/5

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

Explicitly names the follow-on tool ('pass the command to fastbcp_execute_export') and states what it does not do (no connectivity test, no execution). It does not, however, distinguish itself from the sibling preview tools (migratorxpress_preview_command, fasttransfer_preview_transfer, lakexpress_preview_command), leaving the agent to infer that 'FastBCP export' is the selector.

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

Deploy Server