GitHub
A connector to the GitHub platform for repository, issue, and pull request management.
📝 Note: This connector gives agents GitHub API tools. To use
gitandghin a chat sandbox, see Work with GitHub from chat.
What you can ask
- Triage open issues across our org. Assign me to anything labeled
priority:highand post a daily digest in Slack. - Open a pull request from
feature/billing-refactorintomainwith the changelog as the description and request review from the platform team. - Find every open PR that hasn't had a review in three days and DM the assigned reviewer.
- Summarize what landed in our production repos this week. Group by author.
Set up
GitHub connects with credentials from your GitHub account. Have these values ready:
- Access token
- Go to Organization > Connectors and find GitHub.
- Click Enable and choose which tools to allow.
- Each member enters their own values the first time they use it.
To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.
Tools
GitHub offers 154 tools. Admins choose which ones agents can use. See Tool permission groups.
Read (83)
View and search information without changing it.
| Tool | What it does |
|---|---|
check_following | Check whether one user follows another user. |
check_if_merged | Check if a pull request has been merged and get merge details if applicable |
check_starred | Check if the authenticated user has starred a repository |
check_team_membership | Check a user's membership in a team, including its state (active vs pending invitation) and role |
compare_commits | Compare two commits, branches, or tags. basehead uses 'BASE...HEAD' syntax, e.g. 'main...my-feature' or 'v1.0.0...v2.0.0' (cross-fork: 'owner:branch'). |
get_artifact_download_url | Get a short-lived download URL for a workflow run artifact's zip archive (the URL expires after about 1 minute). |
get_authenticated_user | Get the authenticated user's profile information including public and private details |
get_blob | Read a file's raw content by its blob SHA. |
get_branch_protection | Get effective branch protection: classic branch protection, falling back to repository and organization rulesets. protection_source says which applies ('classic', 'ruleset', 'none'); protected=false only when neither does. |
get_branches | Get repository branches with optional filtering by protection status. |
get_check_run_annotations | Get a check run's annotations: the file, line range and message for each problem the check reported. |
get_check_runs | Get check runs for a specific commit or ref (Checks API). |
get_check_suite_runs | List the check runs inside one check suite. |
get_check_suites | List the check suites for a commit or ref. |
get_commit | Get a single commit by SHA with detailed information including file changes, statistics, and parent commits. |
get_commit_status | Get the combined status for a specific commit or ref (legacy statuses API). |
get_commits | Get repository commits with filtering options by author, date range, file path, and branch/SHA |
get_discussion | Get a discussion by number including body, category, author, comment count, and answer info. |
get_discussion_comments | Get a discussion's comments and their threaded replies, flattened with each reply after its parent (reply_to_node_id links them). |
get_file_contents | Get file or directory contents from a repository. |
get_followers | Get a list of users who follow a specific user. |
get_following | Get a list of users that a specific user follows. |
get_gist | Get a specific gist by ID including all file contents |
get_issue | Get a single issue by number from a specific repository. |
get_issue_comments | Get comments for a specific issue. |
get_issues | Get a list of issues from a repository with filtering by state, labels, assignee, creator, and more. |
get_job_logs | Get log content for a workflow job. |
get_label | Get a single repository label by name. |
get_latest_release | Get the latest release for a repository. |
get_notification | Get details for a specific notification thread by ID. |
get_organization | Get detailed information about a GitHub organization by its name |
get_organization_members | Get members of an organization with filtering options by role and 2FA status |
get_organization_teams | Get teams in an organization. |
get_pull_request | Get a single pull request by number from a specific repository. |
get_pull_request_checks | Get an overall CI status summary for a PR's head commit, including checks and legacy status |
get_pull_request_commits | Get commits in a pull request showing the individual changes that make up the PR. |
get_pull_request_diff | Get the unified diff for a pull request as plain text. |
get_pull_request_files | Get the files changed in a pull request with additions, deletions, and change counts. |
get_pull_request_reviews | Get reviews for a pull request including approval status, comments, and reviewer information |
get_pull_requests | Get a list of pull requests from a repository with filtering options by state, head/base branches, and sorting. |
get_release_by_tag | Get a release by its tag name (e.g. 'v1.0.0'). |
get_releases | Get repository releases including tags, assets, and release notes. |
get_repositories | List ONLY the authenticated user's repositories (owned, collaborator, or org member). |
get_repository | Get a single repository by owner and name. |
get_repository_archive_url | Get a short-lived download URL for a repository archive (zip or tar) at a branch, tag or commit. |
get_repository_tree | Get the file tree for a repository. |
get_team_members | Get members of a specific team with filtering by role (member or maintainer) |
get_user | Get detailed information about any GitHub user by their username |
get_user_events | Get public events for a user showing their recent GitHub activity. |
get_user_memberships | Get the authenticated user's organization memberships including private memberships. |
get_user_organizations | Get organizations that a user is publicly a member of |
get_user_starred_repos | Get repositories starred by a user, sorted by star time (created) or last push (updated), with pagination |
get_workflow | Get a specific workflow by ID or filename (e.g. 'ci.yml'). |
get_workflow_run | Get details for a specific workflow run including status, conclusion, and timing. |
list_assignees | List users who can be assigned to issues in a repository. |
list_deployment_statuses | List the statuses recorded against one deployment, newest first. |
list_deployments | List a repository's deployments, optionally filtered by commit SHA, ref or environment. |
list_discussion_categories | List discussion categories in a repository. |
list_discussions | List discussions in a repository with server-side filters: category (node ID or slug, use list_discussion_categories first), answered, state (OPEN/CLOSED), and sort by created/updated time. |
list_environment_secrets | List the names of secrets configured on a repository environment. |
list_environments | List the deployment environments configured on a repository. |
list_gists | List gists for the authenticated user or a specific user. |
list_issue_types | List an organization's issue types (e.g. Bug, Task). Use the returned 'name' values as the type in create_issue/update_issue. Only available for organization-owned repositories |
list_labels | List labels for a repository with pagination |
list_milestones | List a repository's milestones with state, sort, and pagination options. |
list_notifications | List notifications for the authenticated user. |
list_pull_request_review_threads | List review threads on a pull request with resolution status, file path, and comments. |
list_repository_collaborators | List collaborators for a repository. |
list_sub_issues | List an issue's sub-issues with pagination. |
list_tags | List tags for a repository with pagination |
list_user_issues | List issues across ALL repositories accessible to the authenticated user (assigned/created/mentioned/subscribed), unlike get_issues which is scoped to one repository. |
list_workflow_jobs | List jobs for a workflow run. |
list_workflow_run_artifacts | List artifacts produced by a workflow run, optionally filtered by exact artifact name. |
list_workflow_runs | List workflow runs for a repository or specific workflow. |
list_workflows | List all workflows in a repository's .github/workflows directory. |
search_code | Search code across GitHub repositories. |
search_commits | Search commits across GitHub repositories. |
search_issues | Search for issues across all accessible repositories using GitHub's search syntax. |
search_orgs | Search for organizations on GitHub. |
search_pull_requests | Search pull requests across GitHub repositories. |
search_repositories | Search GitHub repositories using search syntax. |
search_users | Search GitHub users and organizations. |
validate_credential | Validate GitHub credentials. |
Write (25)
Create or send data.
| Tool | What it does |
|---|---|
add_labels_to_issue | Add labels to an issue. |
add_reply_to_pull_request_comment | Reply to an existing review comment on a pull request. |
add_sub_issue | Add an existing issue as a sub-issue of a parent issue. sub_issue_id is the child issue's ID, NOT its number — get_issue returns it as 'id'. |
add_team_membership | Add a user to a team with specified role (member or maintainer). |
create_branch | Create a new branch from an existing commit. |
create_discussion | Create a discussion in a repository. |
create_discussion_comment | Add a comment to a discussion by number. |
create_gist | Create a new gist with one or more files. |
create_issue | Create a new issue with title, body, labels, assignees, milestone, and type. |
create_issue_comment | Create a new comment on an issue. |
create_label | Create a new label in a repository. |
create_organization_repository | Create a new repository in an organization. |
create_pull_request | Create a pull request from head into base. |
create_pull_request_comment | Create a review comment on a pull request for code review. |
create_pull_request_review | Create a pull request review. |
create_release | Create a release. tag_name is required: use an existing tag from list_tags, or a new tag name (created from target_commitish, default branch if omitted). |
create_repository | Create a new repository. |
create_team | Create a team in an organization. |
follow_user | Follow a user as the authenticated user. |
fork_repository | Fork a repository into the authenticated user's account or a specified organization. |
request_reviewers | Request specific users or teams to review a pull request. |
rerun_failed_jobs | Re-run only the failed jobs of a workflow run (and their dependents), optionally with debug logging enabled. |
rerun_workflow | Re-run all jobs in a workflow run, optionally with debug logging enabled. |
star_repository | Star a repository for the authenticated user |
trigger_workflow | Trigger a workflow dispatch event to manually run a workflow (it must have a workflow_dispatch trigger). |
Delete or overwrite (46)
Remove or replace existing data.
| Tool | What it does |
|---|---|
cancel_workflow_run | Cancel a workflow run that is queued or in progress. |
close_issue | Close an issue by setting its state to closed. |
close_pull_request | Close a pull request without merging it. |
convert_to_draft | Convert a pull request to draft status, preventing it from being merged until marked ready for review (mark_ready_for_review) |
create_or_update_file | Create or update a single file in a repository. |
delete_file | Delete a file from a repository. |
delete_gist | Delete a gist permanently. |
delete_issue_comment | Delete an issue comment. |
delete_label | Delete a label from a repository. |
delete_pending_review | Delete a PENDING (unsubmitted) pull request review and its draft comments. |
delete_release | Delete a release by release_id (from get_releases or get_release_by_tag). |
delete_repository | Delete a repository permanently. |
dismiss_notification | Unsubscribe from a notification thread so you no longer receive future notifications for it. |
dismiss_pull_request_review | Dismiss a submitted pull request review with a required message explaining why. |
lock_issue | Lock an issue to prevent new comments. |
manage_notification_subscription | Mute or unmute a notification thread. |
manage_repo_notification_subscription | Manage repository-level notification subscription. |
mark_all_notifications_read | Mark all notifications as read. |
mark_notification_done | Mark a notification thread as done, removing it from the inbox. |
mark_notification_read | Mark a notification thread as read. |
mark_ready_for_review | Mark a draft pull request as ready for review, allowing it to be merged once approved. |
merge_pull_request | Merge a pull request using the specified merge method (merge, squash, or rebase). |
push_files | Push multiple files in a single commit using the Git Data API (atomic). |
remove_all_labels_from_issue | Remove all labels from an issue |
remove_label_from_issue | Remove a specific label from an issue |
remove_review_request | Remove review requests from specific users or teams for a pull request |
remove_sub_issue | Remove a sub-issue from its parent issue. sub_issue_id is the child issue's ID, NOT its number — get_issue or list_sub_issues return it as 'id'. |
remove_team_membership | Remove a user from a team. |
reopen_issue | Reopen a closed issue by setting its state to open |
reopen_pull_request | Reopen a closed pull request. |
resolve_review_thread | Resolve a pull request review thread, marking the conversation as addressed. |
set_issue_labels | Set labels on an issue, replacing all existing labels with the new set |
submit_pull_request_review | Submit a PENDING pull request review with APPROVE, REQUEST_CHANGES, or COMMENT. |
unfollow_user | Unfollow a user as the authenticated user. |
unlock_issue | Unlock an issue to allow new comments from all users |
unresolve_review_thread | Reopen (unresolve) a resolved pull request review thread. |
unstar_repository | Unstar a repository for the authenticated user |
update_discussion_comment | Update the body of an existing discussion comment. comment_id is the comment node ID (e.g. 'DC_...') returned by get_discussion_comments or create_discussion_comment |
update_gist | Update a gist's description or file contents. |
update_issue | Update an issue's title, body, state, labels, assignees, milestone, or type. labels and assignees REPLACE the full existing set. |
update_issue_comment | Update an existing issue comment's content. |
update_label | Update an existing repository label's name, color, or description. |
update_pull_request | Update an existing pull request's title, body, state, base branch, and other properties |
update_pull_request_branch | Update the head branch of a pull request to include the latest changes from the base branch |
update_release | Update a release by release_id (from get_releases, get_release_by_tag, or create_release). |
update_repository | Update an existing repository's settings, description, visibility, and other properties |