Quick Start：通过 SaaS 控制台连接 GitHub
无需在本地运行 Open Connector，即可创建项目、连接 GitHub 账户并发起一次 Broker 工具调用。
这是当前最快的支持路径：使用托管控制台 app.openconnector.dev，然后让 Agent 调用托管 API。无需克隆仓库、准备数据库或运行本地服务。
本文使用 GitHub，让 OAuth 的凭证边界清晰可见。只要控制台中对应认证方式显示为可用，其他连接器也遵循同样的步骤。
创建工作区
- 打开 app.openconnector.dev，创建账户或登录。
- 完成引导：先创建组织，再创建项目。项目是 Agent Key 和已连接账户的隔离边界。
- 为项目取一个容易识别的名称，例如
Support agent — production。
创建项目 API Key
在选中的项目中，打开侧栏的 API Keys，选择 Create。立即复制明文 Key，并放入应用的密钥管理服务。
这个 Key 作为 Broker 请求的 x-api-key。它只属于当前项目，不能读取其他项目的连接。
export OPEN_CONNECTOR_API_KEY='oc_...'请把它视为仅服务端可用的机密。不要把它放进浏览器、移动端或源码仓库。控制台只会在创建或重新生成时显示明文 Key。
配置 GitHub 认证
打开 Auth Configs，点击 Create：
- 选择 GitHub 和可用的 OAuth 2.0 认证方式。
- 只有控制台标为可用时才选择 Platform Managed；否则选择 Your Own Credentials，填入 GitHub OAuth 应用的 Client ID 和 Client Secret。
- 使用自有 OAuth 应用时，请精确注册以下回调 URL：
https://api.openconnector.dev/api/v1/connectors/github/callback- 创建 Auth Config。它定义项目内 GitHub 账户的认证方式，但还不是用户连接。
连接账户
在 Auth Configs 中打开新建 GitHub 配置的菜单，选择 Connect account。输入产品中使用的稳定用户 ID，例如 user_123，然后选择 Connect。
Open Connector 会在新窗口发起 GitHub 授权。授权完成后，Connections 页面会显示 active 连接；复制其 connection ID。
面向最终用户的产品请使用 Connections → Connect link：它生成可发送给用户的短期托管链接，应用无需接触用户凭证。
从 Agent 调用 GitHub 工具
默认使用 Open Connector 官方 SDK；如果正在迁移已有集成，可以切换到 Composio 兼容 Client：
import { createClient } from "@open-connector/sdk";
const oc = createClient({
apiKey: process.env.OPEN_CONNECTOR_API_KEY!,
baseUrl: "https://api.openconnector.dev",
});
const result = await oc.executeTool({
slug: "GITHUB_CREATE_AN_ISSUE",
connectedAccountId: "conn_...",
arguments: {
owner: "acme",
repo: "support",
title: "Created by the support agent",
body: "The agent used a brokered GitHub connection.",
},
});
console.log(result.data);import Composio from "@composio/client";
const composio = new Composio({
apiKey: process.env.OPEN_CONNECTOR_API_KEY!,
baseURL: "https://api.openconnector.dev/composio",
});
const result = await composio.tools.execute("GITHUB_CREATE_AN_ISSUE", {
connected_account_id: "conn_...",
arguments: {
owner: "acme",
repo: "support",
title: "Created by the support agent",
body: "The agent used a brokered GitHub connection.",
},
});
console.log(result.data);Broker 会在 API Key 所属项目中找到连接，并在服务端注入 GitHub 凭证、记录本次凭证使用。Agent 代码只获得 GitHub 的响应，不会获得 OAuth Token。
验证集成
用控制台中复制的 connection ID 验证 Broker 是否能读取项目范围内的连接：
curl "https://api.openconnector.dev/composio/api/v3.1/connected_accounts/conn_..." \
-H "x-api-key: $OPEN_CONNECTOR_API_KEY"active 连接只返回元数据与状态，不会返回凭证。如果连接不存在或 Key 属于其他项目，Broker 不会泄露该资源。