本仓库包含 Composio 的官方软件开发工具包（SDK），为 Python 和 TypeScript 智能体框架及库提供无缝集成能力。

快速入门

TypeScript SDK 安装

# 使用 npm
npm install @composio/core

# 使用 yarn
yarn add @composio/core

# 使用 pnpm
pnpm add @composio/core

快速开始：

import { Composio } from '@composio/core';
// 初始化 SDK
const composio = new Composio({
  // apiKey: 'your-api-key',
});

使用 OpenAI Agents 的简单智能体

npm install @composio/openai-agents @openai/agents

import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, run } from '@openai/agents';

const composio = new Composio({
  provider: new OpenAIAgentsProvider(),
});

const userId = 'user@acme.org';

const tools = await composio.tools.get(userId, {
  toolkits: ['HACKERNEWS'],
});

const agent = new Agent({
  name: 'Hackernews 助手',
  tools: tools,
});

const result = await run(agent, '最近关于 HackerNews 的帖子是什么？');

console.log(JSON.stringify(result.finalOutput, null, 2));
// 将返回来自 HackerNews API 的响应。

Python SDK 安装

# 使用 pip
pip install composio

# 使用 poetry
poetry add composio

快速开始：

from composio import Composio

composio = Composio(
  # api_key="your-api-key",
)

使用 OpenAI Agents 的简单智能体

pip install composio_openai_agents openai-agents

import asyncio
from agents import Agent, Runner
from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider

# 使用 OpenAI Agents 提供者初始化 Composio 客户端
composio = Composio(provider=OpenAIAgentsProvider())

user_id = "user@acme.org"
tools = composio.tools.get(user_id=user_id, toolkits=["HACKERNEWS"])

# 创建一个带有工具的智能体
agent = Agent(
    name="Hackernews 智能体",
    instructions="你是一个有用的助手。",
    tools=tools,
)

# 运行智能体
async def main():
    result = await Runner.run(
        starting_agent=agent,
        input="最近关于 HackerNews 的帖子是什么？",
    )
    print(result.final_output)

asyncio.run(main())
# 将返回来自 HackerNews API 的响应。

更多详细的使用说明和示例，请参阅各 SDK 的专用文档。

OpenAPI 规范

要更新用于生成 SDK 文档的 OpenAPI 规范：

# 从后端拉取最新的 API 规范
pnpm api:pull

此命令会从 https://backend.composio.dev/api/v3/openapi.json 拉取 OpenAPI 规范，并更新本地的 API 文档文件。

该步骤会在构建时自动执行。

可用 SDK

TypeScript SDK (/ts)

TypeScript SDK 提供了一种现代化、类型安全的方式来与 Composio 的服务进行交互。它专为 Node.js 和浏览器环境设计，全面支持 TypeScript，并配有详尽的类型定义。

有关 TypeScript SDK 的详细信息，请参阅 TypeScript SDK 文档。

Python SDK (/python)

Python SDK 为 Composio 的服务提供了符合 Python 风格的接口，便于将 Composio 轻松集成到您的 Python 应用程序中。它支持 Python 3.10 及以上版本，并遵循现代 Python 开发实践。

有关 Python SDK 的详细信息，请参阅 Python SDK 文档。

提供者支持

下表展示了各 SDK 支持的 AI 框架和平台：

提供者	TypeScript	Python
OpenAI	✅	✅
OpenAI Agents	✅	✅
Anthropic	✅	✅
LangChain	✅	✅
LangGraph	✅*	✅
LlamaIndex	✅	✅
Vercel AI SDK	✅	❌
Google Gemini	✅	✅
Google ADK	❌	✅
Mastra	✅	❌
Cloudflare Workers AI	✅	❌
CrewAI	❌	✅
AutoGen	❌	✅

* LangGraph 在 TypeScript 中可通过 @composio/langchain 包支持。

未找到您的提供者？ 请参阅 构建自定义提供者 的指南，以集成任何 AI 框架。

软件包

核心软件包

软件包	版本
TypeScript
@composio/core
Python
composio

供应商包

包名	版本
TypeScript
@composio/openai
@composio/openai-agents
@composio/anthropic
@composio/langchain
@composio/llamaindex
@composio/vercel
@composio/google
@composio/mastra
@composio/cloudflare
Python
composio-openai
composio-openai-agents
composio-anthropic
composio-langchain
composio-langgraph
composio-llamaindex
composio-crewai
composio-autogen
composio-gemini
composio-google
composio-google-adk

工具包

包名	版本
@composio/json-schema-to-zod
@composio/ts-builders

如果您正在寻找旧版 SDK，可以在此处找到：这里

