GitHub

Developer toolsby OpenAI

Explore repository files, documentation, folder structures, and commit history to understand code, prepare reviews, or document a project. Summarize pull requests, clarify how parts of the codebase fit together, or turn technical details into approachable explanations when sharing work with others.

97ChatGPT Tools

OpenAIDeveloper

Developer toolsCategory

Available Tools

Add Comment To Issue

add_comment_to_issue

Full Description

Create a top-level PR Conversation comment (Issue comment).

Parameters (3 required)

Required

commentstring

Top-level comment body to add to the issue thread.

pr_numberinteger

Pull request number in the repository.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Add Issue Assignees

add_issue_assignees

Full Description

Add assignees to an issue or pull request. Returns a normalized issue snapshot after the mutation. Docs: https://docs.github.com/en/rest/issues/assignees?apiVersion=2022-11-28#add-assignees-to-an-issue

Parameters (3 required)

Required

assigneesarray

GitHub usernames to add as assignees. GitHub's endpoint supports up to 10 assignees and adds to the existing set.

issue_numberinteger

Issue number in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Add Issue Labels

add_issue_labels

Full Description

Add labels to an issue or pull request. Returns a normalized issue snapshot after the mutation. Docs: https://docs.github.com/en/rest/issues/labels?apiVersion=2022-11-28#add-labels-to-an-issue

Parameters (3 required)

Required

issue_numberinteger

Issue number in the repository.

labelsarray

Labels to add to the issue or pull request. This is additive, unlike `update_issue(labels=...)` which replaces the full set.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Add Reaction To Issue Comment

add_reaction_to_issue_comment

Full Description

Add a reaction to an issue comment.

Parameters (3 required)

Required

comment_idinteger

Numeric issue or review comment ID.

reactionstring

Reaction identifier such as `+1` or `eyes`.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Add Reaction To Pr

add_reaction_to_pr

Full Description

Add a reaction to a GitHub pull request.

Parameters (3 required)

Required

pr_numberinteger

Pull request number in the repository.

reactionstring

Reaction identifier such as `+1` or `eyes`.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Add Reaction To Pr Review Comment

add_reaction_to_pr_review_comment

Full Description

Add a reaction to a pull request review comment.

Parameters (3 required)

Required

comment_idinteger

Numeric issue or review comment ID.

reactionstring

Reaction identifier such as `+1` or `eyes`.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Add Review To Pr

add_review_to_pr

Full Description

Add a review to a GitHub pull request. review is required for REQUEST_CHANGES and COMMENT events.

Parameters (3 required, 3 optional)

Required

actionstring

Review action to take. `review` is required for `COMMENT` and `REQUEST_CHANGES`.

Options:COMMENTAPPROVEREQUEST_CHANGES

pr_numberinteger

Pull request number in the repository.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

commit_idstring

Optional commit SHA to anchor the review.

Default: null

file_commentsarray

Optional inline file comments to include with the review.

Default: null

reviewstring

Review body to submit. Required when requesting changes or leaving a comment.

Default: null

Check Repo Initialized

check_repo_initialized

Full Description

Check if a GitHub repository has been set up.

Parameters (1 required, 3 optional)

Required

repo_idinteger

Optional

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Default: null

repository_idinteger

Numeric GitHub repository ID, such as `1296269`. Use this only when the stable repository `id` from a GitHub repository object is available: https://docs.github.com/en/rest/repos/repos#get-a-repository

Default: null

repository_urlstring

GitHub repository URL, or a nested repository URL such as a pull request, issue, branch, or file URL. Examples: `https://github.com/openai/openai/pulls/123`, `https://api.github.com/repos/openai/openai`, `https://github.example.com/api/v3/repos/octo/repo`. Supports GitHub Enterprise Server custom hostnames and GHE.com API hosts. Docs: https://docs.github.com/en/rest/repos/repos#get-a-repository and https://docs.github.com/en/enterprise-server@latest/rest/using-the-rest-api/getting-started-with-the-rest-api and https://docs.github.com/en/enterprise-cloud@latest/admin/data-residency/about-github-enterprise-cloud-with-data-residency#api-access

Default: null

Compare Commits

compare_commits

Full Description

Compare two commits/refs and return per-file stats plus compare metadata. This is a thin wrapper around GithubPlugin.compare_commits to provide a stable, compact response shape to connector consumers.

Parameters (3 required)

Required

basestring

headstring

repo_full_namestring

Convert Pull Request To Draft

convert_pull_request_to_draft

Full Description

Convert an open pull request back to draft state. Returns the connector's normalized PR snapshot after the transition. Docs: https://docs.github.com/en/graphql/reference/mutations#convertpullrequesttodraft

Parameters (2 required)

Required

pr_numberinteger

Pull request number in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Create Blob

