GitHub

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Enabled by default.
  • Authentication: OAuth 2.0.
  • Connection: A user authorizes the connection in the provider's consent screen.
  • Scopes: repo, read:user, read:org.

Credentials

Set these per environment. See Connect an integration.

These variables are required only when you supply your own OAuth app. If a managed app is available, you can connect without setting them. Provider permissions and consent still apply.

VariableRequiredDescription
GITHUB_CLIENT_IDYesGitHub OAuth App Client ID Docs.
GITHUB_CLIENT_SECRETYesGitHub OAuth App Client Secret Docs.

Setup

  1. Choose who owns the GitHub OAuth app: On hosted Veryfront, GitHub uses the Veryfront-managed GitHub OAuth app: connect GitHub from the project's integrations and approve the GitHub consent screen, no environment variables needed. Set GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET only to use your own GitHub OAuth app, which is required for local and self-hosted runs.
  2. Create an OAuth App: In GitHub Developer settings, create an OAuth App.
  3. Set the callback URL: An OAuth App has one authorization callback URL, so create one app per environment. Add the redirect URI of the environment that completes the flow: https://api.veryfront.com/oauth/callback/github for hosted Veryfront, or your app origin followed by /api/auth/github/callback for a local or self-hosted app. Set GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET from the app's credentials.
  4. Verify access: Run Get Current User (read-only). It returns the connected GitHub user without changing anything.

Provider notes

  • The connection requests repo, read:user and read:org. repo grants read and write access to the user's public and private repositories.
  • Organizations that restrict third-party OAuth apps must approve the app before its tools can reach their repositories.
  • Tools that create, update, send or delete data are marked as writes and need write authority; the other tools are read-only.

Provider API reference.

Tools

ToolAccessDescription
Get Current User<br /><code className="reference-identifier">github__get_current_user</code>ReadGet current user
List Repositories<br /><code className="reference-identifier">github__list_repos</code>ReadList repositories
Get User<br /><code className="reference-identifier">github__get_user</code>ReadGet user
Get Repository<br /><code className="reference-identifier">github__get_repo</code>ReadGet repository
List Pull Requests<br /><code className="reference-identifier">github__list_prs</code>ReadList pull requests
Create Issue<br /><code className="reference-identifier">github__create_issue</code>WriteCreate issue
Get PR Diff<br /><code className="reference-identifier">github__get_pr_diff</code>ReadGet PR diff
List Issues<br /><code className="reference-identifier">github__list_issues</code>ReadList issues
Get Issue<br /><code className="reference-identifier">github__get_issue</code>ReadGet issue
Update Issue<br /><code className="reference-identifier">github__update_issue</code>WriteUpdate issue
Add Issue Comment<br /><code className="reference-identifier">github__add_issue_comment</code>WriteAdd issue comment
Get Pull Request<br /><code className="reference-identifier">github__get_pr</code>ReadGet pull request
Create Pull Request<br /><code className="reference-identifier">github__create_pr</code>WriteCreate pull request
Merge Pull Request<br /><code className="reference-identifier">github__merge_pr</code>WriteMerge pull request
List Commits<br /><code className="reference-identifier">github__list_commits</code>ReadList commits

Verify the connection

Call a read tool such as github__get_current_user with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.