Skip to main content
Glama
trustxai
by trustxai

airbyte_list_connections

Read-onlyIdempotent

List data pipeline connections between sources and destinations to view their status, schedule, and streams for auditing or finding specific connection IDs.

Instructions

List connections (source-to-destination pipelines) in Airbyte.

A connection is the core Airbyte concept: it links a source to a destination, defines which streams to sync, the sync schedule (cron or basic), namespace mapping, and the sync mode per stream. Think of it as a "pipeline definition."

When to Use: - Discover which pipelines exist and their current status (active, inactive, deprecated). - Find a connection's UUID so you can inspect its details or list its jobs. - Audit all pipelines in one or more workspaces.

When NOT to Use: - If you already have a connection ID, use airbyte_get_connection for full details including stream configuration. - To check if a pipeline is currently running or recently failed, use airbyte_list_jobs with the connection_id filter.

Returns: Paginated list of connections. Each entry includes: - name, connectionId (UUID), status, sourceId, destinationId, schedule (cron expression or basic timing), configured streams (first 10 names), namespaceDefinition.

Markdown format shows a heading per connection with bullet
fields. JSON format returns the raw API response array.

Pagination: Use limit (1–100, default 20) and offset (default 0).

Examples: List all connections in a workspace: params = { "workspace_ids": ["a1b2c3d4-..."] } List first 10 connections: params = { "limit": 10 } Include soft-deleted connections: params = { "include_deleted": true } Get raw JSON for scripting: params = { "response_format": "json" }

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?

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=true. The description adds behavioral context: pagination with limit/offset defaults, ability to include deleted connections, and response format options (markdown/json). No contradictions.

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 (definition, when to use/not use, return info, pagination, examples). It is concise yet comprehensive, with every sentence adding value. No fluff.

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 (multiple parameters, pagination, response formatting), the description covers purpose, parameters, behavior, and examples adequately. It lacks explicit error handling or empty result handling, but for a read-only list tool with good annotations, this is sufficient. The presence of an output schema (not shown) further reduces the need for return value details in the description.

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?

The input schema's top-level 'params' parameter lacks a description, resulting in 0% schema coverage. However, the tool description compensates by explaining each sub-parameter (workspace_ids, limit, offset, include_deleted, response_format) with defaults and usage examples. While the schema's inner descriptions are good, the description adds contextual guidance (e.g., 'Omit to list across all allowed workspaces').

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 lists connections (source-to-destination pipelines) and defines the concept. It distinguishes from siblings like airbyte_get_connection for a single connection and airbyte_list_jobs for checking runs, 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 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, suggesting specific scenarios like discovering pipelines or finding UUIDs, and directs to alternatives (e.g., airbyte_get_connection for details, airbyte_list_jobs for running status).

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