OpenConnector新手教程：3步执行第一个Action，零凭据快速连接1000+ SaaS

OpenConnector新手教程：3步执行第一个Action，零凭据快速连接1000+ SaaS

【免费下载链接】open-connectorOpen-source auth gateway connecting 1000+ SaaS providers to AI agents through SDK, CLI, MCP, HTTP, and OpenAPI.项目地址: https://gitcode.com/gh_mirrors/op/open-connector

OpenConnector是一个开源的认证网关（Auth Gateway），它把1000+ SaaS 服务商和10000+ 预构建 Action以标准接口暴露给你的 AI Agent。本文将带你走完 OpenConnector 快速上手的完整流程：3 步执行第一个 Action，无需任何凭据，几分钟内验证你的运行时。

OpenConnector 是什么？为什么你需要它

想象一下：你的 AI Agent 想帮你"发一封 Gmail 邮件"、"创建一个 Notion 页面"、"查询 GitHub 仓库"——但它不该直接拿到你的邮箱密码或 API Token。

OpenConnector 就在 Agent 与 SaaS 服务之间加了一道安全的网关：

• 🔐凭据隔离：账号、Token、OAuth 密钥全部保存在运行时边界之后，Agent 拿不到任何凭据，只能看到安全的账号标签和执行结果。
• 🧩即用的 Action 目录：GitHub、Gmail、Slack、Notion、BigQuery、Airtable……1000+ 服务商开箱即用，每个 Action 都有可检查的输入/输出 Schema。
• 🚪多协议接入：同一批 Action 可以通过 SDK、CLI、MCP、HTTP / OpenAPI 四种方式使用，一次连接、处处调用。

它也是 Pipedream / Composio 的开源替代品，支持本地 Docker、Node.js、Cloudflare、Fly.io 等多种部署方式，详见 docs/quickstart.md。

准备工作：一键启动本地运行时

启动 OpenConnector 只需要Node.js 22+或Docker二选一。

方式一：从源码启动（推荐体验）

如果本地已有项目代码，直接运行：

npm install npm run dev

如果想克隆仓库，地址是https://gitcode.com/gh_mirrors/op/open-connector。

方式二：Docker Compose 一键启动

项目根目录已内置 docker-compose.yml，一条命令拉起预构建镜像：

docker compose up

启动后你会得到两个入口：

💡 本地运行时的状态默认保存在./data/connect.sqlite，无需手动建库。

第 1 步：执行第一个 Action（零凭据）

Hacker News不需要任何凭据，是验证运行时的最快方式。在终端执行：

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

返回统一格式的 JSON 响应（success/message/data），看到"success": true就说明运行时完全正常。项目里还提供了完整的 TypeScript 示例 examples/local-http/hackernews.ts，运行node examples/local-http/hackernews.ts即可看到同样的效果。

第 2 步：发现你需要的 Action

OpenConnector 内置 10000+ 个 Action，用三个接口就能"摸清家底"（详见 docs/runtime-api.md）：

# 列出所有提供 Action 的服务 curl -s http://localhost:3000/v1/actions # 查看某个服务的全部 Action 契约 curl -s "http://localhost:3000/v1/actions?service=hackernews" # 获取某个 Action 的 Agent 可读指南（Markdown） curl -s http://localhost:3000/api/actions/hackernews.get_top_stories/agent.md

每个 Action 都有可检查的契约：请求/响应 Schema、所需权限范围一目了然，Agent 在调用前就能"读懂"参数要求。

第 3 步：接入真实服务（API Key 一分钟搞定）

验证成功后，接一个真实服务也只需两条命令。以 GitHub 为例（它支持 Personal Access Token，最简单）：

# 1. 存储凭据（api_key 类型） curl -s -X PUT http://localhost:3000/api/connections/github \ -H 'content-type: application/json' \ -d '{"authType":"api_key","values":{"apiKey":"github_pat_..."}}' # 2. 执行需要凭据的 Action curl -s -X POST http://localhost:3000/v1/actions/github.get_current_user \ -H 'content-type: application/json' \ -d '{"input":{}}'

如果服务商使用 OAuth2（如 Gmail），Web 控制台里有完整的图形化流程：填写 OAuth 应用信息 → 复制回调地址 → 浏览器授权完成，整个过程无需写代码。更多凭据与 OAuth 配置细节见 docs/credentials.md。

进阶：4 种方式调用同一个 Action

连接建立后，同一批 Action 可以被不同生态无缝调用：

MCP 端点暴露了一组发现工具（list_apps、search_actions、execute_action等），你的 AI 客户端连上即可自动发现全部能力。完整的端点与鉴权说明见 docs/runtime-api.md，SDK 与 CLI 用法见 docs/sdk-cli.md。

常见问题

Q：本地运行时需要配置数据库吗？不需要。默认使用 SQLite，状态文件在./data/connect.sqlite。需要 PostgreSQL 时通过OOMOL_CONNECT_DATABASE_URL显式配置并先执行迁移。

Q：安全吗？我的凭据会不会泄露给 Agent？不会。所有凭据、Scope、执行日志都留在运行时边界内，Agent 只拿到执行结果和安全账号标签。生产环境建议设置OOMOL_CONNECT_ENCRYPTION_KEY加密存储凭据，以及OOMOL_CONNECT_ADMIN_TOKEN保护管理接口，详见 docs/configuration.md。

Q：想部署到云端怎么办？支持 Cloudflare（Workers + D1 + R2）、Fly.io、Kubernetes（deploy/helm/open-connector/）以及 OOMOL 托管运行时，同一套 Provider 与 Action 契约跨部署方式通用。

恭喜！到这里你已经完成了OpenConnector 快速上手的全流程：启动运行时 → 执行第一个 Action → 接入真实服务。接下来，可以打开 Web 控制台（http://localhost:3000）浏览 1000+ 服务商目录，找到你工作流中最需要的那个服务，让 AI Agent 真正"长出手"吧 🚀

【免费下载链接】open-connectorOpen-source auth gateway connecting 1000+ SaaS providers to AI agents through SDK, CLI, MCP, HTTP, and OpenAPI.项目地址: https://gitcode.com/gh_mirrors/op/open-connector