create_blob

Full Description

Create a blob in the repository and return its SHA.

Parameters (2 required, 1 optional)

Required

contentstring

Blob content to store in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

encodingstring

One of utf-8 or base64. Default is utf-8.

Options:utf-8base64

Default: utf-8

Create Branch

create_branch

Full Description

Create a new branch in the given repository from base_branch.

Parameters (3 required)

Required

branch_namestring

Branch name to create or update.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

shastring

Commit SHA.

Create Commit

create_commit

Full Description

Create a commit pointing to tree_sha with one or more parents.

Parameters (4 required, 1 optional)

Required

messagestring

Commit message to use for the new commit.

parent_shastring

Parent commit SHA for the new commit.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

tree_shastring

Tree SHA to point the new commit at.

Optional

additional_parent_shasarray

Additional ordered commit parent SHAs. Defaults to no additional parents.

Default: null

Create File

create_file

Full Description

Create a UTF-8 text file through GitHub's contents API. Returns only the resulting commit SHA, not GitHub's full content/commit payload. Docs: https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#create-or-update-file-contents

Parameters (4 required, 1 optional)

Required

contentstring

Complete UTF-8 text contents to write. This wrapper base64-encodes the text for GitHub's contents API.

messagestring

Commit message for the new file.

pathstring

Path for the file within the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

branchstring

Optional branch to create the file on. Leave null to use the default branch.

Default: null

Create Issue

create_issue

Full Description

Create a GitHub issue. Returns a normalized issue snapshot, not GitHub's raw REST payload. Docs: https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#create-an-issue

Parameters (2 required, 4 optional)

Required

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

titlestring

Issue title.

Optional

assigneesarray

Optional GitHub usernames to assign when creating the issue.

Default: null

bodystring

Optional Markdown body for the issue.

Default: null

labelsarray

Optional labels to apply when creating the issue.

Default: null

milestoneinteger

Optional milestone number to associate with the issue.

Default: null

Create Pull Request

create_pull_request

Full Description

Open a pull request in the repository. Returns the connector's normalized PR snapshot, not the full REST response payload. Docs: https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#create-a-pull-request

Parameters (1 required, 10 optional)

Required

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

basestring

GitHub REST `base` branch that the pull request targets.

Default: null

base_branchstring

Compatibility alias for `base`, the target branch for the pull request.

Default: null

bodystring

Pull request description or summary. GitHub allows omitting this field.

Default: null

draftboolean

Create the pull request as a draft.

Default: False

headstring

GitHub REST `head` branch containing the proposed changes.

Default: null

head_branchstring

Compatibility alias for `head`, the branch containing the proposed changes.

Default: null

head_repostring

Repository where the head branch lives. Required by GitHub for some same-organization cross-repository pull requests.

Default: null

issueinteger

Existing issue number to convert into a pull request.

Default: null

maintainer_can_modifyboolean

Whether maintainers may modify the pull request branch.

Default: null

titlestring

Title for the new pull request. Required unless `issue` is supplied.

Default: null

Create Tree

create_tree

Full Description

Create a tree object in the repository from the given elements.

Parameters (2 required, 1 optional)

Required

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

tree_elementsarray

Tree entries to include in the new tree object.

Optional

base_tree_shastring

Optional base tree SHA to build on. Leave null to create from scratch.

Default: null

Delete File

delete_file

Full Description

Delete a file through GitHub's contents API. Returns only the resulting commit SHA. Docs: https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#delete-a-file

Parameters (4 required, 1 optional)

Required

messagestring

Commit message for the file deletion.

pathstring

Path for the existing file within the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

shastring

Current blob SHA of the file being deleted, usually from `fetch_file`.

Optional

branchstring

Optional branch to update. Leave null to use the default branch.

Default: null

Dismiss Pull Request Review

dismiss_pull_request_review

Full Description

Dismiss a submitted pull request review. Returns the normalized review snapshot after dismissal. Docs: https://docs.github.com/en/graphql/reference/mutations#dismisspullrequestreview

Parameters (2 required)

Required

messagestring

Dismissal message explaining why the review is being dismissed.

review_idstring

GraphQL pull request review node ID.

Download User Content

download_user_content

Full Description

Download a GitHub private user image attachment URL. Use this only for private-user-images.githubusercontent.com URLs, such as GitHub issue or pull request image uploads. Use fetch or fetch_file for repository files.

Parameters (1 required)

Required

urlstring

GitHub private user image attachment URL to download. Only https://private-user-images.githubusercontent.com URLs are supported; use fetch or fetch_file for repository files.

Download Workflow Artifact

download_workflow_artifact

Full Description

Download a GitHub Actions workflow artifact ZIP archive. GitHub serves this endpoint through a temporary redirect; the underlying client follows that redirect before returning a reusable file reference for the ZIP bytes. Docs: https://docs.github.com/en/rest/actions/artifacts?apiVersion=2022-11-28#download-an-artifact

