Skip to main content
Glama
trustxai
by trustxai

airbyte_get_workspace

Read-onlyIdempotent

Get full details of a single workspace by UUID, including name and data residency region.

Instructions

Get full details of a single Airbyte workspace by its UUID.

Returns the workspace name, data residency region, and other metadata. Use when you already know the workspace ID and need its properties.

When to Use: - Look up a specific workspace's name or data residency. - Confirm a workspace ID is valid before passing it to other tools.

When NOT to Use: - If you need to browse or search workspaces, use airbyte_list_workspaces instead.

Returns: Workspace details including: name, workspaceId, dataResidency.

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

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

Error Handling: Returns a 404 message if the workspace ID does not exist. Returns a 403 message if credentials lack access to that workspace.

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, destructiveHint, idempotentHint. The description adds error handling details (404, 403) and return format options, which go 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.

Conciseness5/5

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

Well-structured with clear sections (When to Use, Returns, Examples, Error Handling). Every sentence is informative. No redundancy or 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?

With output schema present, description handles return values correctly. Covers error cases and usage context. Complete for a simple get operation with rich annotations.

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?

Schema has descriptions for workspace_id and response_format. The description adds value by explaining the effect of response_format (markdown vs JSON) and providing examples. It compensates for any schema description gaps.

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 gets full details of a single Airbyte workspace by UUID, with specific verb 'Get' and resource 'workspace'. It distinguishes from sibling tool 'airbyte_list_workspaces' which is for browsing.

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?

Explicitly provides when to use (look up workspace properties, confirm ID) and when not to use (browsing → use list_workspaces). This is a clear usage guideline.

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