Skip to main content
Glama
aetperf

io.github.arpe-io/fastbcp-mcp

by aetperf

preview_export_command

Build and preview a FastBCP export command without executing it, showing the exact command with passwords masked. Use this before any export to verify configuration.

Instructions

Build and preview a FastBCP export command WITHOUT executing it. This shows the exact command that will be run, with passwords masked. Use this FIRST before executing any 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+)
Behavior4/5

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

Without annotations, the description carries the full burden and discloses that the tool does not execute, shows the exact command with passwords masked. This is appropriate for a preview tool, though it could mention that it requires valid connection parameters to generate the command.

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 three sentences long, with the most critical information (builds and previews without executing) first. Every sentence adds value without redundancy or waste.

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

Completeness3/5

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

Given the complexity of the input schema (nested objects, 5 parameters, no output schema, no annotations), the description is somewhat sparse. It adequately conveys the core purpose and usage direction but does not detail how the preview handles complex configurations like the config file or options, leaving some gaps for a complete understanding.

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

Parameters2/5

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

Schema description coverage is only 40%, meaning many parameters lack adequate schema descriptions. The tool description does not add any parameter-specific semantics; it only mentions command preview and password masking. This is a missed opportunity to elaborate on key parameters like source, output, or options.

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 it builds and previews a FastBCP export command without executing it. It distinguishes itself from the sibling 'execute_export' tool by explicitly stating it does not execute, making the purpose specific and 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 explicitly advises to 'Use this FIRST before executing any export,' providing clear usage context for safe exploration. While it doesn't explicitly list when not to use, the sibling tool 'execute_export' serves as the alternative for actual execution, offering implicit guidance.

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/aetperf/fastbcp-mcp'

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