Zapier SDK
让智能体通过 Zapier 托管 OAuth 连接 9000+ 应用,无需自持密钥即可调用任意 Action。
- 源仓库
- zapier/sdk
- Star 数
- ★ 253
- 最近更新
- 1 个月前
- License
- MIT
- FA 评分
- 49/100 · 缺口较多
30 秒速览
- 可在哪里用
- 兼容但需适配Codex · Claude CodeClaude.ai(部分支持)
- 开始前需要
- 典型场景
- 需要跨多个 SaaS 打通流程的自动化工程师:不想为每个应用单独申请 OAuth 应用、维护刷新 token,可直接用 create-connection + run-action 串起 Notion、Gmail、Google Sheets、Airtable。
- 主要局限
- 强依赖 Zapier 平台:连接、Action 目录与凭据都由 Zapier 服务托管,无法脱离该生态自托管运行
这个 Agent 能做什么,适合哪些场景?
Zapier SDK 通过 npm 包 @zapier/zapier-sdk 提供对 Zapier 应用生态的程序化访问,仓库本身则打包了 SDK 文档、经校验的示例和可安装的智能体技能。执行模型是:用户在本地通过 npx zapier-sdk login 登录,用 create-connection 为某个应用建立 OAuth 连接(密钥由 Zapier 持有),再用 run-action 调用目录中的具体 Action;SDK 在运行时解析 Action schema,代码始终不接触 token。仓库按 by-app、by-domain、by-pattern 三种方式索引 examples/ 目录,并提供符合 agentskills.io 的 zapier-sdk 技能与只读的 zapier-sdk-explorer 子代理。除标准 CLI/SDK 用法外,它还支持以插件形式装入 Claude Code、OpenAI Codex 和 GitHub Copilot CLI,或手动 clone 后引用 SKILL.md。集成边界明确:连接与 Action 目录由 Zapier 平台托管,代码可移动、平台不可移动。
该仓库提供并説明 @zapier/zapier-sdk(运行时 SDK)与 @zapier/zapier-sdk-cli(CLI 伴侣)的用法。典型流程为:先 npm install 两个包,再运行 npx zapier-sdk login 在本地保存凭据,createZapierSdk() 会自动读取这些凭据;随后用 npx zapier-sdk list-connections、npx zapier-sdk create-connection <app> 为 notion、gmail、google-sheets、airtable 等应用建立 OAuth 连接;最后用 npx zapier-sdk run-action <app> <action> --inputs '{...}' 执行具体 Action,例如 notion 的 search page_by_title、gmail 的 search message、google-sheets 的 search lookup_row、airtable 的 search findRecord,输出为 JSON。示例目录 examples/by-app 收录单次调用的 SDK 示例,by-domain 用 README 将行业域映射到示例,by-pattern 提供 notify-on-event、data-sync、lead-routing、scheduled-report 等端到端自动化形态;示例中的 action key 在入库时都经过 listActions 校验。此外,skills/zapier-sdk 以 agentskills.io 规范分发,zapier-sdk-explorer 子代理可在写代码前对活目录解析精确的 app/action/field ID,sdk.fetch 则作为任意 HTTP API 的逃逸通道。
- 需要跨多个 SaaS 打通流程的自动化工程师:不想为每个应用单独申请 OAuth 应用、维护刷新 token,可直接用 create-connection + run-action 串起 Notion、Gmail、Google Sheets、Airtable。
- 编写代码助手的开发者:把 sdk@zapier 插件装进 Claude Code 或 Codex,让助手在生成代码前用 zapier-sdk-explorer 校验真实的 action key,避免编造方法名。
- 做线索分发的团队:用 airtable findRecord 按邮箱查询记录,再把结果推送到 CRM 或其他目标,形成 lead-routing 模式。
- 需要定时报表的场景:按 scheduled-report 模式,从 Google Sheets lookup_row 或 Gmail message 拉取数据后汇总输出。
- 只想要 CLI 快速试验的运维/支持人员:在终端用 run-action 对已有连接执行查询,例如按 Gmail 查询语法检索来自某地址的邮件。
- 构建智能体工具的团队:以 agentskills.io 兼容方式加载 zapier-sdk 技能,作为工具调用层接入自有 runtime。
如何安装或部署这个 Agent?
前置条件:Node.js 与 npm(CLI 与 SDK 均为 npm 包),需联网访问 Zapier。
1) 安装运行时与开发依赖(README 原样命令):
npm install @zapier/zapier-sdk
npm install -D @zapier/zapier-sdk-cli @types/node typescript2) 让 AI 编码助手代为安装(可选,注意 README 中的 marketplace 拼写与命令原样):
Claude Code:
/plugin marketplace add zapier/marketplace
/plugin install sdk@zapierOpenAI Codex:
codex plugin marketplace add zapier/marketplace
codex plugin add sdk@zapierGitHub Copilot CLI:
copilot plugin marketplace add zapier/marketplace
copilot plugin install sdk@zapier3) 不支持 agentskills.io 的工具:
git clone https://github.com/zapier/sdk.git然后把 skills/zapier-sdk/SKILL.md 引入 .cursorrules、AGENTS.md、.github/copilot-instructions.md 等规则文件。
4) 登录:npx zapier-sdk login,凭据保存在本机,后续 createZapierSdk() 自动读取。
如何使用这个 Agent?
认证与查看身份:
npx zapier-sdk login
npx zapier-sdk get-profile建立连接(每个应用会打开浏览器完成 OAuth):
npx zapier-sdk list-connections
npx zapier-sdk create-connection notion
npx zapier-sdk create-connection gmail
npx zapier-sdk create-connection google-sheets
npx zapier-sdk create-connection airtable执行 Action(返回 JSON):
npx zapier-sdk run-action notion search page_by_title --inputs '{"title":"Meeting Notes","exact_match":"no"}'
npx zapier-sdk run-action gmail search message --inputs '{"query":"from:[email protected]"}'
npx zapier-sdk run-action google-sheets search lookup_row --inputs '{"spreadsheet":"<sheet-id>","worksheet":"<tab-id>","lookup_key":"Email","lookup_value":"[email protected]"}'
npx zapier-sdk run-action airtable search findRecord --inputs '{"applicationId":"<base-id>","tableName":"Leads","searchByField":"Email","searchByValue":"[email protected]"}'在代码中使用:createZapierSdk() 会自动读取本地凭据;需要调任意 HTTP API 时用 sdk.fetch。更多单次调用示例见 examples/by-app/,字段与全量方法见 docs.zapier.com/sdk/reference,CLI 完整命令见 skills/zapier-sdk/references/cli-commands.md。
这个 Agent 有哪些优点和局限?
- OAuth 由 Zapier 托管:代码不接触 token,也不需要为 9000+ 应用逐一注册自有 OAuth 应用
- 示例经 listActions 校验,action key 与字段是真实可用的,减少生成代码编造方法名的问题
- 同时提供 npm 运行时包与 CLI,既能在代码里调用,也能在终端直接用 run-action 试验
- 附带符合 agentskills.io 的 zapier-sdk 技能与只读的 zapier-sdk-explorer 子代理,可先解析精确 app/action/field ID 再写代码
- examples/ 按 by-app、by-domain、by-pattern 三种维度组织,便于按单点调用或端到端模式查找
- 明确提供 sdk.fetch 逃逸通道,遇到没有一等 Action 的接口仍可访问
- 强依赖 Zapier 平台:连接、Action 目录与凭据都由 Zapier 服务托管,无法脱离该生态自托管运行
- 需要 Node.js 与联网环境,且使用 Zapier 服务需另行遵守其服务条款
- 仓库不包含 Zapier 服务的源码,只覆盖 SDK 客户端与文档示例
- 定价与配额未在仓库内说明,需另行查看 zapier.com/sdk
- 每接入一个应用都要单独执行 create-connection 并完成浏览器 OAuth,批量接入场景下存在人工步骤
- 文档中示例需要真实的 spreadsheet、worksheet、base-id 等占位符替换,初次上手需先拿到这些 ID
这个 Agent 与同类方案有什么区别?
仓库明确提到 Zapier MCP(github.com/zapier/zapier-mcp)作为替代方案:若你的工具调用走 MCP 协议(如 Cursor、Claude Desktop、Codex),可以用 MCP server 而不是本 SDK 与 CLI。
与相关度最高的同类 agent 并排比较关键指标。
| Agent | 源码审查 | Star | 最近更新 | 主语言 | 完整支持的平台 |
|---|---|---|---|---|---|
| Zapier SDK 当前 | 49 · 缺口较多 | ★ 253 | 1 个月前 | — | Codex · Claude Code |
| OSS Autopilot | 83 · 表现良好 | ★ 16 | 1 天前 | TypeScript | Claude Code · Claude.ai |
| Uni-CLI | 72 · 存在缺口 | ★ 270 | 1 天前 | TypeScript | ChatGPT · Codex · Claude Code |
| ZCF - 零配置代码流程 | 51 · 缺口较多 | ★ 6.1k | 24 天前 | TypeScript | Codex · Claude Code |
FollowAgents 如何评估这个 Agent?
查看各维度的扣分理由
README 明确说明 OAuth 令牌由 Zapier 平台持有、代码不接触 token,并给出 sdk.fetch 作为受控逃生舱,数据流透明度较好(2)。但仓库本身是文档/示例语料,未展示最小权限范围声明、逐次操作的用户确认机制、敏感数据(如 Gmail 查询、表格行)处理策略,也未提供回滚/撤销示例,故 least_privilege、user_confirmation、sensitive_data_handling、external_effects 仅 1,rollback 为 0。依赖安全方面仅固定了 CLI 0.65.5 与 typescript@5,无锁文件或审计证据,给 1。来源归属有 LICENSE 与商标声明,给 2。
README 的安装、认证、连接、执行四步与 package.json 脚本、CI 校验流程相互一致,自洽性给 2。依赖可用性仅声明 node>=18 与两个 npm 包,未提供锁文件或版本兼容矩阵,给 1。失败信息方面只有 CI 的 typecheck/audit 步骤,未展示运行时错误处理或诊断指引,给 1。
面向多种 AI 助手(Claude Code、Codex、Copilot、Cursor)与后端场景,受众与场景覆盖较好(2);能力边界说明 SDK 负责 OAuth 与动作目录、fetch 为逃生舱(2)。触发精度方面未定义何时该调用哪个动作的判定规则,仅给示例,给 1。环境适配声明 node>=18 与 agentskills.io 兼容,给 2。
信息架构清晰:README、examples 三向索引、skills、llms.txt 组织良好(3)。安装说明完整但依赖外部 npm 包与浏览器 OAuth,给 2。命名稳定性方面动作键由运行时目录解析,示例键可能随目录变化,给 2。示例与 FAQ 有示例但无 FAQ,给 2。已知限制仅提及需连接与凭据,未系统列出限制,给 1。许可证 MIT 完整(3)。版本与变更日志缺失,package.json 为 0.1.0 且 private,给 1。维护责任仅指向 CONTRIBUTING 与 [email protected],发布者身份未验证,给 1。
输出可用性:示例可直接复制执行并返回 JSON,给 2。边际价值:提供 Zapier 9000+ 应用的统一接入与技能清单,给 2。成本效益:需 Zapier 账号、OAuth 连接与可能的付费服务,仓库未说明成本,给 1。
claim_traceability:README 声明示例动作键经 listActions 校验,并有 audit.mjs 与 CI 佐证,给 2。cross_source_corroboration:仅仓库内自证,无独立第三方来源,给 1。fact_inference_separation:文档区分了捕获输出与生成器,并标注非 mockup,给 2。
- 源码中未见:回滚或恢复路径运行前先备份,或在 git 分支、快照上操作,确保改动可以撤销。
- 仓库为文档与示例语料,未展示最小权限范围、逐次用户确认或回滚/撤销机制,实际授权行为需在 Zapier 平台侧核实。
- 依赖仅固定 CLI 0.65.5 与 typescript@5,无锁文件或依赖审计证据,供应链风险未在仓库内缓解。
- 发布者身份未经验证,维护责任与更新路径仅指向 CONTRIBUTING 与 [email protected],需独立确认。
- 示例动作键依赖运行时目录解析,可能随 Zapier 目录变化而失效,仓库未提供版本化变更日志。
- 使用需 Zapier 账号与 OAuth 连接,可能涉及付费服务,仓库未说明成本与配额。