Rube

Rube 是一个基于 Composio 构建的模型上下文协议（MCP）服务器。它可将您的 AI 工具连接到 500 多款应用，如 Gmail、Slack、GitHub 和 Notion。只需将其安装在您的 AI 客户端中，一次性完成应用认证，即可让您的 AI 执行实际操作，例如“发送电子邮件”或“创建任务”。

Rube 可与 Cursor、Claude Desktop、VS Code、Claude Code 等主流 AI 客户端以及任何兼容 MCP 的自定义客户端集成。您可以在这些客户端之间切换，而您的集成设置会随身携带。

贡献

我们欢迎对这两个 SDK 的贡献！请在提交拉取请求之前阅读我们的贡献指南。

许可证

本项目采用 MIT 许可证授权——详情请参阅 LICENSE 文件。

支持

如果您遇到任何问题或对 SDK 有任何疑问：

• 在此仓库中提交一个问题
• 联系我们的支持团队
• 查看我们的文档

Composio SDK 快速上手指南

Composio 是一个旨在为 AI Agent 提供进化能力的工具集，支持无缝集成 Python 和 TypeScript 生态中的主流 Agentic 框架（如 LangChain, OpenAI Agents, CrewAI 等），让 Agent 能够轻松调用 500+ 应用（如 Gmail, Slack, GitHub）的 API。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统: Windows, macOS 或 Linux
• Python 用户:
  • Python 3.10 或更高版本
  • 包管理工具：pip 或 poetry
• TypeScript/Node.js 用户:
  • Node.js (建议 LTS 版本)
  • 包管理工具：npm, yarn 或 pnpm
• API Key: 虽然示例中可省略，但生产环境建议在 Composio 官网 获取 API Key。

国内开发者提示：如果遇到安装速度慢的问题，建议使用国内镜像源。

• Python: pip install -i https://pypi.tuna.tsinghua.edu.cn/simple <package>
• Node.js: 配置 .npmrc 使用淘宝镜像 (registry=https://registry.npmmirror.com)

---

安装步骤

根据您的开发语言选择对应的安装方式。

选项 A：Python SDK

使用 pip 安装核心包：

pip install composio

或者使用 poetry：

poetry add composio

如果您计划结合特定的 AI 框架（例如 OpenAI Agents），还需安装对应的提供者包：

pip install composio_openai_agents openai-agents

选项 B：TypeScript SDK

使用 npm 安装核心包：

npm install @composio/core

或者使用 yarn / pnpm：

yarn add @composio/core
# 或
pnpm add @composio/core

若需结合 OpenAI Agents，请额外安装：

npm install @composio/openai-agents @openai/agents

---

基本使用

以下示例展示如何初始化 Composio 并创建一个能够访问 HackerNews 数据的简单 Agent。

Python 示例 (配合 OpenAI Agents)

import asyncio
from agents import Agent, Runner
from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider

# 1. 初始化 Composio 客户端并指定 Provider
composio = Composio(provider=OpenAIAgentsProvider())

user_id = "user@acme.org"

# 2. 获取工具集 (例如: HACKERNEWS)
tools = composio.tools.get(user_id=user_id, toolkits=["HACKERNEWS"])

# 3. 创建 Agent 并注入工具
agent = Agent(
    name="Hackernews Agent",
    instructions="You are a helpful assistant.",
    tools=tools,
)

# 4. 运行 Agent
async def main():
    result = await Runner.run(
        starting_agent=agent,
        input="What's the latest Hackernews post about?",
    )
    print(result.final_output)

if __name__ == "__main__":
    asyncio.run(main())

TypeScript 示例 (配合 OpenAI Agents)

import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, run } from '@openai/agents';

// 1. 初始化 Composio 客户端并指定 Provider
const composio = new Composio({
  provider: new OpenAIAgentsProvider(),
});

const userId = 'user@acme.org';

// 2. 获取工具集 (例如: HACKERNEWS)
const tools = await composio.tools.get(userId, {
  toolkits: ['HACKERNEWS'],
});

// 3. 创建 Agent 并注入工具
const agent = new Agent({
  name: 'Hackernews assistant',
  tools: tools,
});

// 4. 运行 Agent
const result = await run(agent, 'What is the latest hackernews post about?');

console.log(JSON.stringify(result.finalOutput, null, 2));
// 输出将包含来自 HACKERNEWS API 的数据响应

注意：Composio 支持多种 AI 框架（如 LangChain, LlamaIndex, CrewAI, AutoGen 等）。只需更换导入的 Provider 包和初始化代码，即可在不同框架间切换。详细用法请参考官方文档。