SDK

使用 Open Connector 官方 SDK，或将已有 Composio Client 指向兼容 API。

新集成优先使用 @open-connector/sdk。它调用原生 /api/v1 Contract，并共享请求与响应类型。迁移已有 @composio/client 代码时，可以继续使用 /composio 兼容挂载点。

安装与配置

pnpm add @open-connector/sdk

import { createClient } from "@open-connector/sdk";

const oc = createClient({
  apiKey: process.env.OPEN_CONNECTOR_API_KEY!,
  baseUrl: "https://api.openconnector.dev",
});

pnpm add @composio/client

import Composio from "@composio/client";

const composio = new Composio({
  apiKey: process.env.OPEN_CONNECTOR_API_KEY!,
  baseURL: "https://api.openconnector.dev/composio",
});

自托管部署请将 https://api.openconnector.dev 替换为自己的 Origin；只有 Composio Client 需要追加 /composio。

原生 SDK 能力

原生 Client 当前提供：

连接：initiate、connect、listConnections、getConnection、refreshConnection、revokeConnection、deleteConnection
Auth Config：createAuthConfig、listAuthConfigs、getAuthConfig
Toolkit 与 Tool：listToolkits、getToolkit、listTools、getTool、executeTool
底层凭证代理：proxy

常见操作

列出已连接账户

const accounts = await oc.listConnections({});

for (const account of accounts.items) {
  console.log(account.id, account.status);
}

const accounts = await composio.connectedAccounts.list({
  toolkit_slugs: "github",
});

for (const account of accounts.items) {
  console.log(account.id, account.status);
}

发起 OAuth 连接

const connection = await oc.initiate({
  slug: "github",
  authConfigId: "ac_01j9abc123",
  entityId: "user-from-your-app",
});

console.log(connection.redirectUrl);

const connection = await composio.connectedAccounts.create({
  auth_config: { id: "ac_01j9abc123" },
  connection: { user_id: "user-from-your-app" },
} as any);

console.log(connection.redirect_url);

执行 Tool

const result = await oc.executeTool({
  slug: "GITHUB_CREATE_AN_ISSUE",
  connectedAccountId: "conn_01j9xyz789",
  arguments: {
    owner: "my-org",
    repo: "my-repo",
    title: "Agent 发现了一个问题",
    body: "Agent 检测到生产环境存在异常。",
  },
});

const result = await composio.tools.execute("GITHUB_CREATE_AN_ISSUE", {
  connected_account_id: "conn_01j9xyz789",
  arguments: {
    owner: "my-org",
    repo: "my-repo",
    title: "Agent 发现了一个问题",
    body: "Agent 检测到生产环境存在异常。",
  },
});

Composio 兼容边界

兼容适配器覆盖仓库集成测试验证过的核心连接、Auth Config、Toolkit、Tool 发现、执行与代理工作流。兼容性以路由为单位，不代表 Composio 的全部产品能力都已实现。

Events、Triggers 与 Webhooks 当前仍是 WIP。在文档移除 WIP 标记前，请勿围绕这些能力构建生产工作流。

生产迁移前，请针对 Agent 实际使用的方法验证 Open Connector 实时 API。