Parameters (2 required, 1 optional)

Required

artifact_idinteger

GitHub Actions workflow artifact ID.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

file_namestring

Optional ZIP file name for the returned file reference.

Default: null

Enable Auto Merge

enable_auto_merge

Full Description

Enable auto-merge for a pull request. This wrapper infers the merge method from repository settings and returns only success. Docs: https://docs.github.com/en/graphql/reference/mutations#enablepullrequestautomerge

Parameters (2 required)

Required

pr_numberinteger

Pull request number in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Fetch

fetch

Full Description

Fetch a UTF-8 text file from GitHub by URL. Use a file URL such as `https://github.com/owner/repo/blob/branch/path/to/file.py. raw.githubusercontent.com file URLs and api.github.com/repos/.../contents/... URLs with a ref` query parameter are also accepted.

Parameters (1 required)

Required

urlstring

GitHub file URL to fetch. Supports github.com blob URLs, raw.githubusercontent.com URLs, and api.github.com repository contents URLs with a ref query parameter.

Fetch Blob

fetch_blob

Full Description

Fetch blob content by SHA from the given repository.

Parameters (2 required)

Required

blob_shastring

Blob SHA returned by GitHub.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Fetch Commit

fetch_commit

Full Description

Fetch a commit with its metadata, diff, and canonical URL.

Parameters (2 required)

Required

commit_shastring

Commit SHA.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Fetch Commit Workflow Runs

fetch_commit_workflow_runs

Full Description

Fetch GitHub Actions workflow runs associated with a commit SHA. This wrapper currently filters to pull-request-triggered runs and returns the first page only. Docs: https://docs.github.com/en/rest/actions/workflow-runs?apiVersion=2022-11-28#list-workflow-runs-for-a-repository

Parameters (2 required)

Required

commit_shastring

Commit SHA.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Fetch File

fetch_file

Full Description

Fetch file content by repository path, using the default branch when ref is omitted.

Parameters (2 required, 4 optional)

Required

pathstring

Repository path for the file to fetch.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

encodingstring

One of utf-8 or base64. Default is utf-8.

Options:utf-8base64

Default: utf-8

end_lineinteger

Optional 1-based last line to return.

Default: null

refstring

Optional branch, tag, or commit ref to read from. Omit this unless the ref is known; the repository default branch will be used when omitted.

Default: null

start_lineinteger

Optional 1-based first line to return.

Default: null

Fetch Issue

fetch_issue

Full Description

Fetch GitHub issue.

Parameters (2 required, 3 optional)

Required

issue_numberinteger

Issue number in the repository.

repostring

Optional

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Default: null

repository_idinteger

Default: null

repository_urlstring

Default: null

Fetch Issue Comments

fetch_issue_comments

Full Description

Fetch comments for a GitHub issue across all pages.

Parameters (2 required)

Required

issue_numberinteger

Issue number in the repository.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Fetch Pr

fetch_pr

Full Description

Fetch a pull request with its diff, metadata, and optionally comments.

Parameters (2 required)

Required

pr_numberinteger

Pull request number in the repository.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Fetch Pr Comments

fetch_pr_comments

Full Description

Fetch a merged PR discussion timeline. The returned list combines issue comments, inline review comments, and review submissions into one normalized array. Docs: https://docs.github.com/en/rest/issues/comments?apiVersion=2022-11-28 Docs: https://docs.github.com/en/rest/pulls/comments?apiVersion=2022-11-28 Docs: https://docs.github.com/en/rest/pulls/reviews?apiVersion=2022-11-28

Parameters (2 required)

Required

pr_numberinteger

Pull request number in the repository.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Fetch Pr File Patch

fetch_pr_file_patch

Full Description

Fetch a single-file patch from a PR, searching across all file-list pages.

Parameters (3 required)

Required

pathstring

Path of the changed file within the pull request.

pr_numberinteger

Pull request number in the repository.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Fetch Pr Patch

fetch_pr_patch

Full Description

Fetch the patch for a GitHub pull request across all changed-file pages.

Parameters (2 required)

Required

pr_numberinteger

Pull request number in the repository.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Fetch Workflow Job Logs

fetch_workflow_job_logs

Full Description

Fetch decoded logs for a GitHub Actions workflow job. GitHub serves this endpoint through a temporary redirect; the underlying client follows that redirect before decoding the bytes. Docs: https://docs.github.com/en/rest/actions/workflow-jobs?apiVersion=2022-11-28#download-job-logs-for-a-workflow-run-job

Parameters (2 required)

Required

job_idinteger

GitHub Actions workflow job ID.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Fetch Workflow Job Steps

