oomol-lab/open-connector

English | 简体中文 | 繁體中文 | 日本語 | 한국어 | Русский | Français

OpenConnector 是一个面向 AI agent 的开源连接器网关，也是 Pipedream/Composio 的替代方案。用户应用账号只需连接一次，即可向 agent 和应用开放包含 1,000+ 个 provider 和 10,000+ 个预构建 Action 的共享目录。

在应用代码中使用 Connector SDK，使用 oo CLI 作为本地 agent 中继，通过 MCP 连接 agent 主机，通过 HTTP/OpenAPI 连接自定义客户端，并使用 Web Console 进行管理和调试。

• 将凭据、scope、schema、策略和运行日志保存在可检查的运行时内。
• 在本地、Fly.io、Cloudflare 兼容基础设施或 OOMOL 托管运行时上运行。
• 在开源和商业 SaaS 部署中使用相同的 provider ID、Action ID、schema 和契约。

提供内容

• 覆盖 GitHub、Gmail、Notion、BigQuery、Google Analytics、Supabase、Airtable、Slack 等产品的可用连接器目录。
• 支持 API key、OAuth2、自定义凭据和无认证 provider 的凭据处理。
• 可检查的 Action 契约：请求/响应 schema、所需 scope 和懒加载的 executor 源码。
• 运行时控制：连接身份、scope、运行时 token、Action 允许/阻止策略、临时文件传输和脱敏运行日志。
• 部署选项：本地 Docker 或 Node.js、带持久化 SQLite 存储的 Fly.io、带 D1/R2/Static Assets 的 Cloudflare Workers，以及 OOMOL 托管运行时。

适用场景

OpenConnector 适用于需要 agent 持久访问用户已有工具、但又不将 provider 凭据交给 agent 进程的产品。

• 需要在工作应用、开发者工具、数据系统、通信平台和 AI 服务之间提供可复用访问的 agent 产品。
• 需要为 agent 工作流提供稳定、可检查的 Action 契约以访问用户应用的产品。
• 希望借助托管认证快速上线，同时保留私有或自托管运行时控制路径的团队。

开发者工具

端点详情、响应封装、认证头、MCP 工具和 Action 指南示例见 docs/runtime-api.md。

Dashboard 预览

OpenConnector 自带本地 Dashboard，用于浏览连接器、配置凭据、创建运行时 token 和检查运行时使用情况。

连接器目录

使用连接器目录查看可用服务、搜索 provider，并在一个地方打开其 Action 和凭据设置。

OpenConnector connector catalog dashboard

使用概览

部署后使用 Overview 页面监控运行时就绪状态、可用 provider、可执行 Action、近期失败、工具调用趋势和最近调用。

OpenConnector runtime overview dashboard

Provider 名称和商标归各自所有者所有，仅用于标识和互操作性。

工作原理

flowchart LR
  Agent["AI Agent / App"] -->|"SDK / CLI / MCP / HTTP"| Gateway["OpenConnector Gateway"]
  Gateway --> Auth["Credential & OAuth Boundary"]
  Gateway --> Catalog["Provider Catalog"]
  Gateway --> Actions["Open-source Action Executors"]
  Gateway --> Policy["Tokens, Scopes, Allow/Block Policy"]
  Gateway --> Logs["Run Logs"]
  Actions --> Providers["1,000+ Providers"]
  Console["Web Console"] --> Gateway
  Cloudflare["Cloudflare Workers, D1, R2"] -. deploy .-> Gateway

应用和 agent 发现 Action、检查 schema 和 scope、选择连接别名，并通过网关执行。Provider 密钥保留在运行时边界之后；agent 只接收运行所需的元数据、安全账号标签和执行结果。

使用路径

Cloudflare 快速入门视频

Deploy OpenConnector on Cloudflare Workers

Cloudflare Workers 部署演示展示了如何在 Cloudflare 上使用 Workers、D1、R2 和 Web Console 启动 OpenConnector。视频遵循与 docs/cloudflare.md 相同的流程：创建 Cloudflare 资源、将 wrangler.example.jsonc 复制为 wrangler.local.jsonc、应用 D1 migrations、设置所需 secrets，并运行 npm run deploy:cloudflare。

快速入门

[!NOTE] 这会启动一个自托管运行时。OAuth provider 需要你向这些 provider 注册应用后获得的 OAuth 客户端凭据。若要让用户无需设置自己的 OAuth 应用即可授权支持的 provider，请使用 OOMOL 托管连接器。

使用 Docker Compose 从发布镜像启动运行时：

docker compose up

这会拉取 ghcr.io/oomol-lab/open-connector:latest。若要从源码构建：

docker compose -f docker-compose.yml -f docker-compose.build.yml up --build

打开本地 console 和生成的 API 参考：

http://localhost:3000
http://localhost:3000/docs

运行一个无认证 Action 验证运行时：

