Skip to main content

Module airbyte_agent_sdk.tools

Framework-ready connector tools.

Functions​

build_connector_tools(connector: Any, *, framework: FrameworkName | None = None, docs_provider: ConnectorDocsProvider | None = None, use_progressive_docs: bool = True, max_output_chars: int | None = 100000, internal_retries: int = 0, should_internal_retry: Callable[[Exception, tuple[Any, ...], dict[str, Any]], bool] | None = None, exhausted_runtime_failure_message: Callable[[Exception, tuple[Any, ...], dict[str, Any]], str | None] | None = None) ‑> airbyte_agent_sdk.tools.ConnectorTools : Build inspect/docs/execute tools bound to a single connector.

Hosted connectors use the live inspect and skill-docs endpoints. Local connectors keep the generated YAML-derived rich docs as their fallback.

Classes​

ConnectorDocsProvider(*args, **kwargs) : Base class for protocol classes.

Protocol classes are defined as:

    class Proto(Protocol):
        def meth(self) -> int:
            ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example:

    class C:
        def meth(self) -> int:
            return 0

    def func(x: Proto) -> int:
        return x.meth()

    func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

    class GenProto[T](Protocol):
        def meth(self) -> T:
            ...

Ancestors (in MRO)​

  • typing.Protocol
  • typing.Generic

Methods​

inspect_connector(self) ‑> dict[str, typing.Any] :

read_skill_docs(self, id: str, section: str | None = None) ‑> dict[str, typing.Any] :

ConnectorTools(inspect_connector: ToolCallable, read_skill_docs: ToolCallable, execute: ToolCallable, use_progressive_docs: bool = True) : Connector tool callables for agent frameworks.

Instance variables​

execute: Callable[..., typing.Awaitable[typing.Any]] : The type of the None singleton.

inspect_connector: Callable[..., typing.Awaitable[typing.Any]] : The type of the None singleton.

read_skill_docs: Callable[..., typing.Awaitable[typing.Any]] : The type of the None singleton.

use_progressive_docs: bool : The type of the None singleton.

Methods​

as_list(self) ‑> list[Callable[..., typing.Awaitable[typing.Any]]] :

Was this page helpful?