mirror of
https://github.com/ComposioHQ/composio.git
synced 2026-09-22 11:46:35 +08:00
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>
1.9 KiB
1.9 KiB
composio-crewai
Adapts Composio tools to CrewAI's BaseTool format so your crew's agents can act across 1000+ apps through a single Composio session.
Installation
pip install composio composio-crewai crewai
Set COMPOSIO_API_KEY (get one from dashboard.composio.dev/settings) and OPENAI_API_KEY in your environment:
export COMPOSIO_API_KEY=xxxxxxxxx
export OPENAI_API_KEY=xxxxxxxxx
Quickstart
Create a session for your user, fetch its tools, and pass them to an Agent. CrewAI runs the task end to end; each tool executes itself through Composio.
from crewai import Agent, Crew, Task
from composio import Composio
from composio_crewai import CrewAIProvider
composio = Composio(provider=CrewAIProvider())
# Each session is scoped to one of your users
session = composio.create(user_id="user_123")
tools = session.tools()
agent = Agent(
role="Email Agent",
goal="Send emails on behalf of the user",
backstory="You are an AI agent that sends emails using Gmail.",
tools=tools,
llm="gpt-5.2",
)
task = Task(
description="Send an email to john@example.com with the subject 'Hello' and body 'Hello from Composio!'",
agent=agent,
expected_output="Confirmation that the email was sent",
)
crew = Crew(agents=[agent], tasks=[task])
result = crew.kickoff()
print(result)
Error handling
Each Composio tool becomes a CrewAI BaseTool whose args_schema is built from the tool's input schema, so CrewAI validates arguments before running anything. When validation fails, the tool does not raise; it returns a structured result:
{"successful": False, "error": "<validation message>", "data": None}
Check successful in your task output instead of wrapping calls in try/except.