GitHub Open Function

The GitHub Open Function is an implementation of the Open Functions architecture designed to seamlessly connect to GitHub. It enables language models (LLMs) to call methods inside GitHub such as listing branches, reading files, and committing changes through a simple and structured interface.

Installation

To install the GitHub Open Function, simply use Composer:

composer require assistant-engine/open-functions-github

Usage

Using the OpenAI PHP SDK

Below is a basic example of how to use the GitHub Open Function directly with the OpenAI PHP SDK:

<?php

use AssistantEngine\OpenFunctions\Github\GithubOpenFunction;
use AssistantEngine\OpenFunctions\Github\Models\Parameters;
use OpenAI;

// Set up parameters for GitHub authentication
$parameters = new Parameters();
$parameters->token = env('GITHUB_TOKEN');
$parameters->owner = env('GITHUB_OWNER');
$parameters->repository = env('GITHUB_REPOSITORY');

// Initialize the GitHub Open Function
$githubFunction = new GithubOpenFunction($parameters);

// Generate function definitions (for tool integration with an LLM)
$functionDefinitions = $githubFunction->generateFunctionDefinitions();

$client = OpenAI::client(env('OPENAI_TOKEN'));

$result = $client->chat()->create([
    'model' => 'gpt-4o',
    'messages' => [],
    'tools' => $functionDefinitions
]);

$choice = $result->choices[0];

if ($choice->finishReason === 'tool_calls') {
    $toolCalls = processToolCalls($choice->message->toolCalls, $githubFunction);
} 

function processToolCalls($toolCalls, AbstractOpenFunction $githubFunction)
{
    $result = [];

    foreach ($toolCalls as $toolCall) {
        // Extract the function name (already namespaced) and arguments
        $functionName = $toolCall->function->name;
        $functionArgs = json_decode($toolCall->function->arguments, true);

        $response = $githubFunction->callMethod($functionName, $functionArgs);
    }

    return $result;
}

Using the Filament Assistant Plugin

The GitHub Open Function can also be integrated as a tool within the Filament Assistant Plugin. To add it, include the following configuration in your config/filament-assistant.php file:

    // inside config/filament-assistant.php
    
    // Tools configuration: each tool is identified by a key.
    'tools' => [
        'github' => [
            'namespace'   => 'github',
            'description' => 'This is a demo github repository.',
            'tool'        => function () {
                $parameter = new \AssistantEngine\OpenFunctions\Github\Models\Parameters();
                $parameter->token = env('GITHUB_TOKEN');
                $parameter->owner = env('GITHUB_OWNER');
                $parameter->repository = env('GITHUB_REPOSITORY');

                return new \AssistantEngine\OpenFunctions\Github\GithubOpenFunction($parameter);
            },
        ]
    ]
    // ...

With this configuration in place, your assistant can directly utilize the GitHub tool to access repository functions. You can add multiple tools to enhance your assistant’s capabilities.

Methods

Method	Description	Parameters
listFiles	Lists all files (excluding directories) in the specified branch.	branchName: string (required)
readFiles	Reads the contents of specified files from a branch.	branchName: string (required); filenames: array of strings (required)
commitFiles	Modifies multiple files and commits the changes to the specified branch.	branchName: string (required); files: array of objects (required, each object must include:     • path: string     • content: string); commitMessage: string (required)

More Repositories

We’ve created more repositories to make AI integration even simpler and more powerful! Check them out:

• Open Functions Core: Open Functions provide a standardized way to implement and invoke functions for tool calling with large language models (LLMs).

We are a young startup aiming to make it easy for developers to add AI to their applications. We welcome feedback, questions, comments, and contributions. Feel free to contact us at [email protected].

Consultancy & Support

Do you need assistance integrating Open Functions into your application, or help setting it up?
We offer consultancy services to help you get the most out of our package, whether you’re just getting started or looking to optimize an existing setup.

Reach out to us at [email protected].

Contributing

We welcome contributions from the community! Feel free to submit pull requests, open issues, and help us improve the package.

License

This project is licensed under the MIT License. Please see License File for more information.