curl -s -X POST http://localhost:3000/v1/actions/hackernews.get_top_stories \
  -H 'content-type: application/json' \
  -d '{"input":{}}'

完整的本地设置、首次 provider 连接、OAuth 流程和运行时设置见 docs/quickstart.md。

连接 Provider

GitHub 是最简单的带凭据示例，因为它可以使用个人访问 token：

curl -s -X PUT http://localhost:3000/api/connections/github \
  -H 'content-type: application/json' \
  -d '{"authType":"api_key","values":{"apiKey":"github_pat_..."}}'

curl -s -X POST http://localhost:3000/v1/actions/github.get_current_user \
  -H 'content-type: application/json' \
  -d '{"input":{}}'

关于 OAuth2 应用、命名连接、凭据加密、token 刷新和 Action 策略，见 docs/credentials.md 和 docs/configuration.md。

Web Console

对于基于 npm 的本地开发，打开 http://localhost:5173；Web Console 开发服务器将 API 请求代理到 http://localhost:3000 上的运行时。对于 Docker 或构建后的 Node 运行时，console 从 http://localhost:3000 提供。

Console 支持 provider 浏览、API key 和 OAuth 客户端配置、运行时 token 创建、Action schema 检查、Action 调试、最近运行审查，以及访问生成的 OpenAPI 和 MCP 元数据。

Cloudflare 部署

OpenConnector 可在 Cloudflare 上运行，使用 Workers 作为运行时、D1 作为状态、R2 作为传输文件、Static Assets 作为 Web Console。

资源创建、migrations、secrets、本地 Worker 预览和远程部署见 docs/cloudflare.md。

Fly.io 部署

OpenConnector 也可在 Fly.io 上运行，使用 Node Docker 运行时和 Fly volume 上的持久化 SQLite 存储。

应用创建、volume 设置、secrets、部署、自定义域名和扩缩容见 docs/fly-io.md。

Docker 镜像（GHCR）

从 GitHub Packages（GHCR）上的预构建镜像运行 OpenConnector：ghcr.io/oomol-lab/open-connector。使用 latest 获取最新版本，生产环境使用固定版本如 v1.0.0，或使用 tip 获取最新的 main 构建。

标签、拉取和运行见 docs/docker-ghcr.md。

使用 Wanta 构建桌面 Agent

OpenConnector 和 Wanta 是 OOMOL 生态中面向 AI Agent 的两个开源项目。OpenConnector 将 Agent 连接到 Gmail、Slack、Notion 等外部服务。Wanta 提供由 OpenCode 驱动的完整桌面 Agent 应用，并使用 OpenConnector 与连接的 SaaS 服务协作。

• 本地运行： 使用你自己的 OpenAI 兼容模型，无需创建 Wanta 账号。
• 自行构建： Fork Wanta 并自定义其 prompt、工具、界面、模型和品牌。
• 使用托管服务： 可选的托管体验提供托管模型、OAuth 连接和团队工作区。

欢迎提交 issue 和 pull request。

文档

• 快速入门
• 开发者工具
• Gmail OAuth 和 SDK 教程
• 运行时 API 和 MCP
• Fly.io 部署
• Cloudflare 部署
• Docker 镜像（GHCR）
• 配置
• 凭据和 OAuth
• 目录格式
• 验证语言
• 贡献指南
• 行为准则
• 安全

开发

使用 Node.js 22 或更高版本：

npm install
npm run dev

本地 API 运行时监听 http://localhost:3000。Web Console 开发服务器监听 http://localhost:5173 并将 API 请求代理到运行时。

在提交 pull request 之前：

npm run fix-check
npm test

Provider 代码位于 src/providers/<service> 下。Provider 贡献规则见 CONTRIBUTING.md。

许可范围

除非另有说明，为本仓库编写的源代码、脚本、生成的项目脚手架、测试和文档均依据 Apache License 2.0 许可。见 LICENSE.txt。

本仓库的 Apache-2.0 许可不授予第三方产品、provider、应用、API、商标、服务标记、商号、徽标、图标、品牌资产、文档、截图或其他归各自所有者所有的受版权保护材料的权利。

Provider 和应用名称、元数据、链接、scope、权限以及可选的徽标/图标仅用于标识服务和实现互操作性。所有第三方品牌和产品权利归各自所有者所有。本目录中的收录不构成这些所有者的认可、赞助、合作、认证或验证。

如果你贡献 provider 元数据或资产，请只提交你有权提交的材料。优先链接到官方公开资产，而不是将品牌文件复制到本仓库。

社区

请保持 issue 和 pull request 聚焦、尊重且可操作。参与本项目受 CODE_OF_CONDUCT.md 约束。

支持 OpenConnector

如果 OpenConnector 对你有用，给它一个 ⭐ 可以帮助更多开发者发现这个项目。

贡献者

感谢所有帮助构建 OpenConnector 的人。想加入他们？见 CONTRIBUTING.md。

Star 历史