Sourcegraph

Learn how to use Sourcegraph with Composio

Overview

SLUG: SOURCEGRAPH

Description

Sourcegraph is a code intelligence platform that enables developers to search, understand, and manage code across large codebases.

Authentication Details

bearer_token
stringRequired

Connecting to Sourcegraph

Create an auth config

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

1

Select App

Navigate to the Sourcegraph toolkit page and click “Setup Integration”.

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

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Sourcegraph 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=["SOURCEGRAPH"])
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 Site Settings Edit Permission

Description

Tool to check whether site settings can be edited through the api. use when you need to confirm the api allows site settings edits before attempting configuration changes.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Compare Commits

Description

Tool to compare two commits in a repository and retrieve their file diffs. use after confirming the repository name and commit shas to inspect differences.

Action Parameters

base
stringRequired
head
stringRequired
repo
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Commit Details

Description

Get detailed information about a specific commit in a repository.

Action Parameters

repo
stringRequired
rev
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Current User

Description

Tool to retrieve information about the currently authenticated user. use when needing confirmation of identity via sourcegraph graphql api.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get File Contents

Description

Tool to fetch the contents of a specified file on the default branch. use when you need raw file text without cloning the repo or using a slower code-host api.

Action Parameters

file_path
stringRequired
repo_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Repositories

Description

Tool to list repositories on the sourcegraph instance. use when you need to paginate through all available repositories.

Action Parameters

after
string
first
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Repository Files

Description

Tool to list all files and directories in a repository path. use when you need to enumerate files in a repository without cloning.

Action Parameters

path
string
recursive
booleanDefaults to True
repo_name
stringRequired
rev
stringDefaults to HEAD

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List repository languages

Description

Tool to list languages used in a repository. use when you need to determine the primary and all languages of a given repository; call after you have the repository name.

Action Parameters

repoName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired