Skip to main content
Glama
trustxai
by trustxai

airbyte_get_stream_properties

Read-onlyIdempotent

Discover available streams and their sync modes, cursor fields, and primary keys from a source connector to plan incremental syncs.

Instructions

Get the available streams and their properties for a source.

Returns the list of streams that the source connector can produce, along with each stream's supported sync modes, default cursor field, and source-defined primary key.

When to Use: - Before creating a connection, to discover which streams are available and which sync modes they support. - To verify that a source has the expected streams after configuration changes. - To find the right cursor field or primary key for incremental syncs.

When NOT to Use: - To see which streams are currently configured on a connection, use airbyte_get_connection instead.

Returns: List of streams with: name, namespace, sync modes, default cursor field, and primary key.

Examples: Basic usage: params = { "source_id": "a1b2c3d4-..." } With destination context and cache bypass: params = { "source_id": "a1b2c3d4-...", "destination_id": "e5f6g7h8-...", "ignore_cache": true }

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 provide readOnlyHint, idempotentHint, etc. The description adds context about cache bypass and destination-based refinement, which goes beyond annotations. 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.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Well-structured with sections, but slightly lengthy. Front-loaded with core purpose. Every sentence adds value, but could be more concise.

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 annotations and output schema (present), description covers return format, use cases, and examples. Fully adequate for a discovery tool.

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

Parameters3/5

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

Schema provides descriptions for all parameters (source_id, destination_id, ignore_cache). Description adds example usage but does not significantly deepen semantic understanding beyond schema. Baseline 3 due to high schema coverage.

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 the available streams and their properties for a source' and lists specific returned fields (sync modes, cursor field, primary key). This distinguishes it from siblings like airbyte_get_connection, which shows configured streams.

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?

Includes explicit 'When to Use' and 'When NOT to Use' sections. 'When NOT to Use' directs to airbyte_get_connection for configured streams, providing clear alternative.

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