fetch_workflow_job_steps

Full Description

Fetch steps for a GitHub Actions workflow job. Returns only step summaries, not the full job payload. Docs: https://docs.github.com/en/rest/actions/workflow-jobs?apiVersion=2022-11-28#get-a-job-for-a-workflow-run

Parameters (2 required)

Required

job_idinteger

GitHub Actions workflow job ID.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Fetch Workflow Run Artifacts

fetch_workflow_run_artifacts

Full Description

Fetch artifacts for a GitHub Actions workflow run. This wrapper returns the first page only. Docs: https://docs.github.com/en/rest/actions/artifacts?apiVersion=2022-11-28#list-workflow-run-artifacts

Parameters (2 required, 1 optional)

Required

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

run_idinteger

GitHub Actions workflow run ID.

Optional

namestring

Optional artifact name to filter by.

Default: null

Fetch Workflow Run Jobs

fetch_workflow_run_jobs

Full Description

Fetch jobs for a GitHub Actions workflow run. This wrapper returns the latest attempt's jobs from the first page only. Docs: https://docs.github.com/en/rest/actions/workflow-jobs?apiVersion=2022-11-28#list-jobs-for-a-workflow-run

Parameters (2 required)

Required

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

run_idinteger

GitHub Actions workflow run ID.

Get Commit Combined Status

get_commit_combined_status

Full Description

Fetch the combined CI status and individual status checks for a commit.

Parameters (2 required)

Required

commit_shastring

Commit SHA.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Get Commit Diff

get_commit_diff

Full Description

Fetch a raw commit diff or patch.

Parameters (2 required, 1 optional)

Required

commit_shastring

Commit SHA.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

formatstring

Diff format.

Options:diffpatch

Default: diff

Get Issue Comment Reactions

get_issue_comment_reactions

Full Description

Fetch reactions for an issue comment.

Parameters (2 required, 2 optional)

Required

comment_idinteger

Numeric issue or review comment ID.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

pageinteger

1-based page number for pagination.

Default: null

per_pageinteger

Maximum number of results to return.

Default: null

Get Pr Diff

get_pr_diff

Full Description

Fetch just the diff or patch text for a pull request.

Parameters (2 required, 1 optional)

Required

pr_numberinteger

Pull request number in the repository.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

formatstring

Output format to return. Use `diff` for unified diff or `patch` for patch text.

Options:diffpatch

Default: diff

Get Pr Info

get_pr_info

Full Description

