Skip to main content
Glama
trustxai
by trustxai

airbyte_cancel_job

DestructiveIdempotent

Cancel a running sync or reset job in Airbyte. Sends a cancellation request that retains committed data while discarding in-flight data.

Instructions

Cancel a running sync or reset job.

Sends a cancellation request to the Airbyte API. The job will transition to 'cancelled' status. Already-committed data is retained; only in-flight data is discarded.

When to Use: - Stop a long-running or stuck sync. - Cancel an accidental reset.

Returns: The cancelled job's details.

Examples: params = { "job_id": "12345" }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

The description adds behavioral context beyond annotations: 'Sends a cancellation request... job transitions to cancelled status. Already-committed data retained; only in-flight data discarded.' Annotations (destructiveHint=true, idempotentHint=true) are consistent.

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 with front-loaded sections (behavior, when to use, returns, example). Every sentence adds value, no 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?

For a simple cancellation tool, the description covers purpose, behavior, usage, return value, and example. Output schema exists, so further return details are not needed.

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?

The input schema has two parameters (job_id with description, response_format with enum), but context signals 0% schema description coverage. The tool description only provides an example with job_id, adding minimal meaning beyond the schema.

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 explicitly states 'Cancel a running sync or reset job', using a clear verb and resource. It distinguishes itself from siblings (no other cancel tool) and aligns with the annotation title 'Cancel Airbyte Job'.

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 'When to Use' section lists two specific use cases (stop long-running/stuck sync, cancel accidental reset). It does not explicitly state when not to use or mention alternatives, but the context is sufficient for an agent.

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