Skip to main content
Glama
arpe-io

arpeio-mcp

Official
by arpe-io

fastbcp_preview_export

Read-onlyIdempotent

Preview a FastBCP export command without executing it. Shows the exact CLI command with passwords masked and auto-suggests parallelism method based on source database.

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
NameRequiredDescriptionDefault
outputYes
sourceYes
optionsNo
os_typeNoTarget operating system for command formattinglinux
config_fileNoPath to a YAML configuration file (--config parameter, requires FastBCP 0.30+)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
tipsNoSuggested next tool calls to resolve errors.
errorsNoField-level validation errors (status='error').
statusYes'ok' when the call succeeded; 'error' when the parameters failed validation or execution failed.
commandNoFull CLI argv with real credentials, ready to hand to the execute tool.
warningsNoVersion-compatibility warnings.
explanationNoHuman-readable summary of what the command does.
preview_onlyNoTrue when no binary is configured (execution unavailable).
command_stringNoThe argv joined into one command string (real credentials).
command_displayNoThe command with passwords masked, safe to show the user.
auto_parallelismNoParallelism method auto-suggested when none was given.
Behavior5/5

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

Annotations already indicate readOnlyHint=true and destructiveHint=false, but the description adds valuable context: it does NOT execute, shows masked passwords, and auto-suggests parallelism method. It also clarifies it does not test connectivity. No contradictions with annotations.

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?

The description is concise: only a few sentences, front-loading the core purpose and key behaviors. Every sentence adds value with no redundancy or unnecessary detail.

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?

Given the tool's complexity (nested objects, many parameters, sibling tools), the description covers the main points: what it does, what it doesn't do, auto-suggestion, and next steps. It could mention the output format (CLI command string), but overall it is sufficiently complete for a preview tool with good annotations and output schema.

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 40%, so many parameters have descriptions in the schema. The description adds only minimal parameter context (masked passwords, auto-suggestion of parallelism method). It does not significantly enhance understanding beyond the schema, warranting a baseline score of 3.

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?

The description clearly states the tool builds and previews a FastBCP export command without executing it, distinguishing it from the sibling tool fastbcp_execute_export. It uses specific verbs and identifies the resource (FastBCP export command), making the purpose unambiguous.

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?

The description explains when to use (before execution) and what the tool does not do (no connectivity test, no execution). It directs users to pass the command to fastbcp_execute_export after review. While it doesn't list all alternatives, the auto-suggestion hint provides context for when to use it over other tools.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/arpe-io/arpeio-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server