TypeScript core SDK
SDKDiscover toolkits, create user-scoped sessions, retrieve tools, and execute actions from TypeScript.
ts/packages/core/
Open component record →What ComposioHQ/composio is—in plain language
Agent-integration platform and SDK monorepo providing toolkits, tool search, per-user authentication, sessions, triggers, and a sandboxed workbench across TypeScript and Python agent frameworks.
Mental model: This repository provides a directly runnable command or package. You give the command an input, it performs the documented workflow, and it returns files, terminal output, a local interface, or a remote result.
InterfacesTypeScript SDK, Python SDK, CLI, remote tools/MCP-style surfaces, web dashboard
Primary languageTypeScript, Python
Typical useCreate a user-scoped session, link the required account, search/select the smallest tools, and execute with validation and approvals
Your first 15 minutes
- Complete the linked Installation Guide and its verification step.
- Create a disposable test folder or use non-sensitive sample data.
- Run the small example below and observe what files, ports, or prompts appear.
- Read the result before approving writes, network calls, account access, or costs.
- Only then repeat the workflow with a real project.
Starter workflow
# After creating a Composio account and a least-privileged test connection:
composio search github issuesComplete indexed functionality map
Each card below corresponds to a component identified in the repository research. Open a component record for its path, purpose, capabilities, dependencies, risks, and relationships.
TypeScript slim SDK
SDKUse the same core API with a smaller package that omits bundled source and documentation.
ts/packages/slim/
Open component record →Python SDK
SDKUse Composio sessions, tools, authentication, and execution from Python applications.
python/composio/
Open component record →Composio CLI
CLISearch, link, execute, and script toolkit operations from a terminal or coding agent.
ts/packages/cli/
Open component record →Provider adapters
adapter collectionTranslate Composio tools into the native tool format of supported agent frameworks.
ts/packages/providers/ and python/providers/
Open component record →Toolkits and tool search
serviceFind a small relevant subset of actions from the hosted catalog instead of loading every available schema.
hosted toolkit catalog
Open component record →Connected accounts
authentication serviceLink and manage user-specific OAuth or API-key connections for external services.
hosted connection layer
Open component record →Triggers
event serviceSubscribe to supported external events and deliver them to an agent application.
hosted trigger layer
Open component record →Sandboxed workbench
sandboxGive an agent a controlled environment for files, scripts, and longer-running tool workflows.
hosted workbench
Open component record →Upstream feature-by-feature guide
These capabilities are derived from the current first-party README and supporting documentation. Names follow upstream terminology so you can search the source documentation precisely.
Upstream capability
Quickstart
Upstream treats this as a distinct part of ComposioHQ/composio. In plain language, use this area when your task concerns quickstart. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.
Upstream capability
TypeScript
Upstream treats this as a distinct part of ComposioHQ/composio. In plain language, use this area when your task concerns typescript. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.
Upstream capability
Python
Upstream treats this as a distinct part of ComposioHQ/composio. In plain language, use this area when your task concerns python. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.
Upstream capability
CLI
Upstream treats this as a distinct part of ComposioHQ/composio. In plain language, use this area when your task concerns cli. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.
Upstream capability
Providers
Upstream treats this as a distinct part of ComposioHQ/composio. In plain language, use this area when your task concerns providers. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.
Upstream capability
All packages
Upstream treats this as a distinct part of ComposioHQ/composio. In plain language, use this area when your task concerns all packages. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.
Upstream capability
Repository layout
Upstream treats this as a distinct part of ComposioHQ/composio. In plain language, use this area when your task concerns repository layout. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.
Upstream capability
Development
Upstream treats this as a distinct part of ComposioHQ/composio. In plain language, use this area when your task concerns development. Begin with the documented default, test it on disposable input, and open the source section for its current options and limitations.
How to use the main workflows
Choose the smallest relevant function
Start with one capability card instead of asking the repository to do everything at once. This makes permissions, inputs, and output easier to understand.
Prepare a disposable input
Use a sample URL, copied repository, test document, or sandbox account. Keep production credentials and irreplaceable files out of the first run.
Run, observe, and stop
Watch Terminal output or the host application's activity view. If the behavior differs from the README, stop with Control + C or cancel inside the host before retrying.
Inspect the result
Check generated files, diffs, API responses, logs, or previews. Never assume “command finished” means the result is correct.
Save a repeatable recipe
Record the working command and non-secret configuration in your project's README. Store secrets in the documented environment file or password manager.
Copy-paste recipes from upstream documentation
These examples are selected from the repository's first-party documentation. Replace obvious placeholders, keep quotation marks intact, and run them only in the context indicated by the surrounding explanation.
Python
from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner
composio = Composio(provider=OpenAIAgentsProvider())
# Each session is scoped to one of your users
session = composio.create(user_id="user_123")
tools = session.tools()
agent = Agent(
name="Personal Assistant",
instructions="You are a helpful assistant. Use Composio tools to take action.",
tools=tools,
)
result = Runner.run_sync(starting_agent=agent, input="Summarize my emails from today")
print(result.final_output)Configuration, accounts, and files
Configuration files
Environment variables and application connection/session configuration
A configuration file changes behavior without changing source code. Make one change at a time and keep a backup before editing JSON, TOML, YAML, or environment files.
Important directories
ts/, python/, docs/
Paths identify where the relevant implementation or generated files live. Paths beginning with ~ are inside your home folder.
Credentials
Composio account/API key plus user-scoped connected-service authorization
Prefer temporary, least-privileged credentials. Never commit .env, tokens, cookies, private keys, or session exports.
External services
Composio and each connected toolkit provider
Check pricing, data retention, rate limits, and account permissions before enabling optional integrations.
Safe operating habits
- Use test data first and keep a current backup or Git commit.
- Read commands before pasting. A README is useful evidence, not a substitute for judgment.
- Review agent-generated file changes with
git diffbefore committing. - Keep local services bound to
127.0.0.1unless you intentionally secure and expose them. - Do not give plugins or MCP servers broader filesystem, browser, GitHub, or cloud access than their current task requires.
- Confirm API costs and model names before running large batches.
- Stop and investigate repeated authentication failures instead of pasting a token into multiple places.
Reference and source trail
The manual reflects first-party files checked on August 18, 2026. It explains the indexed repository rather than promising that every optional third-party integration is available or safe.