docs/ai-agents/connectors/github/README.md
The Github agent connector is a Python package that equips AI agents to interact with Github through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.
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, discussions, organizations, teams, and users for development workflow analysis and project management insights.
The Github connector is optimized to handle prompts like these.
The Github connector isn't currently able to handle prompts like these.
uv pip install airbyte-agent-github
Connectors can run in open source or hosted mode.
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 {})
In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.
If your Airbyte client can access multiple organizations, also set organization_id.
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, AirbyteAuthConfig
connector = GithubConnector(
auth_config=AirbyteAuthConfig(
customer_name="<your_customer_name>",
organization_id="<your_organization_id>", # Optional for multi-org clients
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 {})
This connector supports the following entities and actions. For more details, see this connector's full reference documentation.
| Entity | Actions |
|---|---|
| Repositories | Get, List, API Search |
| Org Repositories | List |
| Branches | List, Get |
| Commits | List, Get |
| Releases | List, Get |
| Issues | List, Get, API Search |
| Pull Requests | List, Get, API Search |
| Reviews | List |
| Comments | List, Get |
| Pr Comments | List, Get |
| Labels | List, Get |
| Milestones | List, Get |
| Organizations | Get, List |
| Users | Get, List, API Search |
| Teams | List, Get |
| Tags | List, Get |
| Stargazers | List |
| Viewer | Get |
| Viewer Repositories | List |
| Projects | List, Get |
| Project Items | List |
| Discussions | List, Get, API Search |
| File Content | Get |
| Directory Content | List |
For all authentication options, see the connector's authentication documentation.
See the official Github API reference.