Skip to main content

Airbyte MCP tools

AvailableCoreAvailableStandardAvailablePlusAvailableProAvailableEnterprise Flex Compare
Private beta

The Airbyte MCP is in private beta. Features and tools may change. It's available to Airbyte Cloud organizations enrolled in the beta. You can also run the Airbyte MCP with self-managed Airbyte Core, with known issues.

The Airbyte MCP gives your agent a set of tools. Your agent chooses which tools to call based on your prompt, so you don't need to call them by name. This page lists each tool so you know what your agent can and can't do.

Your agent acts on behalf of the Airbyte user who signed in to the Airbyte MCP. If you connect with an Airbyte application, that's the user who created the application. Every tool acts with that user's Airbyte permissions. If their Airbyte role doesn't allow an action, the tool fails.

Direct reads work differently. When your agent reads directly from a source or destination, the third-party system sees a request from the credentials stored in that connector in that workspace, not from you. Your Airbyte permissions still control which connectors your agent can use, but the stored credentials control which records it can read.

Safety​

Your agent can see and use every resource your Airbyte permissions allow. To prevent your agent from accidentally breaking existing pipelines, the Airbyte MCP limits which resources it can change.

  • Destructive tools are limited to the current session. Tools that delete, overwrite, or reconfigure resources only act on resources your agent created in the same session. They can't delete a connection someone else built.
  • Your MCP client asks before acting. Each tool tells your client whether it's read-only or destructive. Most clients ask you to approve tools that change things.

Workspaces and organizations​

ToolDescription
get_default_cloud_contextGet your default organization and workspace.
list_cloud_organizationsList the organizations you can access.
describe_cloud_organizationGet details about an organization.
get_cloud_organization_billing_statusGet billing and account status for an organization. Requires an organization reader or admin role. Airbyte Cloud only.
list_cloud_workspacesList the workspaces you can access.
describe_cloud_workspaceGet details about a workspace, like its name, URL, and organization.
set_default_cloud_workspaceChange your default workspace. This changes your default workspace in the Airbyte web app, too.

Sources and destinations​

ToolDescription
list_cloud_connectorsList the sources and destinations in a workspace.
describe_cloud_connectorGet details about a source or destination, including its configuration, connections, and direct read instructions.
deploy_connector_to_cloudCreate a source or destination in a workspace.
deploy_noop_destination_to_cloudCreate a No-op destination for testing a source.
check_cloud_connectorTest the configuration and credentials of a source or destination.
rename_cloud_connectorRename a source or destination.
update_cloud_connector_configChange the configuration of a source or destination.
permanently_delete_cloud_connectorDelete a source or destination.

Connections and syncs​

ToolDescription
list_cloud_connectionsList the connections in a workspace.
describe_cloud_connectionGet details about a connection, like its streams, schedule, and status.
create_connection_on_cloudCreate a connection between a source and a destination.
update_cloud_connectionTurn a connection on or off, or change its sync schedule.
rename_cloud_connectionRename a connection.
set_cloud_connection_selected_streamsChoose which streams a connection syncs.
set_cloud_connection_table_prefixSet the table prefix for a connection.
get_connection_artifactGet a connection's state or configured catalog.
permanently_delete_cloud_connectionDelete a connection.
run_cloud_syncStart a sync.
cancel_cloud_syncCancel a running sync.
get_cloud_sync_statusGet the status of a sync job.
list_cloud_sync_jobsList the recent sync jobs for a connection.
get_cloud_sync_logsRead the logs from a sync job, to troubleshoot failures.

Dashboards​

These tools display interactive views in clients that support MCP Apps. In other clients, they return the same information as text.

ToolDescription
show_workspace_sync_statusShow a sync status dashboard for a workspace.
show_connection_sync_historyShow sync history, success rates, and volume for a connection.
show_connectors_listShow a catalog of Airbyte connectors you can browse.

Custom connectors​

ToolDescription
list_custom_source_definitionsList the custom connectors in a workspace.
get_custom_source_definitionGet a custom connector, including its YAML manifest.
get_connector_builder_draft_manifestGet the unpublished draft of a custom connector from the Connector Builder.
publish_custom_source_definitionPublish a YAML manifest as a custom connector.
update_custom_source_definitionUpdate a custom connector's YAML manifest.
permanently_delete_custom_source_definitionDelete a custom connector.

Direct reads​

These tools read data directly from sources and destinations. They only work after an organization admin enables the context layer and turns on agent access for the source or destination. They're read-only. They're only available in Airbyte Cloud.

ToolDescription
get_agent_skill_docsGet a connector skill: the entities, actions, and parameters a source or destination supports for direct reads. Your agent reads this before it reads data.
execute_external_api_queryRead live records from a source's API. Supports the list and get actions.
execute_external_sql_queryRun a read-only SQL query on a Snowflake or BigQuery destination. Only SELECT statements and SHOW TABLES are allowed.

Connector skills​

Every connector's API is different. A connector skill is a short document that tells your agent which entities it can read, like contacts or tickets, and which parameters each action accepts. Before your agent reads data from a source, it calls get_agent_skill_docs to learn that connector's skill. This prevents your agent from guessing at parameter names. To learn more, see Connector skills for Airbyte agents.

Direct read actions​

ActionWhat it doesExample
listReturn a page of records for an entity, with optional filters.List open Zendesk tickets.
getReturn one record by its ID.Get the HubSpot contact with ID 123.

Direct reads can't create, update, or delete records.

Connector registry and documentation​

ToolDescription
list_connectorsSearch the Airbyte connector catalog.
get_connector_infoGet a connector's metadata, documentation URL, and configuration specification.
get_connector_version_historyGet a connector's recent versions and changelog.
get_api_docs_urlsGet links to the documentation for a connector's third-party API.
search_airbyte_knowledge_sourcesLook up answers in Airbyte's documentation and source code for the platform and connectors. Only available in the hosted Airbyte MCP.