ContextQMD
Back to Composio

Composio SDK v3 Documentation

ts/docs/README.md

0.11.14.6 KB
Original Source

Composio SDK v3 Documentation

Composio SDK is a powerful toolkit that enables you to integrate third-party tools and services into your applications. This SDK helps you connect to various services (toolkits), execute tools, and manage user connections seamlessly.

Table of Contents

Overview

Composio SDK allows you to:

  • Execute tools from various services (like GitHub, Gmail, Slack, etc.)
  • Manage user connections to external services
  • Create custom tools
  • Implement triggers and event handlers
  • Integrate with AI providers like OpenAI

The SDK is designed to be flexible and extensible, allowing you to integrate it into various types of applications.

Installation

bash
npm install @composio/core

Core Concepts

The Composio SDK is built around several key concepts:

  • UserIds: Unique identifier for a user in your application (eg. UUID for a user in your database)
  • Tools: Individual actions that can be performed (e.g., "Get GitHub Repository", "Send Email")
  • Toolkits: Collections of related tools (e.g., GitHub, Gmail)
  • Connected Accounts: User connections to external services
  • Auth Configs: Authentication configurations for external services
  • Providers: Adapters for AI services that can use tools (e.g., OpenAI)
  • Custom Tools: Tools you can create and define yourself
  • MCP: Create and manage MCP Servers and clients

Check out the Core Concepts documentation for more detailed information.

Getting Started

Here's a quick example of how to use the Composio SDK:

typescript
import { Composio } from '@composio/core';

// Initialize the SDK
const composio = new Composio({
  apiKey: 'your-api-key',
});

// Get tools from a specific toolkit
const tools = await composio.tools.get('default', {
  toolkits: ['github'],
});

// Execute a tool
const result = await composio.tools.execute('GITHUB_GET_REPO', {
  userId: 'default',
  arguments: {
    owner: 'composio',
    repo: 'sdk',
  },
});

console.log(result.data);

For more detailed examples and tutorials, check out the Getting Started guide.

API Reference

The complete API reference documentation is available here:

Providers

Composio SDK comes with built-in support for different providers:

Non-Agentic Providers

Agentic Providers

Examples

Check out our examples directory for complete code samples:

Advanced Topics

Internal Documentation

For SDK maintainers and contributors: