Back to Composio

Python SDK Reference

docs/content/reference/sdk-reference/python/index.mdx

0.11.12.3 KB
Original Source

Python SDK Reference

Complete API reference for the composio Python package.

Installation

bash
pip install composio

Or with uv:

bash
uv add composio

Classes

ClassDescription
ComposioComposio SDK for Python. Generic parameters: TTool: The individual tool type re...
ToolsTools class definition This class is used to manage tools in the Composio SDK. ...
ToolkitsToolkits are a collectiono of tools that can be used to perform various tasks. T...
TriggersTriggers (instance) class
ConnectedAccountsManage connected accounts. This class is used to manage connected accounts in t...
AuthConfigsManage authentication configurations.
MCPMCP (Model Control Protocol) class. Provides enhanced MCP server operations Thi...

Quick Start

python
from composio import Composio

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

# Get tools for a user
tools = composio.tools.get("user-123", toolkits=["github"])

# Execute a tool
result = composio.tools.execute(
    "GITHUB_GET_REPOS",
    arguments={"owner": "composio"},
    user_id="user-123"
)

Decorators

before_execute

View source

python
@before_execute(modifier: BeforeExecute | None = ..., tools: List[str | None] = ..., toolkits: List[str | None] = ...)
def my_modifier(...):
    ...

after_execute

View source

python
@after_execute(modifier: AfterExecute | None = ..., tools: List[str | None] = ..., toolkits: List[str | None] = ...)
def my_modifier(...):
    ...

schema_modifier

View source

python
@schema_modifier(modifier: SchemaModifier | None = ..., tools: List[str | None] = ..., toolkits: List[str | None] = ...)
def my_modifier(...):
    ...