Airbyte MCP connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'airbytemcp'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Airbyte MCP:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'airbytemcp_check_enrollment_status',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "airbytemcp"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Airbyte MCP:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="airbytemcp_check_enrollment_status",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• Workspace use — Switch the active workspace for the session
• Organization use — Switch the active organization for the session
• Flow start credential — Start a browser-based credential flow to connect a data source
• Search skills — Search available skill documentation entries by a basic keyword
• Read skill docs — Read usage documentation for a skill
• List workspaces, skills, organizations — List all workspaces in your organization

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

airbytemcp_check_credential_flow_status#Check the status of a credential flow started by start_credential_flow. When complete, creates the connector and returns the connector_id. If status is 'pending', the user hasn't finished yet.2 params▾

Check the status of a credential flow started by start_credential_flow. When complete, creates the connector and returns the connector_id. If status is 'pending', the user hasn't finished yet.

NameTypeRequiredDescription

session_idstringrequiredThe session ID from start_credential_flow.

workspace_namestringoptionalOptional fallback workspace name.

airbytemcp_check_enrollment_status#Check and trigger account enrollment. Call this before other tools when working with a new user or when you get authentication/authorization errors. If is_enrolled is false, check provisioning_state and retry only while null or IN_PROGRESS.0 params▾

Check and trigger account enrollment. Call this before other tools when working with a new user or when you get authentication/authorization errors. If is_enrolled is false, check provisioning_state and retry only while null or IN_PROGRESS.

airbytemcp_current_datetime#Get the current date and time in ISO 8601 format (UTC). Call this FIRST before any time-based query to resolve relative dates like 'today', 'yesterday', 'this week', etc.0 params▾

Get the current date and time in ISO 8601 format (UTC). Call this FIRST before any time-based query to resolve relative dates like 'today', 'yesterday', 'this week', etc.

airbytemcp_delete_connector#Permanently delete a connector instance. This cannot be undone. Only use this after the user has explicitly confirmed deletion and identified the connector by name or connector_id.1 param▾

Permanently delete a connector instance. This cannot be undone. Only use this after the user has explicitly confirmed deletion and identified the connector by name or connector_id.

NameTypeRequiredDescription

connector_idstringrequiredThe connector instance ID to delete (from list_created_connectors).

airbytemcp_execute#Query, search, or write data in connected business systems (CRMs, support tools, databases, project trackers). Executes one or more operations concurrently. Maximum 10 items per call. PRECONDITION: Call inspect_connector then read_skill_docs before the first execute call for a connector.1 param▾

Query, search, or write data in connected business systems (CRMs, support tools, databases, project trackers). Executes one or more operations concurrently. Maximum 10 items per call. PRECONDITION: Call inspect_connector then read_skill_docs before the first execute call for a connector.

NameTypeRequiredDescription

itemsarrayrequiredA list of execution items, each targeting a connector entity + action.

airbytemcp_get_connector_template#Get detailed info about a connector type including configuration fields, auth requirements, and available auth methods. Call this before start_credential_flow to understand what authentication the connector supports.1 param▾

Get detailed info about a connector type including configuration fields, auth requirements, and available auth methods. Call this before start_credential_flow to understand what authentication the connector supports.

NameTypeRequiredDescription

template_idstringrequiredThe ID of the connector template (from list_available_connectors).

airbytemcp_get_current_organization#Report which organization is currently active. Call this when the user asks which organization they are in. When no organization has been explicitly selected, the backend uses your default organization (is_explicit_selection is false).0 params▾

Report which organization is currently active. Call this when the user asks which organization they are in. When no organization has been explicitly selected, the backend uses your default organization (is_explicit_selection is false).

airbytemcp_get_current_workspace#Report which workspace is currently active. Call this when the user asks which workspace they are in, or before creating connectors. When no workspace has been selected, the active workspace is 'default'.0 params▾

Report which workspace is currently active. Call this when the user asks which workspace they are in, or before creating connectors. When no workspace has been selected, the active workspace is 'default'.

airbytemcp_inspect_connector#Inspect a connected data source for metadata, status/readiness, source definition identity, warnings, and docs_skill_id. This is mandatory before read_skill_docs. Does not return usage instructions for execute — use read_skill_docs with the returned docs_skill_id.1 param▾

Inspect a connected data source for metadata, status/readiness, source definition identity, warnings, and docs_skill_id. This is mandatory before read_skill_docs. Does not return usage instructions for execute — use read_skill_docs with the returned docs_skill_id.

NameTypeRequiredDescription

connector_idstringrequiredThe connector instance ID (from list_created_connectors).

