🚀 Quick Start - Tools

Learn how to use Tools in less than 5 minutes

Star A Repository on GitHub

In this guide, we’ll:

1. 🔐 Connect your GitHub account with Composio
2. 🛠 Fetch GitHub actions
3. 🧠 Pass these actions to an LLM
4. ⭐ Instruct to star the composiohq/composio repository
5. ✅ Execute the action

Tools represent a group of actions specific to an app. Actions are operations you can perform - like starring a repo on GitHub or creating an issue in Linear.

Python

1. Install Libraries

   CLI

   pip install composio_core composio_openai
   
2. Connect Your GitHub Account

   We’ll use default as the user id, also known as entity id.

   CLI

   composio login 
   composio add github -e "default"
   

   Don’t forget to set your COMPOSIO_API_KEY and OPENAI_API_KEY in your environment variables.

3. Initialise Composio Toolset and OpenAI

   Python

   from composio_openai import ComposioToolSet, App
   from openai import OpenAI
   
   openai_client = OpenAI()
   composio_toolset = ComposioToolSet(entity_id="default")
   
4. Fetch Github Actions, and pass them to LLM

   Python

   tools = composio_toolset.get_tools(apps=[App.GITHUB])
   
   task = "Star the repo composiohq/composio on GitHub"
   
   response = openai_client.chat.completions.create(
       model="gpt-4o",
       tools=tools,
       messages=[
           {"role": "system", "content": "You are a helpful assistant."},
           {"role": "user", "content": task},
       ],
   )
   

   Composio also supports action executions without LLMs or agents. Learn more.

5. Execute Tool Calls

   Python

   result = composio_toolset.handle_tool_calls(response)
   print(result)
   

JavaScript

1. Install Libraries

   CLI

   npm install composio-core openai
   
2. Connect Your GitHub Account

   We’ll use default as the user id (entity id).

   CLI

   composio login
   composio add github
   
3. Initialise Composio's OpenAIToolSet and OpenAI

   JavaScript

   import { OpenAI } from "openai";
   import { OpenAIToolSet } from "composio-core";
   
   const openai_client = new OpenAI();
   const composio_toolset = new OpenAIToolSet();
   

   Don’t forget to set your COMPOSIO_API_KEY and OPENAI_API_KEY in your environment variables.

4. Fetch GitHub Actions & and pass them to LLM

   JavaScript

   const tools = await composio_toolset.getTools({
       actions: ["github_star_a_repository_for_the_authenticated_user"],
   });
   
   const instruction = "Star the repo composiohq/composio on GitHub";
   
   const response = await openai_client.chat.completions.create({
       model: "gpt-4o",
       messages: [{ role: "user", content: instruction }],
       tools: tools,
       tool_choice: "auto",
   });
   

   Composio also supports action executions without LLMs or agents. Learn more.

5. Execute Tool Calls

   JavaScript

   const result = await composio_toolset.handleToolCall(response);
   console.log(result);
   

Next Steps

Now that you’ve seen how to use tools, you can explore the following resources:

Tools

Checkout our toolset of 250+ LLM ready tools to build powerful AI applications

Connections

Learn how to create and manage connections for your users

Compatible Agentic Frameworks

Integrate with popular agentic frameworks

Kits

Composio SWE Kit (#4 on SWE bench) - Your ultimate coding companion

Triggers

Subscribe to triggers to execute actions automatically

Other Concepts

Learn about workspace environments, using CLI & other concepts