Skip to main content
Glama
trustxai
by trustxai

airbyte_get_source_definition

Read-onlyIdempotent

Retrieve details of a specific source connector definition, including its name, Docker image, and connector specification. Use this to inspect what a source connector provides or check its Docker image version.

Instructions

Get details of a specific source connector definition.

Returns the full definition including name, Docker image, and connector specification.

When to Use: - Inspect what a specific source connector provides. - Check the Docker image version for a connector.

Examples: params = { "workspace_id": "...", "definition_id": "..." }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and idempotentHint=true, which cover the tool's safety profile. The description adds that it returns the 'full definition' with specific fields, providing some context about the response. However, it does not discuss error handling, pagination, or behavior on missing IDs. With annotations providing the core behavioral traits, the description adds moderate value.

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 three short sections: a clear opening sentence, a bulleted 'When to Use', and a code example. Every sentence serves a purpose, with no redundancy. It is front-loaded with the main action and structured for quick scanning by an AI agent.

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 simplicity (read-only lookup, two required params) and the presence of annotations and an output schema, the description covers the main purpose and provides usage scenarios. It lacks mention of the optional response_format parameter and error cases, but these are minor gaps for a straightforward 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 description coverage is 0% per context, but the actual schema has descriptions for workspace_id and definition_id. The tool description includes a code example with these parameters but does not explain them or the optional response_format. Since the schema itself provides basic descriptions, the example adds marginal value, earning a baseline 3.

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 retrieves details of a specific source connector definition, using the verb 'Get'. It specifies the resource ('source connector definition') and lists what is returned (name, Docker image, connector specification). This distinguishes it from sibling tools like airbyte_list_source_definitions (which lists all) and airbyte_get_source (which gets an instance).

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 provides two explicit scenarios: inspecting a specific connector and checking the Docker image version. While it does not exclude alternatives like using the list tool first, it gives clear context for when to invoke this tool. No explicit 'when not to use' or comparison with siblings, but the guidance is focused and actionable.

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