mirror of
https://github.com/ComposioHQ/composio.git
synced 2026-09-22 11:46:35 +08:00
Rahul Tarak
caef908075
## Summary Rewrites the stale root `README.md` against the current docs (structure modeled on [earendil-works/pi](https://github.com/earendil-works/pi)'s README). - **Quickstarts** now use the session-based API (`composio.create()` → `session.tools()`) that the docs treat as canonical, replacing the legacy `composio.tools.get()` flow - **Positioning** matches the docs welcome page: 1000+ pre-authenticated toolkits, per-user sessions, auth, triggers, and a sandbox - **New sections**: CLI install (curl / Homebrew / npm), sessions-via-MCP note, repository layout, minimum runtime versions - **Provider table** merged with package links; adds the Claude Agent SDK providers (both SDKs) and the experimental Pi provider (`@composio/experimental`); documents the Python `composio-gemini`/`composio-google`/`composio-google-adk` split - **Removed**: Rube section (no longer in docs), cover banner (replaced with theme-adaptive brand logomark from brand.composio.dev), master-branch pointer, internal OpenAPI-pull section, private `@composio/ts-builders` listing Docs-only change — no changeset needed. ## Preview Rendered view: [README.md on this branch](https://github.com/ComposioHQ/composio/blob/docs/refresh-root-readme/README.md) 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2.1 KiB
2.1 KiB
Composio TypeScript providers
Each package in this directory adapts Composio tools to one agent framework's native tool format. You pass a provider to new Composio({ provider }), and session.tools() returns tools your framework can call directly.
Packages
| Package | Framework |
|---|---|
@composio/openai |
OpenAI Chat Completions and Responses APIs |
@composio/openai-agents |
OpenAI Agents SDK |
@composio/anthropic |
Anthropic Messages API |
@composio/claude-agent-sdk |
Claude Agent SDK |
@composio/vercel |
Vercel AI SDK |
@composio/google |
Google GenAI |
@composio/langchain |
LangChain and LangGraph |
@composio/llamaindex |
LlamaIndex |
@composio/mastra |
Mastra |
@composio/cloudflare |
Cloudflare Workers AI |
Each package README has an install command and a runnable quickstart.
Provider types
Providers extend one of two base classes from @composio/core:
- Non-agentic (
BaseNonAgenticProvider): format tool schemas for a raw model API (OpenAI, Anthropic, Cloudflare). Your code runs the tool loop, calling helpers likeexecuteToolCallorhandleToolCallson the provider. - Agentic (
BaseAgenticProvider): wrap tools with an execute function baked in (LangChain, LlamaIndex, Mastra, Vercel, OpenAI Agents). The framework runs the tool loop itself.
Creating a new provider
Scaffold a package from the repository root:
pnpm create:provider <provider-name> [--agentic]
This creates ts/packages/providers/<provider-name> with src/index.ts, package.json, and build config. Implement wrapTool and wrapTools (plus executeToolCall for non-agentic providers), then add tests covering wrapping and execution handling.
If you are building an adapter outside this repo, see the custom providers guide.