SuperAPI AI 工具集

connectors-describe

数据与分析

查看项目

更新于 10-15 19:53

技能介绍

用途:connectors describe 是 airbyte-agent CLI 的子命令,用于查看某个连接器暴露的实体(如 users、contacts、orders)以及每个实体支持的操作(如 read、write)。官方强调在任何连接器首次 execute 之前都应先 describe,因为实体名和操作名随连接器类型变化、无法预测,不应猜测。

主要能力:列出连接器的可用实体与对应操作;帮助发现实体包含哪些字段;在 execute 返回 not_found 或 validation_error 时用于排查。

使用方式:需先将 airbyte-agent CLI 加入 PATH,可通过 brew install airbytehq/tap/airbyte-agent 安装,或参考项目 README。参数必须以 --json '{...}' 形式传入,智能体不应使用逐参数标志。按名称查询:airbyte-agent connectors describe --json '{"workspace": "my-workspace", "name": "my-source"}';省略 workspace 时默认使用 default,并在 stderr 打印 JSON 提示。按 ID 查询:airbyte-agent connectors describe --json '{"id": ""}'。

典型工作流:先用 airbyte-agent connectors list --json '{"workspace": "my-workspace"}' 找到连接器,再 describe,最后用发现的实体与操作执行 execute。

限制与注意:不要在首次 execute 前跳过此步骤;不要跨 CLI 版本缓存 describe 输出,因为连接器更新时 schema 可能变化。其他细节暂未提供。