Skip to main content
Glama
trustxai
by trustxai

airbyte_list_workspaces

Read-onlyIdempotent

Retrieve all Airbyte workspaces accessible to your credentials, including their IDs and data residency, to discover or audit workspaces before managing other resources.

Instructions

List all Airbyte workspaces the current credentials have access to.

Workspaces are the top-level organizational unit in Airbyte. Every source, destination, and connection belongs to exactly one workspace. Use this tool to discover workspace IDs before filtering other resources.

When to Use: - Discover which workspaces exist and get their UUIDs. - Find a workspace by name to use its ID in other calls. - Audit workspace configuration (data residency, etc.).

When NOT to Use: - If you already have a workspace ID, use airbyte_get_workspace for full details instead.

Returns: Paginated list of workspaces. Each entry includes: - name, workspaceId (UUID), dataResidency.

Markdown format shows a heading per workspace.
JSON format returns the raw API response array.

Pagination: Use limit (1–100, default 20) and offset (default 0). The response header indicates whether more pages exist.

Examples: List first 5 workspaces: params = { "limit": 5 } List including deleted workspaces: 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?

The description adds value beyond annotations by explaining pagination (limit, offset, response headers), return format options (markdown/json), and the relationship of workspaces to other entities. No contradiction with annotations (readOnlyHint, etc.).

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, front-loaded with purpose, and uses efficient language. Every sentence serves a purpose without redundancy.

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 presence of an output schema and thorough parameter descriptions, the description sufficiently covers pagination, return values, and usage context. It provides all necessary information for correct tool invocation.

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 coverage is high (all parameters have descriptions). The description provides examples (e.g., limit=5, include_deleted=true) that add practical context beyond the schema, justifying a score above 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 'List all Airbyte workspaces' with a specific verb and resource. It distinguishes from sibling 'airbyte_get_workspace' by noting that this tool is for discovery and listing all workspaces.

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, with guidance on when to use 'airbyte_get_workspace' instead. Provides specific use cases like discovering workspace IDs and auditing configuration.

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