Get metadata (title, description, refs, and status) for a pull request. This action does *not* include the actual code changes. If you need the diff or per-file patches, call fetch_pr_patch instead (or use get_users_recent_prs_in_repo with `include_diff=True` when listing the user's own PRs).

Parameters (2 required)

Required

pr_numberinteger

Pull request number in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Get Pr Reactions

get_pr_reactions

Full Description

Fetch reactions for a GitHub pull request.

Parameters (2 required, 2 optional)

Required

pr_numberinteger

Pull request number in the repository.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

pageinteger

1-based page number for pagination.

Default: null

per_pageinteger

Maximum number of results to return.

Default: null

Get Pr Review Comment Reactions

get_pr_review_comment_reactions

Full Description

Fetch reactions for a pull request review comment.

Parameters (2 required, 2 optional)

Required

comment_idinteger

Numeric issue or review comment ID.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

pageinteger

1-based page number for pagination.

Default: null

per_pageinteger

Maximum number of results to return.

Default: null

Get Profile

get_profile

Full Description

Retrieve the GitHub profile for the authenticated user.

Get Repo

get_repo

Full Description

Retrieve metadata for a GitHub repository. Provide exactly one repository locator:

repository_full_name: owner/name, such as openai/openai. Maps to GitHub REST owner and repo path parameters.
repository_id: numeric GitHub repository ID, such as 1296269.
repository_url: repository URL or nested repository URL, such as a PR, issue, branch, file, REST API, GitHub Enterprise Server /api/v3, or GHE.com API URL.
repo_id: backward-compatible alias for existing programmatic callers. Prefer the explicit locator inputs for new calls. GitHub REST repository docs: https://docs.github.com/en/rest/repos/repos#get-a-repository GitHub Enterprise Server REST docs: https://docs.github.com/en/enterprise-server@latest/rest/using-the-rest-api/getting-started-with-the-rest-api GHE.com API host docs: https://docs.github.com/en/enterprise-cloud@latest/admin/data-residency/about-github-enterprise-cloud-with-data-residency#api-access

Parameters (1 required, 3 optional)

Required

repo_idstring

Optional

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Default: null

repository_idinteger

Default: null

repository_urlstring

Default: null

Get Repo Collaborator Permission

get_repo_collaborator_permission

Full Description

Return the collaborator permission level for a user on a repository.

Parameters (2 required)

Required

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

usernamestring

GitHub username to check against the repository.

Get Repo Installation Id

get_repo_installation_id

Full Description

Get the GitHub App installation ID for a repository visible to the linked account.

Parameters (1 required)

Required

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Get User Login

get_user_login

Full Description

Return the GitHub login for the authenticated user.

Get Users Recent Prs In Repo

get_users_recent_prs_in_repo

Full Description

List the user's recent GitHub pull requests in a repository. limit is the final number of PRs returned. The connector paginates the underlying GitHub search endpoint to satisfy larger limits.

Parameters (1 required, 4 optional)

Required

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

include_commentsboolean

Include pull request comments in each result.

Default: False

include_diffboolean

Include the pull request diff in each result.

Default: False

limitinteger

Maximum number of results to return.

Default: 20

statestring

Pull request state filter such as `open`, `closed`, or `all`.

Default: all

Label Pr

label_pr

Full Description

Label a pull request.

Parameters (3 required)

Required

labelstring

Label to add to the pull request.

pr_numberinteger

Pull request number in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

List Commits

list_commits

Full Description

List commits for a repository in newest-first GitHub API order.

Parameters (1 required, 2 optional)

Required

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

pageinteger

One-based page number.

Default: 1

per_pageinteger

Maximum number of results to return.

Default: 100

List Directory

list_directory

Full Description

List entries in a repository directory, using the default branch when ref is omitted.

Parameters (1 required, 2 optional)

Required

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

pathstring

Optional repository path for the directory to list. Omit to list the repository root.

Default: null

refstring

Optional branch, tag, or commit ref to read from. Omit to use the repository default branch.

Default: null

List Installations

list_installations

Full Description

List all organizations the authenticated user has installed this GitHub App on.

List Installed Accounts

list_installed_accounts

Full Description

List all accounts that the user has installed our GitHub app on.

List Pr Changed Filenames

list_pr_changed_filenames

Full Description

List changed filenames for a PR across all paginated file-list pages.

Parameters (2 required)

Required

pr_numberinteger

Pull request number in the repository.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

List Pull Request Review Threads

list_pull_request_review_threads

Full Description

List inline review threads on a pull request, including resolved state. Returns GraphQL review thread nodes, including comment bodies and resolution metadata. Docs: https://docs.github.com/en/graphql/reference/objects#pullrequestreviewthread

Parameters (2 required)

Required

pr_numberinteger

Pull request number in the repository.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

List Pull Request Reviews

list_pull_request_reviews

Full Description

List review submissions on a pull request. Returns GraphQL review nodes normalized into the connector's review model. Docs: https://docs.github.com/en/graphql/reference/objects#pullrequestreview

Parameters (2 required)

Required

pr_numberinteger

Pull request number in the repository.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

List Recent Issues

list_recent_issues

Full Description

Return the most recent GitHub issues the user can access. top_k is the final result limit. The connector transparently paginates GitHub's issues API until that limit is reached or no more pages exist.

Parameters (0 required, 1 optional)

Optional

top_kinteger

Default: 20

List Repositories

list_repositories

Full Description

List repositories accessible to the authenticated user.

Parameters (0 required, 4 optional)

Optional

include_search_index_statusboolean

Include code search index availability metadata for each repo.

Default: False

ownerstring

Optional owner login to filter returned repositories.

Default: null

page_offsetinteger

Zero-based offset into the result set.

Default: 0

page_sizeinteger

Maximum number of results to return.

Default: 20

List Repositories By Affiliation

list_repositories_by_affiliation

Full Description

List repositories accessible to the authenticated user filtered by affiliation.

Parameters (1 required, 2 optional)

Required

affiliationstring

GitHub affiliation filter such as `owner`, `collaborator`, or `organization_member`.

Optional

page_offsetinteger

Zero-based offset into the result set.

Default: 0

page_sizeinteger

Maximum number of results to return.

Default: 100

List Repositories By Installation

list_repositories_by_installation

Full Description

List repositories accessible to the authenticated user.

Parameters (1 required, 2 optional)

Required

installation_idinteger

GitHub App installation ID to filter by.

Optional

page_offsetinteger

Zero-based offset into the result set.

Default: 0

page_sizeinteger

Maximum number of results to return.

Default: 20

List User Org Memberships

list_user_org_memberships

Full Description

List the authenticated user's organization memberships.

List User Orgs

list_user_orgs

Full Description

List organizations the authenticated user is a member of.

Lock Issue Conversation

lock_issue_conversation

Full Description

Lock an issue or pull request conversation. Allowed lock_reason values are off-topic, too heated, resolved, and spam. Docs: https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#lock-an-issue

Parameters (2 required, 1 optional)

Required

issue_numberinteger

Issue number in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

lock_reasonstring

Optional reason for locking the conversation.

Default: null

Mark Pull Request Ready For Review

mark_pull_request_ready_for_review

Full Description

Mark a draft pull request as ready for review. Returns the connector's normalized PR snapshot after the transition. Docs: https://docs.github.com/en/graphql/reference/mutations#markpullrequestreadyforreview

Parameters (2 required)

Required

pr_numberinteger

Pull request number in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Merge Pull Request

merge_pull_request

Full Description

Merge a pull request immediately. Returns GitHub's merge result payload (sha, merged, message). Docs: https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#merge-a-pull-request

Parameters (2 required, 4 optional)

Required

pr_numberinteger

Pull request number in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

commit_messagestring

Optional override for the merge commit message.

Default: null

commit_titlestring

Optional override for the merge commit title.

Default: null

expected_head_shastring

Optional expected head SHA. GitHub rejects the merge if the PR head moved.

Default: null

merge_methodstring

Optional merge method.

Default: null

Oai User Fetch

oai_user_fetch

Full Description

Uses mfetch to perform document fetch for link following and citations.

Parameters (2 required)

Required

content_locationstring

Content location returned by oai_user_search.

document_idstring

Document id returned by oai_user_search.

Oai User Search

oai_user_search

Full Description

Uses synced RAG index to perform semantic search against query. The index is refreshed until (now - 2h).

Parameters (1 required)

Required

querystring

Semantic search query for the synced knowledge store.

Remove Issue Assignees

remove_issue_assignees

Full Description

Remove assignees from an issue or pull request. Returns a normalized issue snapshot after the mutation. Docs: https://docs.github.com/en/rest/issues/assignees?apiVersion=2022-11-28#remove-assignees-from-an-issue

Parameters (3 required)

Required

assigneesarray

GitHub usernames to remove from assignees.

issue_numberinteger

Issue number in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Remove Issue Label

remove_issue_label

Full Description

Remove one label from an issue or pull request. Returns a normalized issue snapshot after the mutation. Docs: https://docs.github.com/en/rest/issues/labels?apiVersion=2022-11-28#remove-a-label-from-an-issue

Parameters (3 required)

Required

issue_numberinteger

Issue number in the repository.

labelstring

Single label to remove from the issue or pull request.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Remove Pull Request Reviewers

remove_pull_request_reviewers

Full Description

Remove individual or team reviewer requests from a pull request. Returns the connector's normalized PR snapshot after the mutation. Docs: https://docs.github.com/en/rest/pulls/review-requests?apiVersion=2022-11-28#remove-requested-reviewers-from-a-pull-request

Parameters (2 required, 2 optional)

Required

pr_numberinteger

Pull request number in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

reviewersarray

Optional GitHub usernames to remove from review requests.

Default: null

team_reviewersarray

Optional team slugs to remove from review requests.

Default: null

Remove Reaction From Issue Comment

remove_reaction_from_issue_comment

Full Description

Remove a reaction from an issue comment.

Parameters (3 required)

Required

comment_idinteger

Numeric issue or review comment ID.

reaction_idinteger

Reaction ID to remove.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Remove Reaction From Pr

remove_reaction_from_pr

Full Description

Remove a reaction from a GitHub pull request.

Parameters (3 required)

Required

pr_numberinteger

Pull request number in the repository.

reaction_idinteger

Reaction ID to remove.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Remove Reaction From Pr Review Comment

remove_reaction_from_pr_review_comment

Full Description

Remove a reaction from a pull request review comment.

Parameters (3 required)

Required

comment_idinteger

Numeric issue or review comment ID.

reaction_idinteger

Reaction ID to remove.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Reply To Review Comment

reply_to_review_comment

Full Description

Reply to an inline review comment on a PR (Files changed thread). comment_id must be the ID of the thread’s top-level inline review comment (replies-to-replies are not supported by the API)

Parameters (4 required)

Required

commentstring

Reply text to post into the review thread.

comment_idinteger

Numeric issue or review comment ID.

pr_numberinteger

Pull request number in the repository.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Request Pull Request Reviewers

request_pull_request_reviewers

Full Description

Request individual or team reviewers on a pull request. Returns the connector's normalized PR snapshot after the review request mutation. Docs: https://docs.github.com/en/rest/pulls/review-requests?apiVersion=2022-11-28#request-reviewers-for-a-pull-request

Parameters (2 required, 2 optional)

Required

pr_numberinteger

Pull request number in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

reviewersarray

Optional GitHub usernames to request for review.

Default: null

team_reviewersarray

Optional team slugs to request for review.

Default: null

Rerun Failed Workflow Run Jobs

rerun_failed_workflow_run_jobs

Full Description

Re-run all failed jobs in a GitHub Actions workflow run. Use this to retry only the failed jobs from a workflow run, instead of starting a full new attempt for successful jobs too. The linked GitHub app or token must have GitHub Actions write permission for the repository. Docs: https://docs.github.com/en/rest/actions/workflow-runs?apiVersion=2022-11-28#re-run-failed-jobs-from-a-workflow-run

Parameters (2 required)

Required

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

run_idinteger

GitHub Actions workflow run ID.

Rerun Workflow Job

rerun_workflow_job

Full Description

Re-run one GitHub Actions workflow job. Use this when a specific failed or cancelled job should be retried without re-running every failed job in the workflow run. The linked GitHub app or token must have GitHub Actions write permission for the repository. Docs: https://docs.github.com/en/rest/actions/workflow-runs?apiVersion=2022-11-28#re-run-a-job-from-a-workflow-run

Parameters (2 required)

Required

job_idinteger

GitHub Actions workflow job ID to re-run.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Resolve Ref

resolve_ref

Full Description

Resolve a branch, tag, or commit-ish ref to a commit SHA.

Parameters (2 required)

Required

refstring

Branch, tag, or commit ref to resolve.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Resolve Review Thread

resolve_review_thread

Full Description

Resolve an inline pull request review thread. Docs: https://docs.github.com/en/graphql/reference/mutations#resolvereviewthread

Parameters (1 required)

Required

thread_idstring

GraphQL review thread node ID.

Search

search

Full Description

Search files within a specific GitHub repository. Provide a plain string query, avoid GitHub query flags such as `is:pr. Include keywords that match file names, functions, or error messages. repository_name or org can narrow the search scope. Example: query="tokenizer bug" repository_name="tiktoken". topn` is the number of results to return. No results are returned if the query is empty.

Parameters (1 required, 3 optional)

Required

querystring

Search query string.

Optional

orgstring

Optional GitHub organization to scope the search.

Default: null

repository_namestring

Repository or repositories to search within. Use this to narrow the search scope.

Default: null

topninteger

Maximum number of results to return.

Default: 20

Search Branches

search_branches

Full Description

Search GitHub branches within a repository.

Parameters (3 required, 2 optional)

Required

ownerstring

GitHub repository owner or organization name.

querystring

Search query string.

repo_namestring

Repository name without the owner prefix.

Optional

cursorstring

Opaque cursor from a previous branch search.

Default: null

page_sizeinteger

Maximum number of results to return.

Default: 20

Search Commits

search_commits

Full Description

Search GitHub commits across one or more repositories.

Parameters (1 required, 8 optional)

Required

querystring

Search query string.

Optional

orderstring

Optional result ordering.

Default: null

orgstring

Optional GitHub organization to scope the search.

Default: null

repostring

Default: null

repository_full_namestring

Repository or repositories in `owner/name` form to search within.

Default: null

repository_idinteger

Repository ID or IDs to search within.

Default: null

repository_urlstring

Repository URL or URLs to search within.

Default: null

sortstring

Optional commit sort order.

Default: null

topninteger

Maximum number of results to return.

Default: 20

Search Installed Repositories Streaming

search_installed_repositories_streaming

Full Description

Search for a repository (not a file) by name or description. To search for a file, use search.

Parameters (1 required, 4 optional)

Required

querystring

Search query string.

Optional

limitinteger

Maximum number of results to return.

Default: 10

next_tokenstring

Opaque streaming cursor from a previous search.

Default: null

option_enrich_code_search_index_availabilityboolean

Include search index availability metadata in the response.

Default: True

option_enrich_code_search_index_request_concurrency_limitinteger

Maximum concurrent requests when enriching search index availability.

Default: 10

Search Installed Repositories V2

search_installed_repositories_v2

Full Description

Search repositories within the user's installations using GitHub search.

Parameters (1 required, 4 optional)

Required

querystring

Search query string.

Optional

include_search_index_statusboolean

Include code search index availability metadata for each repo.

Default: False

installation_idsarray

Optional GitHub App installation IDs to filter by.

Default: null

limitinteger

Maximum number of results to return.

Default: 10

pageinteger

1-based page number for pagination.

Default: 1

Search Issues

search_issues

Full Description

Search GitHub issues.

Parameters (2 required, 7 optional)

Required

querystring

Search query string.

repostring

Optional

orderstring

Optional result ordering.

Default: null

repository_full_namestring

Repository or repositories in `owner/name` form to search within.

Default: null

repository_idinteger

Repository ID or IDs to search within.

Default: null

repository_urlstring

Repository URL or URLs to search within.

Default: null

sortstring

Optional issue sort order.

Default: null

statestring

Optional issue state filter.

Default: null

topninteger

Maximum number of results to return.

Default: 20

Search Prs

search_prs

Full Description

Search GitHub pull requests.

Parameters (1 required, 9 optional)

Required

querystring

Search query string.

Optional

orderstring

Optional result ordering.

Default: null

orgstring

Optional GitHub organization to scope the search.

Default: null

repostring

Default: null

repository_full_namestring

Repository or repositories in `owner/name` form to search within.

Default: null

repository_idinteger

Repository ID or IDs to search within.

Default: null

repository_urlstring

Repository URL or URLs to search within.

Default: null

sortstring

Optional pull request sort order.

Default: null

statestring

Optional pull request state filter: open, closed, or all.

Default: null

topninteger

Maximum number of results to return.

Default: 20

Search Repositories

search_repositories

Full Description

Search for a repository (not a file) by name or description. To search for a file, use search.

Parameters (1 required, 4 optional)

Required

querystring

Search query string.

Optional

orgstring

Optional GitHub organization to scope the search.

Default: null

pageinteger

1-based page number for pagination.

Default: 1

per_pageinteger

Maximum number of results to return.

Default: null

topninteger

Alias for `per_page` used by some callers.

Default: null

Unlock Issue Conversation

unlock_issue_conversation

Full Description

Unlock an issue or pull request conversation. Docs: https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#unlock-an-issue

Parameters (2 required)

Required

issue_numberinteger

Issue number in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Unresolve Review Thread

unresolve_review_thread

Full Description

Mark an inline pull request review thread as unresolved. Docs: https://docs.github.com/en/graphql/reference/mutations#unresolvereviewthread

Parameters (1 required)

Required

thread_idstring

GraphQL review thread node ID.

Update File

update_file

Full Description

Replace a UTF-8 text file through GitHub's contents API. Returns only the resulting commit SHA. Do not run update/delete writes for the same path in parallel. Docs: https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#create-or-update-file-contents

Parameters (5 required, 1 optional)

Required

contentstring

Complete replacement UTF-8 text contents. This wrapper base64-encodes the text for GitHub's contents API.

messagestring

Commit message for the file update.

pathstring

Path for the existing file within the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

shastring

Current blob SHA of the file being updated, usually from `fetch_file`.

Optional

branchstring

Optional branch to update. Leave null to use the default branch.

Default: null

Update Issue

update_issue

Full Description

Update a GitHub issue, including title/body, state, labels, assignees, or milestone. Returns a normalized issue snapshot after the patch. Docs: https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#update-an-issue

Parameters (2 required, 7 optional)

Required

issue_numberinteger

Issue number in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

assigneesarray

Optional full assignee list to set on the issue. This replaces the assignee set rather than adding to it.

Default: null

bodystring

Optional replacement Markdown body.

Default: null

labelsarray

Optional full label list to set on the issue. This replaces the label set rather than adding to it.

Default: null

milestoneinteger

Optional milestone number to set on the issue. This wrapper does not expose an explicit way to clear an existing milestone.

Default: null

statestring

Optional issue state. Use closed to close or open to reopen.

Default: null

state_reasonstring

Optional state reason. GitHub uses this only with state changes. This wrapper supports `completed`, `not_planned`, `duplicate`, and `reopened`.

Default: null

titlestring

Optional replacement issue title.

Default: null

Update Issue Comment

update_issue_comment

Full Description

Update a top-level PR Conversation comment (Issue comment).

Parameters (3 required)

Required

commentstring

Replacement comment body.

comment_idinteger

Numeric issue or review comment ID.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Update Pull Request

update_pull_request

Full Description

Update PR metadata, base branch, or open/closed state. Returns the connector's normalized PR snapshot. Docs: https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#update-a-pull-request

Parameters (2 required, 5 optional)

Required

pr_numberinteger

Pull request number in the repository.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Optional

base_branchstring

Optional new base branch to retarget the pull request onto.

Default: null

bodystring

Optional replacement pull request body.

Default: null

maintainer_can_modifyboolean

Whether maintainers may push commits to the head branch.

Default: null

statestring

Optional pull request state. Use closed to close or open to reopen.

Default: null

titlestring

Optional replacement pull request title.

Default: null

Update Ref

update_ref

Full Description

Move branch ref to the given commit SHA.

Parameters (3 required, 1 optional)

Required

branch_namestring

Branch name to create or update.

repository_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

shastring

Commit SHA.

Optional

forceboolean

Force the ref update even if it is not a fast-forward.

Default: False

Update Review Comment

update_review_comment

Full Description

Update an inline review comment (or a reply) on a PR.

Parameters (3 required)

Required

commentstring

Replacement inline review comment body.

comment_idinteger

Numeric issue or review comment ID.

repo_full_namestring

Repository in `owner/name` form, such as `openai/openai`. This maps to GitHub REST `owner` and `repo` path parameters: https://docs.github.com/en/rest/repos/repos#get-a-repository

Links

Website Privacy Policy