Skip to main content
Glama
trustxai
by trustxai

airbyte_get_connection

Read-onlyIdempotent

Retrieve full details of a single Airbyte connection by its UUID, including source and destination IDs, sync schedule, namespace mapping, and all configured streams with their sync modes.

Instructions

Get full details of a single connection by its UUID.

Returns the complete connection definition: source and destination IDs, sync schedule, namespace mapping, and the full list of configured streams with their sync modes. This is the most detailed view of a pipeline.

When to Use: - Inspect which streams a connection syncs and their modes (full_refresh, incremental, etc.). - Check the schedule (cron expression or basic interval). - Verify source/destination pairing for a known connection. - Debug a pipeline by examining its full configuration.

When NOT to Use: - If you need to browse connections, use airbyte_list_connections. - To see run history (success/failure, bytes synced), use airbyte_list_jobs with connection_id or airbyte_get_job.

Returns: Connection details including: name, connectionId, status, sourceId, destinationId, schedule, namespaceDefinition, and configurations.streams (name + sync mode for each stream).

Markdown format renders a heading with bullet-point fields.
JSON format returns the full API response object.

Examples: Get connection by ID: params = { "connection_id": "a1b2c3d4-..." } Get raw JSON: params = { "connection_id": "a1b2c3d4-...", "response_format": "json" }

Error Handling: Returns a 404 message if the connection ID does not exist.

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?

Annotations already declare readOnlyHint=true and destructiveHint=false. Description adds behavioral details: returns the 'most detailed view', error handling (404 if not found), and response format options (markdown/json). No contradiction 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?

Well-organized with distinct sections (overview, when to use/not use, return details, examples, error handling). Each sentence is informative and there is no redundancy. Front-loaded with core purpose.

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 simplicity and existing output schema, the description covers all necessary context: what it returns (connection details, streams, sync modes), how to use it (examples with parameters), error behavior, and relationship to sibling tools.

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

Parameters4/5

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

Input schema has 1 required parameter (connection_id) with minimal description. The description adds meaning by explaining it as a UUID, providing examples of usage, and mentioning the optional response_format parameter with its two possible values and default.

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 'Get full details of a single connection by its UUID.' and defines the resource (connection) and action (get details). It distinguishes from siblings like airbyte_list_connections and airbyte_get_job.

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?

Explicit 'When to Use' and 'When NOT to Use' sections with clear alternatives (airbyte_list_connections, airbyte_get_job, airbyte_list_jobs). Provides specific use cases for inspection, debugging, and verification.

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