Skip to main content
Glama
trustxai
by trustxai

airbyte_trigger_sync

Trigger a sync or reset job for an Airbyte connection to replicate data from source to destination or clear and re-sync.

Instructions

Trigger a sync or reset job for a connection.

Starts a new job that replicates data from source to destination (sync) or clears destination data and re-syncs (reset).

When to Use: - Manually kick off a sync outside the regular schedule. - Trigger a reset after schema changes or data issues. - Automate syncs in response to upstream events.

When NOT to Use: - The connection is already running a sync (check with airbyte_list_jobs first). - If you need a non-destructive refresh (re-read without clearing the destination), use airbyte_trigger_refresh instead. Resets drop destination data first, which causes downtime; refreshes swap data only on success.

Returns: The newly created job with its jobId and initial status.

Examples: Trigger a sync: params = { "connection_id": "a1b2c3d4-..." } Trigger a reset: params = { "connection_id": "a1b2c3d4-...", "job_type": "reset" }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

The description explains that reset clears destination data and causes downtime, while sync does not. It states the return value (newly created job with jobId and initial status). Annotations already indicate readOnlyHint=false, and the description adds behavioral context beyond that.

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 well-structured with clear sections, examples, and warnings. Every sentence adds value; there is no redundancy or fluff.

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?

Given the tool's complexity (two job types, comparison to refresh), the description is very complete. It covers when to use, when not to use, behavioral effects, and return value. The presence of an output schema means return format details are already handled.

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

Parameters5/5

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

Although the input schema provides descriptions for job_type and connection_id, the description adds meaning by explaining the difference between sync and reset, and provides examples showing how to pass the parameters. The 'When NOT to Use' section also clarifies the job_type parameter's role in deciding between reset and refresh.

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 triggers a sync or reset job for a connection. It distinguishes between sync and reset, and also differentiates from the sibling tool airbyte_trigger_refresh, which is used for non-destructive refreshes.

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?

The description includes explicit 'When to Use' and 'When NOT to Use' sections. It advises against using when the connection is already running (and suggests checking with airbyte_list_jobs) and recommends airbyte_trigger_refresh for non-destructive refreshes instead of reset.

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/trustxai/airbyte-mcp'

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