Composio Core

Warnings

• breaking The `composio-core` package is officially DEPRECATED and no longer supported. Continuing to use it may expose your application to unpatched security vulnerabilities (e.g., arbitrary command injection, file read vulnerabilities in older versions) and prevent access to new features and performance improvements.
  Fix: Migrate immediately to the `composio` package. Install with `pip install composio` and update your import statements from `composio_core` to `composio`. Refer to the official Composio documentation for migration guides.
• breaking Direct tool execution methods like `composio.tools.get()` and `composio.tools.execute()` are deprecated in the current `composio` SDK versions (0.6.0+). Using these methods directly without a session is discouraged and may lead to unexpected behavior or future breakage.
  Fix: Adopt the 'sessions' API for tool interactions. Initialize a session with `session = composio.create(user_id=...)` and then retrieve tools via `session.tools()`. This ensures proper context management, authentication, and framework integration. The Composio docs provide detailed quickstart guides for the session-based approach.
• breaking Starting with Python SDK v0.9.0 and TypeScript SDK v0.2.0 (for the `composio` library), manual tool execution (if still performed, though sessions are recommended) now requires explicit version specification. The `tools.execute()` method will fail without a version.
  Fix: When performing manual tool execution, explicitly provide the toolkit version either at the SDK initialization level (`composio = Composio(api_key=..., toolkit_versions={'toolkit_slug': 'YYYYMMDD_XX'})`) or directly within the `execute` call (`version='YYYYMMDD_XX'`). It is highly recommended to migrate to the session-based API which handles versioning automatically.
• gotcha Hardcoding API keys directly in your source code or configuration files is a security risk. API keys can be compromised if the code is exposed.
  Fix: Always use environment variables (e.g., `COMPOSIO_API_KEY`) to store sensitive credentials. For local development, use tools like `python-dotenv` to manage a `.env` file, but ensure this file is never committed to version control. For production, leverage your deployment platform's secret management solutions.

Install

• pip install composio-core Deprecated Installation
• pip install composio Recommended Installation (replacement library)

Imports

• Composio
  wrong:

  from composio_core import OpenAIToolSet

  correct:

  from composio import Composio

  The 'composio-core' package is deprecated. Use 'composio' instead for the main SDK entry point.

Quickstart

This quickstart demonstrates the recommended way to initialize and verify connectivity with the Composio platform using the 'composio' library. It fetches available tools for a specified user ID and requires `COMPOSIO_API_KEY` to be set as an environment variable. This example showcases the basic setup for interacting with Composio's toolkit management features.

import os
from composio import Composio

# Ensure COMPOSIO_API_KEY is set in your environment variables
# (e.g., in a .env file or directly in your shell)
composio = Composio(
    api_key=os.environ.get('COMPOSIO_API_KEY', '')
)

def verify_connection():
    try:
        # 'user-id-123' should be a unique identifier for your user
        # Toolkits specifies which sets of tools to load (e.g., HACKERNEWS, GITHUB)
        tools = composio.tools.get(user_id='user-id-123', toolkits=['HACKERNEWS'])
        print(f"Successfully connected! Found {len(tools)} tools.")
    except Exception as error:
        print(f"Connection failed: {error}")

if __name__ == '__main__':
    verify_connection()