Code Sharing

Gist

Learn how to use Gist with Composio

Overview

SLUG: GIST

Description

GitHub Gist is a service provided by GitHub that allows users to share code snippets, notes, and other text-based content. It supports both public and private gists, enabling easy sharing and collaboration.

Authentication Details

generic_api_key
stringRequired

Connecting to Gist

Create an auth config

Use the dashboard to create an auth config for the Gist toolkit. This allows you to connect multiple Gist accounts to Composio for agents to use.

1

Select App

Navigate to Gist.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Gist Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4gist_auth_config_id = "ac_YOUR_GIST_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Gist for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, gist_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Gist toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["GIST"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Check Gist Star

Description

Tool to check if a gist is starred. Use when you need to determine if the authenticated user has starred a specific gist.

Action Parameters

gist_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Gist Comment

Description

Tool to delete a comment on a gist. Use when you have both the gist_id and comment_id and want to remove that comment. Example prompt: "Delete comment 42 from gist 'aa5a315d61ae9438b18d'".

Action Parameters

comment_id
integerRequired
gist_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Gist

Description

Tool to retrieve a specific gist by its ID. Use when you have a gist_id and need complete gist details.

Action Parameters

gist_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Gist Comment

Description

Tool to get a specific comment on a gist. Use when you need to retrieve details of a particular comment given gist_id and comment_id.

Action Parameters

comment_id
integerRequired
gist_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Gist Revision

Description

Tool to retrieve a specific gist revision. Use when you need details of a past state for an existing gist by commit SHA.

Action Parameters

gist_id
stringRequired
sha
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Gist Comments

Description

Tool to list comments on a gist. Use after confirming the gist_id to retrieve comments for a specific gist. Example: 'List comments for gist abc123'.

Action Parameters

gist_id
stringRequired
page
integer
per_page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Gist Commits

Description

Tool to list the commit history of a gist. Use after you have the gist ID to review its revisions.

Action Parameters

accept
string
gist_id
stringRequired
page
integerDefaults to 1
per_page
integerDefaults to 30

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Gist Forks

Description

Tool to list forks of a gist. Use after obtaining a gist_id to retrieve all forks for the gist.

Action Parameters

gist_id
stringRequired
page
integer
per_page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Gists

Description

Tool to list the authenticated user's gists or all public gists if called anonymously. Use after setting a valid GitHub token in headers.

Action Parameters

accept
string
page
integer
per_page
integer
since
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: List Starred Gists

Description

Tool to list the authenticated user's starred gists. Use when you need to retrieve all gists the user has starred.

Action Parameters

accept
string
page
integerDefaults to 1
per_page
integerDefaults to 30
since
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List User Gists

Description

Tool to list public gists for a specified GitHub user. Use when you have a username and need their gists.

Action Parameters

page
integer
per_page
integer
since
string
username
stringRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Unstar Gist

Description

Tool to unstar a gist. Use after confirming the gist has been previously starred.

Action Parameters

gist_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Gist Comment

Description

Tool to update a Gist comment. Use when you need to modify an existing comment after confirming the gist_id and comment_id.

Action Parameters

body
stringRequired
comment_id
integerRequired
gist_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired