@devries-cameron20 / composio Mirror · read-only
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 03:37 UTC

next
md 187 lines 9.04 KB
Rendered Raw
1 <p align="center">
2 <a href="https://composio.dev">
3 <picture>
4 <source media="(prefers-color-scheme: dark)" srcset="https://brand.composio.dev/logos/Logomark-White.svg">
5 <img alt="Composio logo" src="https://brand.composio.dev/logos/Logomark-Black.svg" width="96">
6 </picture>
7 </a>
8 </p>
9
10 <p align="center">
11 <a href="https://composio.dev"><b>composio.dev</b></a> •
12 <a href="https://docs.composio.dev">Documentation</a> •
13 <a href="https://docs.composio.dev/docs/quickstart">Quickstart</a> •
14 <a href="https://docs.composio.dev/reference/changelog">Changelog</a>
15 </p>
16
17 <p align="center">
18 <a href="https://github.com/ComposioHQ/composio/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/ComposioHQ/composio?style=social" /></a>
19 <a href="https://www.npmjs.com/package/@composio/core"><img alt="npm" src="https://img.shields.io/npm/v/@composio/core?label=%40composio%2Fcore" /></a>
20 <a href="https://pypi.org/project/composio/"><img alt="PyPI" src="https://img.shields.io/pypi/v/composio?label=composio" /></a>
21 <a href="https://discord.gg/composio"><img alt="Discord" src="https://img.shields.io/badge/discord-community-5865F2?logo=discord&logoColor=white" /></a>
22 <a href="https://hvtracker.net/agents/composio/"><img alt="HVTrust" src="https://hvtracker.net/badge/composio.svg" /></a>
23 </p>
24
25 # Composio
26
27 Composio gives your AI agents 1000+ pre-authenticated toolkits, per-user sessions, authentication, triggers, and a sandbox, so you can ship agents that turn intent into action.
28
29 This is the Composio SDK monorepo. It contains:
30
31 - **[`@composio/core`](ts/packages/core)**: TypeScript SDK
32 - **[`composio`](python)**: Python SDK
33 - **[`composio` CLI](ts/packages/cli)**: search, execute, and script tools from your shell
34 - **Provider adapters** for OpenAI Agents, Claude Agent SDK, Vercel AI SDK, LangChain, and [more](#providers)
35
36 ## Quickstart
37
38 Create a session for a user, hand its tools to your agent, and let the agent take action across 1000+ apps. Grab a `COMPOSIO_API_KEY` from the [dashboard](https://dashboard.composio.dev/settings) first.
39
40 ### TypeScript
41
42 ```bash
43 npm install @composio/core @composio/openai-agents @openai/agents
44 ```
45
46 > `@composio/core` intentionally packages its TypeScript source and SDK docs so the installed package is inspectable to coding agents. If you want a smaller install with the same API, use [`@composio/slim`](ts/packages/slim).
47
48 ```typescript
49 import { Composio } from "@composio/core";
50 import { OpenAIAgentsProvider } from "@composio/openai-agents";
51 import { Agent, run } from "@openai/agents";
52
53 const composio = new Composio({ provider: new OpenAIAgentsProvider() });
54
55 // Each session is scoped to one of your users
56 const session = await composio.create("user_123");
57 const tools = await session.tools();
58
59 const agent = new Agent({
60 name: "Personal Assistant",
61 instructions: "You are a helpful assistant. Use Composio tools to take action.",
62 tools,
63 });
64
65 const result = await run(agent, "Summarize my emails from today");
66 console.log(result.finalOutput);
67 ```
68
69 ### Python
70
71 ```bash
72 pip install composio composio-openai-agents openai-agents
73 ```
74
75 ```python
76 from composio import Composio
77 from composio_openai_agents import OpenAIAgentsProvider
78 from agents import Agent, Runner
79
80 composio = Composio(provider=OpenAIAgentsProvider())
81
82 # Each session is scoped to one of your users
83 session = composio.create(user_id="user_123")
84 tools = session.tools()
85
86 agent = Agent(
87 name="Personal Assistant",
88 instructions="You are a helpful assistant. Use Composio tools to take action.",
89 tools=tools,
90 )
91
92 result = Runner.run_sync(starting_agent=agent, input="Summarize my emails from today")
93 print(result.final_output)
94 ```
95
96 By default a session gets meta tools that discover, authenticate, and execute app tools at runtime, so you don't load hundreds of tool definitions into context. Store `session.session_id` and reuse it with `composio.use()` across turns. See [what a session is](https://docs.composio.dev/docs/how-composio-works) and [configuring sessions](https://docs.composio.dev/docs/configuring-sessions) for restricting toolkits, auth configs, and connected accounts.
97
98 **Prefer MCP?** Every session also exposes a hosted MCP endpoint. Pass `mcp: true` to `composio.create()` and point Claude, Cursor, or any MCP client at `session.mcp.url`. See [sessions via MCP](https://docs.composio.dev/docs/sessions-via-mcp).
99
100 ## CLI
101
102 The `composio` CLI runs Composio from your shell and gives coding agents like Claude Code a local tool surface.
103
104 ```bash
105 curl -fsSL https://composio.dev/install | sh
106 ```
107
108 The installer puts `composio` on your `PATH` for future terminals. Open a new terminal, then run `composio login`. See [INSTALL.md](INSTALL.md) for shell setup overrides, including `COMPOSIO_INSTALL_SHELL=none` for install-only runs.
109
110 Use `composio search` to find tools, `composio execute` to run them, `composio link` to connect accounts, and `composio run` to script workflows in TypeScript. See the [CLI docs](https://docs.composio.dev/docs/cli).
111
112 ## Providers
113
114 A provider adapts Composio tools to your agent framework's native tool format:
115
116 | Provider | TypeScript | Python |
117 |----------|:----------:|:------:|
118 | OpenAI | [`@composio/openai`](ts/packages/providers/openai) | [`composio-openai`](python/providers/openai) |
119 | OpenAI Agents | [`@composio/openai-agents`](ts/packages/providers/openai-agents) | [`composio-openai-agents`](python/providers/openai_agents) |
120 | Anthropic | [`@composio/anthropic`](ts/packages/providers/anthropic) | [`composio-anthropic`](python/providers/anthropic) |
121 | Claude Agent SDK | [`@composio/claude-agent-sdk`](ts/packages/providers/claude-agent-sdk) | [`composio-claude-agent-sdk`](python/providers/claude_agent_sdk) |
122 | Vercel AI SDK | [`@composio/vercel`](ts/packages/providers/vercel) | — |
123 | Google GenAI | [`@composio/google`](ts/packages/providers/google) | [`composio-gemini`](python/providers/gemini), [`composio-google`](python/providers/google) |
124 | Google ADK | — | [`composio-google-adk`](python/providers/google_adk) |
125 | LangChain | [`@composio/langchain`](ts/packages/providers/langchain) | [`composio-langchain`](python/providers/langchain) |
126 | LangGraph | via `@composio/langchain` | [`composio-langgraph`](python/providers/langgraph) |
127 | LlamaIndex | [`@composio/llamaindex`](ts/packages/providers/llamaindex) | [`composio-llamaindex`](python/providers/llamaindex) |
128 | Mastra | [`@composio/mastra`](ts/packages/providers/mastra) | — |
129 | Pi | [`@composio/experimental`](ts/packages/experimental)* | — |
130 | Cloudflare Workers AI | [`@composio/cloudflare`](ts/packages/providers/cloudflare) | — |
131 | TypeSafe (Jev) | [`@composio/typesafe`](ts/packages/providers/typesafe) | [`composio-typesafe`](python/providers/typesafe) |
132 | CrewAI | — | [`composio-crewai`](python/providers/crewai) |
133 | AutoGen | — | [`composio-autogen`](python/providers/autogen) |
134
135 \* *The [Pi provider](https://docs.composio.dev/docs/providers/pi) is experimental and ships from `@composio/experimental`.*
136
137 Don't see your framework? [Build a custom provider](https://docs.composio.dev/docs/providers/custom-providers), or skip providers entirely and connect over [MCP](https://docs.composio.dev/docs/sessions-via-mcp).
138
139 ## All packages
140
141 Everything published from this repo:
142
143 | Package | Description |
144 |---------|-------------|
145 | [`@composio/core`](ts/packages/core) | TypeScript SDK |
146 | [`@composio/slim`](ts/packages/slim) | `@composio/core` without packaged source or docs; same API, smaller install |
147 | [`composio` CLI](ts/packages/cli) | Standalone CLI binary: `curl -fsSL https://composio.dev/install \| sh` |
148 | [`@composio/experimental`](ts/packages/experimental) | Experimental integrations, including the Pi provider |
149 | [`@composio/json-schema-to-zod`](ts/packages/json-schema-to-zod) | JSON Schema to Zod conversion |
150 | `@composio/*` [provider adapters](#providers) | OpenAI, OpenAI Agents, Anthropic, Claude Agent SDK, Vercel, Google, LangChain, LlamaIndex, Mastra, Cloudflare, TypeSafe |
151 | [`composio`](python) | Python SDK |
152 | `composio-*` [provider adapters](#providers) | OpenAI, OpenAI Agents, Anthropic, Claude Agent SDK, Gemini, Google, Google ADK, LangChain, LangGraph, LlamaIndex, CrewAI, AutoGen, TypeSafe |
153
154 ## Repository layout
155
156 ```text
157 ts/ TypeScript SDK workspace
158 packages/core/ @composio/core
159 packages/providers/ Provider adapters
160 packages/cli/ Composio CLI
161 python/ Python SDK and provider packages
162 docs/ Documentation site (docs.composio.dev)
163 ```
164
165 The TypeScript SDK is tested against Node 22+; the Python SDK supports Python 3.11+.
166
167 ## Development
168
169 ```bash
170 mise install # pinned toolchain (Node, Python, pnpm)
171 pnpm install
172 pnpm build
173 pnpm test
174 ```
175
176 Python commands run from `python/`; see [`python/README.md`](python/README.md). We welcome contributions to both SDKs; read the [contribution guidelines](CONTRIBUTING.md) before submitting pull requests.
177
178 ## Support
179
180 - [Documentation](https://docs.composio.dev)
181 - [Discord community](https://discord.gg/composio)
182 - [Open an issue](https://github.com/ComposioHQ/composio/issues)
183 - [support@composio.dev](mailto:support@composio.dev)
184
185 ## License
186
187 MIT. See [LICENSE](LICENSE).