Skip to main content

Github agent connector

GitHub is a platform for version control and collaborative software development using Git. This connector provides access to repositories, branches, commits, issues, pull requests, reviews, comments, releases, organizations, teams, and users for development workflow analysis and project management insights.

Example questions

The Github connector is optimized to handle prompts like these.

  • Show me all open issues in my repositories this month
  • List the top 5 repositories I've starred recently
  • Analyze the commit trends in my main project over the last quarter
  • Find all pull requests created by {team_member} in the past two weeks
  • Search for repositories related to machine learning in my organizations
  • Compare the number of contributors across my different team projects
  • Identify the most active branches in my main repository
  • Get details about the most recent releases in my organization
  • List all milestones for our current development sprint
  • Show me insights about pull request review patterns in our team

Unsupported questions

The Github connector isn't currently able to handle prompts like these.

  • Create a new issue in the project repository
  • Update the status of this pull request
  • Delete an old branch from the repository
  • Schedule a team review for this code
  • Assign a new label to this issue

Installation

uv pip install airbyte-agent-github

Usage

Connectors can run in open source or hosted mode.

Open source

In open source mode, you provide API credentials directly to the connector.

from airbyte_agent_github import GithubConnector
from airbyte_agent_github.models import GithubPersonalAccessTokenAuthConfig

connector = GithubConnector(
auth_config=GithubPersonalAccessTokenAuthConfig(
token="<GitHub personal access token (fine-grained or classic)>"
)
)

@agent.tool_plain # assumes you're using Pydantic AI
@GithubConnector.tool_utils
async def github_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

from airbyte_agent_github import GithubConnector

connector = GithubConnector(
external_user_id="<your-scoped-token>",
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)

@agent.tool_plain # assumes you're using Pydantic AI
@GithubConnector.tool_utils
async def github_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})

Full documentation

This connector supports the following entities and actions.

EntityActions
RepositoriesGet, List, Api_search
Org RepositoriesList
BranchesList, Get
CommitsList, Get
ReleasesList, Get
IssuesList, Get, Api_search
Pull RequestsList, Get, Api_search
ReviewsList
CommentsList, Get
Pr CommentsList, Get
LabelsList, Get
MilestonesList, Get
OrganizationsGet, List
UsersGet, List, Api_search
TeamsList, Get
TagsList, Get
StargazersList
ViewerGet
Viewer RepositoriesList
ProjectsList, Get
Project ItemsList

For all authentication options, see the connector's authentication documentation.

For detailed documentation on available actions and parameters, see this connector's full reference documentation.

For the service's official API docs, see the Github API reference.

Version information

  • Package version: 0.18.62
  • Connector version: 0.1.8
  • Generated with Connector SDK commit SHA: 609c1d86c76b36ff699b57123a5a8c2050d958c3