connectors-execute
connectors execute
[!NOTE] Requires the
airbyte-agentCLI onPATH. Install viabrew install airbytehq/tap/airbyte-agentor see the project README.
Run an action against an entity on a connector — the workhorse command for actually moving data. This skill embeds the SDK-level knowledge of how the underlying API behaves (filter operators, pagination, response shape, field-selection rules). For connector-specific details — which entities exist, which actions they support, and which params they take — call connectors describe first; never guess.
[!IMPORTANT] Always pass parameters as
--json '{...}'. The CLI also exposes per-parameter flags (--workspace,--name, etc.) for human use, but agents should always send a single JSON payload. The two modes are mutually exclusive and JSON keeps your input self-describing for review and replay.
[!IMPORTANT] Field selection is MANDATORY. Every call MUST include
select_fields(allowlist) orexclude_fields(blocklist). Unfiltered responses waste both bandwidth and context window. Both support dot-notation for nested fields (e.g.billing.address.city). If both are passed,select_fieldswins.
[!IMPORTANT] Prefer
context_store_searchoverlist. The default action for any read iscontext_store_search— it supports filtering, sorting, and pagination. Only uselistwhen (a) you need today's data (the search index can lag hours), or (b)context_store_searchreturns no results and you suspect indexing delay.
[!IMPORTANT]
connectors describeis the source of truth for what a specific connector supports. Use it to discover the entities the connector exposes, the actions valid on each entity, and the params each action accepts (filter fields, required arguments, response shape). Do NOT guess any of these — every guess is an avoidable round-trip. The action table below is a baseline (most connectors support most of these), but the actually-supported set is whatdescribereports.