airbytemcp_list_available_connectors#List connector types (templates) available to create — NOT existing connectors. Returns names and IDs. To see connectors already set up, use list_created_connectors instead.0 params▾

List connector types (templates) available to create — NOT existing connectors. Returns names and IDs. To see connectors already set up, use list_created_connectors instead.

airbytemcp_list_created_connectors#List the user's connected data sources (e.g. Salesforce, HubSpot, Zendesk, Jira, databases). Returns connector IDs needed for inspect_connector, read_skill_docs, and execute. Call this before querying to see what systems are available.1 param▾

List the user's connected data sources (e.g. Salesforce, HubSpot, Zendesk, Jira, databases). Returns connector IDs needed for inspect_connector, read_skill_docs, and execute. Call this before querying to see what systems are available.

NameTypeRequiredDescription

workspace_namestringoptionalOptional workspace name to list connectors for.

airbytemcp_list_organizations#List the organizations you belong to. Each is flagged with is_current. Call this when the user mentions multiple organizations or wants to switch. If the list is empty and is_instance_admin is true, ask the user for the specific organization id.0 params▾

List the organizations you belong to. Each is flagged with is_current. Call this when the user mentions multiple organizations or wants to switch. If the list is empty and is_instance_admin is true, ask the user for the specific organization id.

airbytemcp_list_skills#List available skill documentation entries for connected data sources. Use this to discover docs skill IDs when you cannot call inspect_connector directly.3 params▾

List available skill documentation entries for connected data sources. Use this to discover docs skill IDs when you cannot call inspect_connector directly.

NameTypeRequiredDescription

cursorstringoptionalPagination cursor.

limitintegeroptionalMaximum number of skills to return.

workspace_namestringoptionalOptional workspace name.

airbytemcp_list_workspaces#List all workspaces in your organization. Each is flagged with is_current and is_default. Call this when the user mentions multiple workspaces or wants to switch.0 params▾

List all workspaces in your organization. Each is flagged with is_current and is_default. Call this when the user mentions multiple workspaces or wants to switch.

airbytemcp_read_skill_docs#Read usage documentation for a skill. For connector skills, pass the docs_skill_id returned by inspect_connector. Omit section to return metadata and available sections. Pass an exact section ID to read entity/action/params/examples for execute.3 params▾

Read usage documentation for a skill. For connector skills, pass the docs_skill_id returned by inspect_connector. Omit section to return metadata and available sections. Pass an exact section ID to read entity/action/params/examples for execute.

NameTypeRequiredDescription

idstringrequiredThe docs skill ID (from inspect_connector).

sectionstringoptionalSpecific section ID to read.

workspace_namestringoptionalOptional workspace name.

airbytemcp_search_skills#Search available skill documentation entries by a basic keyword. This is exact substring search only. It matches connector instance names and connector-source IDs. Use it when you need a docs skill ID.4 params▾

Search available skill documentation entries by a basic keyword. This is exact substring search only. It matches connector instance names and connector-source IDs. Use it when you need a docs skill ID.

NameTypeRequiredDescription

querystringrequiredKeyword to search for in skill names.

cursorstringoptionalPagination cursor.

limitintegeroptionalMaximum number of results.

workspace_namestringoptionalOptional workspace name.

airbytemcp_start_credential_flow#Start a browser-based credential flow to connect a data source. Returns a URL the user must visit to enter credentials securely. This is the ONLY way to provide credentials — NEVER ask for or accept API keys, tokens, passwords, or secrets directly in chat.2 params▾

Start a browser-based credential flow to connect a data source. Returns a URL the user must visit to enter credentials securely. This is the ONLY way to provide credentials — NEVER ask for or accept API keys, tokens, passwords, or secrets directly in chat.

NameTypeRequiredDescription

template_idstringrequiredThe connector template ID (from list_available_connectors).

workspace_namestringoptionalOptional workspace name. Defaults to current workspace.

airbytemcp_use_organization#Switch the active organization for the session. After calling this, every tool operates on the chosen organization until you switch again. Switching organizations resets the active workspace to that organization's default workspace.1 param▾

Switch the active organization for the session. After calling this, every tool operates on the chosen organization until you switch again. Switching organizations resets the active workspace to that organization's default workspace.

NameTypeRequiredDescription

organization_idstringrequiredThe organization to switch to (from list_organizations).

airbytemcp_use_workspace#Switch the active workspace for the session. After calling this, all workspace-scoped tools operate on the chosen workspace until you switch again. Always tell the user which workspace is now active.1 param▾

Switch the active workspace for the session. After calling this, all workspace-scoped tools operate on the chosen workspace until you switch again. Always tell the user which workspace is now active.

NameTypeRequiredDescription

workspace_namestringrequiredThe workspace to switch to (from list_workspaces).