Sim

GitHub

Interact with GitHub or trigger workflows from GitHub events

Usage Instructions

Integrate Github into the workflow. Can get get PR details, create PR comment, get repository info, and get latest commit. Can be used in trigger mode to trigger a workflow when a PR is created, commented on, or a commit is pushed.

Tools

github_pr

Fetch PR details including diff and files changed

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberPull request ID
numbernumberPull request number
titlestringPR title
statestringPR state (open/closed)
html_urlstringGitHub web URL
diff_urlstringRaw diff URL
bodystringPR description
userjsonUser who created the PR
headjsonHead branch info
basejsonBase branch info
mergedbooleanWhether PR is merged
mergeablebooleanWhether PR is mergeable
merged_byjsonUser who merged the PR
commentsnumberNumber of comments
review_commentsnumberNumber of review comments
commitsnumberNumber of commits
additionsnumberLines added
deletionsnumberLines deleted
changed_filesnumberNumber of changed files
created_atstringCreation timestamp
updated_atstringLast update timestamp
closed_atstringClose timestamp
merged_atstringMerge timestamp
filesarrayArray of changed file objects

github_comment

Create comments on GitHub PRs

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
bodystringYesComment content
pullNumbernumberYesPull request number
pathstringNoFile path for review comment
positionnumberNoLine number for review comment
commentTypestringNoType of comment (pr_comment or file_comment)
linenumberNoLine number for review comment
sidestringNoSide of the diff (LEFT or RIGHT)
commitIdstringNoThe SHA of the commit to comment on
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberComment ID
bodystringComment body
html_urlstringGitHub web URL
userjsonUser who created the comment
pathstringFile path (if file comment)
linenumberLine number
sidestringDiff side
commit_idstringCommit ID
created_atstringCreation timestamp
updated_atstringLast update timestamp

github_repo_info

Retrieve comprehensive GitHub repository metadata including stars, forks, issues, and primary language. Supports both public and private repositories with optional authentication.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
idnumberRepository ID
namestringRepository name
full_namestringFull repository name (owner/repo)
descriptionstringRepository description
html_urlstringGitHub web URL
homepagestringHomepage URL
languagestringPrimary programming language
default_branchstringDefault branch name
visibilitystringRepository visibility (public/private)
privatebooleanWhether the repository is private
forkbooleanWhether this is a fork
archivedbooleanWhether the repository is archived
disabledbooleanWhether the repository is disabled
stargazers_countnumberNumber of stars
watchers_countnumberNumber of watchers
forks_countnumberNumber of forks
open_issues_countnumberNumber of open issues
topicsarrayRepository topics
created_atstringCreation timestamp
updated_atstringLast update timestamp
pushed_atstringLast push timestamp
ownerjsonRepository owner object
licensejsonLicense information

github_latest_commit

Retrieve the latest commit from a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
branchstringNoBranch name (defaults to the repository's default branch)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
shastringCommit SHA
html_urlstringGitHub web URL
commitjsonCommit info with message, author, committer
authorjsonAuthor user object
committerjsonCommitter user object

github_issue_comment

Create a comment on a GitHub issue

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
bodystringYesComment content
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberComment ID
bodystringComment body
html_urlstringGitHub web URL
userjsonUser who created the comment
created_atstringCreation timestamp
updated_atstringLast update timestamp

github_list_issue_comments

List all comments on a GitHub issue

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
sincestringNoOnly show comments updated after this ISO 8601 timestamp
per_pagenumberNoNumber of results per page (max 100)
pagenumberNoPage number
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of comment objects
idnumberComment ID
bodystringComment body
userobjectUser who created the comment
html_urlstringGitHub web URL
created_atstringCreation timestamp
updated_atstringLast update timestamp
countnumberNumber of comments returned

github_update_comment

Update an existing comment on a GitHub issue or pull request

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
comment_idnumberYesComment ID
bodystringYesUpdated comment content
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberComment ID
bodystringComment body
html_urlstringGitHub web URL
userjsonUser who updated the comment
created_atstringCreation timestamp
updated_atstringLast update timestamp

github_delete_comment

Delete a comment on a GitHub issue or pull request

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
comment_idnumberYesComment ID
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
deletedbooleanWhether deletion was successful
comment_idnumberDeleted comment ID

github_list_pr_comments

List all review comments on a GitHub pull request

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
sortstringNoSort by created or updated
directionstringNoSort direction (asc or desc)
sincestringNoOnly show comments updated after this ISO 8601 timestamp
per_pagenumberNoNumber of results per page (max 100)
pagenumberNoPage number
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of review comment objects
idnumberComment ID
bodystringComment body
pathstringFile path
linenumberLine number
userobjectUser who created the comment
html_urlstringGitHub web URL
diff_hunkstringDiff context
created_atstringCreation timestamp
updated_atstringLast update timestamp
countnumberNumber of comments returned

github_create_pr

Create a new pull request in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
titlestringYesPull request title
headstringYesThe name of the branch where your changes are implemented
basestringYesThe name of the branch you want the changes pulled into
bodystringNoPull request description (Markdown)
draftbooleanNoCreate as draft pull request
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberPull request ID
numbernumberPull request number
titlestringPR title
statestringPR state
html_urlstringGitHub web URL
bodystringPR description
userjsonUser who created the PR
headjsonHead branch info
basejsonBase branch info
draftbooleanWhether PR is a draft
mergedbooleanWhether PR is merged
mergeablebooleanWhether PR is mergeable
created_atstringCreation timestamp
updated_atstringLast update timestamp

github_update_pr

Update an existing pull request in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
titlestringNoNew pull request title
bodystringNoNew pull request description (Markdown)
statestringNoNew state (open or closed)
basestringNoNew base branch name
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberPR ID
numbernumberPR number
titlestringPR title
statestringPR state
html_urlstringGitHub web URL
bodystringPR description
userjsonUser who created the PR
headjsonHead branch info
basejsonBase branch info
draftbooleanWhether PR is a draft
mergedbooleanWhether PR is merged
created_atstringCreation timestamp
updated_atstringLast update timestamp

github_merge_pr

Merge a pull request in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
commit_titlestringNoTitle for the merge commit
commit_messagestringNoExtra detail to append to merge commit message
merge_methodstringNoMerge method: merge, squash, or rebase
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
shastringMerge commit SHA
mergedbooleanWhether merge was successful
messagestringResponse message

github_list_prs

List pull requests in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
statestringNoFilter by state: open, closed, or all
headstringNoFilter by head user or branch name (format: user:ref-name or organization:ref-name)
basestringNoFilter by base branch name
sortstringNoSort by: created, updated, popularity, or long-running
directionstringNoSort direction: asc or desc
per_pagenumberNoResults per page (max 100)
pagenumberNoPage number
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of pull request objects
idnumberPR ID
numbernumberPR number
titlestringPR title
statestringPR state
html_urlstringGitHub web URL
userobjectAuthor object
headobjectHead branch info
baseobjectBase branch info
created_atstringCreation timestamp
updated_atstringLast update timestamp
countnumberNumber of PRs returned

github_get_pr_files

Get the list of files changed in a pull request

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
per_pagenumberNoResults per page (max 100)
pagenumberNoPage number
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of changed file objects
filenamestringFile path
statusstringChange status (added/modified/deleted/renamed)
additionsnumberLines added
deletionsnumberLines deleted
changesnumberTotal changes
patchstringFile diff patch
shastringFile SHA
blob_urlstringGitHub blob URL
raw_urlstringRaw file URL
previous_filenamestringPrevious filename (for renamed files)
countnumberTotal number of files

github_close_pr

Close a pull request in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberPR ID
numbernumberPR number
titlestringPR title
statestringPR state (closed)
html_urlstringGitHub web URL
bodystringPR description
userjsonUser who created the PR
headjsonHead branch info
basejsonBase branch info
draftbooleanWhether PR is a draft
mergedbooleanWhether PR is merged
closed_atstringClose timestamp
created_atstringCreation timestamp
updated_atstringLast update timestamp

github_request_reviewers

Request reviewers for a pull request

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
reviewersstringYesComma-separated list of user logins to request reviews from
team_reviewersstringNoComma-separated list of team slugs to request reviews from
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberPR ID
numbernumberPR number
titlestringPR title
html_urlstringGitHub web URL
requested_reviewersarrayArray of requested reviewer objects
requested_teamsarrayArray of requested team objects

github_get_file_content

Get the content of a file from a GitHub repository. Supports files up to 1MB. Content is returned decoded and human-readable.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
pathstringYesPath to the file in the repository (e.g., "src/index.ts")
refstringNoBranch name, tag, or commit SHA (defaults to repository default branch)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
namestringFile name
pathstringFull path in repository
shastringGit blob SHA
sizenumberFile size in bytes
typestringContent type (file/dir/symlink/submodule)
contentstringDecoded file content
encodingstringContent encoding
html_urlstringGitHub web URL
download_urlstringDirect download URL
git_urlstringGit blob API URL
_linksjsonRelated links

github_create_file

Create a new file in a GitHub repository. The file content will be automatically Base64 encoded. Supports files up to 1MB.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
pathstringYesPath where the file will be created (e.g., "src/newfile.ts")
messagestringYesCommit message for this file creation
contentstringYesFile content (plain text, will be Base64 encoded automatically)
branchstringNoBranch to create the file in (defaults to repository default branch)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
contentjsonCreated file content info
commitjsonCommit information

github_update_file

Update an existing file in a GitHub repository. Requires the file SHA. Content will be automatically Base64 encoded. Supports files up to 1MB.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
pathstringYesPath to the file to update (e.g., "src/index.ts")
messagestringYesCommit message for this file update
contentstringYesNew file content (plain text, will be Base64 encoded automatically)
shastringYesThe blob SHA of the file being replaced (get from github_get_file_content)
branchstringNoBranch to update the file in (defaults to repository default branch)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
contentjsonUpdated file content info
commitjsonCommit information

github_delete_file

Delete a file from a GitHub repository. Requires the file SHA. This operation cannot be undone through the API.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
pathstringYesPath to the file to delete (e.g., "src/oldfile.ts")
messagestringYesCommit message for this file deletion
shastringYesThe blob SHA of the file being deleted (get from github_get_file_content)
branchstringNoBranch to delete the file from (defaults to repository default branch)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
contentjsonFile content info (null for delete)
commitjsonCommit information

github_get_tree

Get the contents of a directory in a GitHub repository. Returns a list of files and subdirectories. Use empty path or omit to get root directory contents.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
pathstringNoDirectory path (e.g., "src/components"). Leave empty for root directory.
refstringNoBranch name, tag, or commit SHA (defaults to repository default branch)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
itemsarrayArray of file/directory objects
namestringFile or directory name
pathstringFull path in repository
shastringGit object SHA
sizenumberSize in bytes
typestringType (file/dir/symlink/submodule)
html_urlstringGitHub web URL
download_urlstringDirect download URL
git_urlstringGit blob API URL
urlstringAPI URL for this item
_linksjsonRelated links
countnumberTotal number of items

github_list_branches

List all branches in a GitHub repository. Optionally filter by protected status and control pagination.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
protectedbooleanNoFilter branches by protection status
per_pagenumberNoNumber of results per page (max 100, default 30)
pagenumberNoPage number for pagination (default 1)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
itemsarrayArray of branch objects
namestringBranch name
commitobjectCommit info with sha and url
protectedbooleanWhether branch is protected
countnumberNumber of branches returned

github_get_branch

Get detailed information about a specific branch in a GitHub repository, including commit details and protection status.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
branchstringYesBranch name
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
namestringBranch name
commitjsonCommit object with sha, url, etc.
protectedbooleanWhether branch is protected
protectionjsonProtection settings object
protection_urlstringURL to protection settings

github_create_branch

Create a new branch in a GitHub repository by creating a git reference pointing to a specific commit SHA.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
branchstringYesName of the branch to create
shastringYesCommit SHA to point the branch to
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
refstringFull reference name (refs/heads/branch)
node_idstringGit ref node ID
urlstringAPI URL for the reference
objectjsonGit object with type and sha

github_delete_branch

Delete a branch from a GitHub repository by removing its git reference. Protected branches cannot be deleted.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
branchstringYesName of the branch to delete
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
deletedbooleanWhether the branch was deleted
branchstringName of the deleted branch

github_get_branch_protection

Get the branch protection rules for a specific branch, including status checks, review requirements, and restrictions.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
branchstringYesBranch name
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
urlstringProtection settings URL
required_status_checksjsonStatus check requirements
enforce_adminsjsonAdmin enforcement settings
required_pull_request_reviewsjsonPR review requirements
restrictionsjsonPush restrictions
required_linear_historyjsonLinear history requirement
allow_force_pushesjsonForce push settings
allow_deletionsjsonDeletion settings
block_creationsjsonCreation blocking settings
required_conversation_resolutionjsonConversation resolution requirement
required_signaturesjsonSignature requirements

github_update_branch_protection

Update branch protection rules for a specific branch, including status checks, review requirements, admin enforcement, and push restrictions.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
branchstringYesBranch name
required_status_checksobjectYesRequired status check configuration (null to disable). Object with strict (boolean) and contexts (string array)
enforce_adminsbooleanYesWhether to enforce restrictions for administrators
required_pull_request_reviewsobjectYesPR review requirements (null to disable). Object with optional required_approving_review_count, dismiss_stale_reviews, require_code_owner_reviews
restrictionsobjectYesPush restrictions (null to disable). Object with users (string array) and teams (string array)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
urlstringProtection URL
required_status_checksjsonStatus check requirements
enforce_adminsjsonAdmin enforcement settings
required_pull_request_reviewsjsonPR review requirements
restrictionsjsonPush restrictions
required_linear_historyjsonLinear history requirement
allow_force_pushesjsonForce push settings
allow_deletionsjsonDeletion settings

github_create_issue

Create a new issue in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
titlestringYesIssue title
bodystringNoIssue description/body
assigneesstringNoComma-separated list of usernames to assign to this issue
labelsstringNoComma-separated list of label names to add to this issue
milestonenumberNoMilestone number to associate with this issue
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberIssue ID
numbernumberIssue number
titlestringIssue title
statestringIssue state (open/closed)
html_urlstringGitHub web URL
bodystringIssue body/description
userjsonUser who created the issue
labelsarrayArray of label objects
assigneesarrayArray of assignee objects
milestonejsonMilestone object
created_atstringCreation timestamp
updated_atstringLast update timestamp
closed_atstringClose timestamp

github_update_issue

Update an existing issue in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
titlestringNoNew issue title
bodystringNoNew issue description/body
statestringNoIssue state (open or closed)
labelsarrayNoArray of label names (replaces all existing labels)
assigneesarrayNoArray of usernames (replaces all existing assignees)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberIssue ID
numbernumberIssue number
titlestringIssue title
statestringIssue state
html_urlstringGitHub web URL
bodystringIssue body
userjsonUser who created the issue
labelsarrayArray of label objects
assigneesarrayArray of assignee objects
milestonejsonMilestone object
created_atstringCreation timestamp
updated_atstringLast update timestamp
closed_atstringClose timestamp

github_list_issues

List issues in a GitHub repository. Note: This includes pull requests as PRs are considered issues in GitHub

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
statestringNoFilter by state: open, closed, or all (default: open)
assigneestringNoFilter by assignee username
creatorstringNoFilter by creator username
labelsstringNoComma-separated list of label names to filter by
sortstringNoSort by: created, updated, or comments (default: created)
directionstringNoSort direction: asc or desc (default: desc)
per_pagenumberNoResults per page (max 100, default: 30)
pagenumberNoPage number (default: 1)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of issue objects from GitHub API
idnumberIssue ID
numbernumberIssue number
titlestringIssue title
statestringIssue state (open/closed)
html_urlstringGitHub web URL
bodystringIssue body
userobjectUser who created the issue
labelsarrayArray of label objects
assigneesarrayArray of assignee objects
milestoneobjectMilestone object
created_atstringCreation timestamp
updated_atstringLast update timestamp
closed_atstringClose timestamp
countnumberNumber of issues returned

github_get_issue

Get detailed information about a specific issue in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberIssue ID
numbernumberIssue number
titlestringIssue title
statestringIssue state (open/closed)
html_urlstringGitHub web URL
bodystringIssue body/description
userjsonUser who created the issue
labelsarrayArray of label objects
assigneesarrayArray of assignee objects
milestonejsonMilestone object
commentsnumberNumber of comments
created_atstringCreation timestamp
updated_atstringLast update timestamp
closed_atstringClose timestamp
closed_byjsonUser who closed the issue

github_close_issue

Close an issue in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
state_reasonstringNoReason for closing: completed or not_planned
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberIssue ID
numbernumberIssue number
titlestringIssue title
statestringIssue state (closed)
state_reasonstringReason for closing
html_urlstringGitHub web URL
bodystringIssue body
userjsonUser who created the issue
labelsarrayArray of label objects
assigneesarrayArray of assignee objects
closed_atstringClose timestamp
created_atstringCreation timestamp
updated_atstringLast update timestamp

github_add_labels

Add labels to an issue in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
labelsstringYesComma-separated list of label names to add to the issue
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of label objects on the issue
idnumberLabel ID
namestringLabel name
colorstringLabel color
descriptionstringLabel description
countnumberNumber of labels

github_remove_label

Remove a label from an issue in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
namestringYesLabel name to remove
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayRemaining labels on the issue
idnumberLabel ID
namestringLabel name
colorstringLabel color
descriptionstringLabel description
countnumberNumber of remaining labels

github_add_assignees

Add assignees to an issue in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
assigneesstringYesComma-separated list of usernames to assign to the issue
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberIssue ID
numbernumberIssue number
titlestringIssue title
statestringIssue state
html_urlstringGitHub web URL
bodystringIssue body
userjsonIssue creator
labelsarrayArray of label objects
assigneesarrayArray of assignee objects
created_atstringCreation timestamp
updated_atstringLast update timestamp

github_create_release

Create a new release for a GitHub repository. Specify tag name, target commit, title, description, and whether it should be a draft or prerelease.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
tag_namestringYesThe name of the tag for this release
target_commitishstringNoSpecifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Defaults to the repository default branch.
namestringNoThe name of the release
bodystringNoText describing the contents of the release (markdown supported)
draftbooleanNotrue to create a draft (unpublished) release, false to create a published one
prereleasebooleanNotrue to identify the release as a prerelease, false to identify as a full release
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
idnumberRelease ID
tag_namestringGit tag name
namestringRelease name
bodystringRelease description
html_urlstringGitHub web URL
tarball_urlstringTarball download URL
zipball_urlstringZipball download URL
draftbooleanWhether this is a draft
prereleasebooleanWhether this is a prerelease
authorjsonRelease author
assetsarrayRelease assets
created_atstringCreation timestamp
published_atstringPublication timestamp

github_update_release

Update an existing GitHub release. Modify tag name, target commit, title, description, draft status, or prerelease status.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
release_idnumberYesThe unique identifier of the release
tag_namestringNoThe name of the tag
target_commitishstringNoSpecifies the commitish value for where the tag is created from
namestringNoThe name of the release
bodystringNoText describing the contents of the release (markdown supported)
draftbooleanNotrue to set as draft, false to publish
prereleasebooleanNotrue to identify as a prerelease, false for a full release
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
idnumberRelease ID
tag_namestringGit tag name
namestringRelease name
bodystringRelease description
html_urlstringGitHub web URL
tarball_urlstringTarball download URL
zipball_urlstringZipball download URL
draftbooleanWhether this is a draft
prereleasebooleanWhether this is a prerelease
created_atstringCreation timestamp
published_atstringPublication timestamp

github_list_releases

List all releases for a GitHub repository. Returns release information including tags, names, and download URLs.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
per_pagenumberNoNumber of results per page (max 100)
pagenumberNoPage number of the results to fetch
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
itemsarrayArray of release objects
idnumberRelease ID
tag_namestringGit tag name
namestringRelease name
bodystringRelease description
html_urlstringGitHub web URL
tarball_urlstringTarball download URL
zipball_urlstringZipball download URL
draftbooleanWhether this is a draft
prereleasebooleanWhether this is a prerelease
authorobjectRelease author
assetsarrayRelease assets
created_atstringCreation timestamp
published_atstringPublication timestamp
countnumberNumber of releases returned

github_get_release

Get detailed information about a specific GitHub release by ID. Returns release metadata including assets and download URLs.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
release_idnumberYesThe unique identifier of the release
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
idnumberRelease ID
tag_namestringGit tag name
namestringRelease name
bodystringRelease description
html_urlstringGitHub web URL
tarball_urlstringTarball download URL
zipball_urlstringZipball download URL
draftbooleanWhether this is a draft
prereleasebooleanWhether this is a prerelease
authorjsonRelease author object
assetsarrayArray of release asset objects
created_atstringCreation timestamp
published_atstringPublication timestamp
target_commitishstringTarget commit/branch

github_delete_release

Delete a GitHub release by ID. This permanently removes the release but does not delete the associated Git tag.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
release_idnumberYesThe unique identifier of the release to delete
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
deletedbooleanWhether the release was deleted
release_idnumberID of the deleted release

github_list_workflows

List all workflows in a GitHub repository. Returns workflow details including ID, name, path, state, and badge URL.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
per_pagenumberNoNumber of results per page (default: 30, max: 100)
pagenumberNoPage number of results to fetch (default: 1)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
total_countnumberTotal number of workflows
itemsarrayArray of workflow objects
idnumberWorkflow ID
node_idstringWorkflow node ID
namestringWorkflow name
pathstringPath to workflow file
statestringWorkflow state
html_urlstringGitHub web URL
badge_urlstringBadge URL
created_atstringCreation timestamp
updated_atstringLast update timestamp
deleted_atstringDeletion timestamp

github_get_workflow

Get details of a specific GitHub Actions workflow by ID or filename. Returns workflow information including name, path, state, and badge URL.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
workflow_idstringYesWorkflow ID (number) or workflow filename (e.g., "main.yaml")
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
idnumberWorkflow ID
node_idstringWorkflow node ID
namestringWorkflow name
pathstringPath to workflow file
statestringWorkflow state (active/disabled)
html_urlstringGitHub web URL
badge_urlstringBadge URL
urlstringAPI URL
created_atstringCreation timestamp
updated_atstringLast update timestamp
deleted_atstringDeletion timestamp

github_trigger_workflow

Trigger a workflow dispatch event for a GitHub Actions workflow. The workflow must have a workflow_dispatch trigger configured. Returns 204 No Content on success.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
workflow_idstringYesWorkflow ID (number) or workflow filename (e.g., "main.yaml")
refstringYesGit reference (branch or tag name) to run the workflow on
inputsobjectNoInput keys and values configured in the workflow file
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
triggeredbooleanWhether workflow was triggered
workflow_idstringWorkflow ID or filename
refstringGit reference used

github_list_workflow_runs

List workflow runs for a repository. Supports filtering by actor, branch, event, and status. Returns run details including status, conclusion, and links.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
actorstringNoFilter by user who triggered the workflow
branchstringNoFilter by branch name
eventstringNoFilter by event type (e.g., push, pull_request, workflow_dispatch)
statusstringNoFilter by status (queued, in_progress, completed, waiting, requested, pending)
per_pagenumberNoNumber of results per page (default: 30, max: 100)
pagenumberNoPage number of results to fetch (default: 1)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
total_countnumberTotal number of workflow runs
itemsarrayArray of workflow run objects
idnumberWorkflow run ID
namestringWorkflow name
head_branchstringBranch name
head_shastringCommit SHA
run_numbernumberRun number
eventstringTrigger event
statusstringRun status
conclusionstringRun conclusion
html_urlstringGitHub web URL
created_atstringCreation timestamp
updated_atstringLast update timestamp
triggering_actorjsonUser who triggered the run
pull_requestsarrayAssociated pull requests
referenced_workflowsarrayReferenced workflows
head_commitjsonHead commit information
run_started_atstringRun start timestamp

github_get_workflow_run

Get detailed information about a specific workflow run by ID. Returns status, conclusion, timing, and links to the run.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
run_idnumberYesWorkflow run ID
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
idnumberWorkflow run ID
namestringWorkflow name
head_branchstringBranch name
head_shastringCommit SHA
run_numbernumberRun number
run_attemptnumberRun attempt number
eventstringTrigger event type
statusstringRun status
conclusionstringRun conclusion
workflow_idnumberWorkflow ID
html_urlstringGitHub web URL
logs_urlstringLogs download URL
jobs_urlstringJobs API URL
artifacts_urlstringArtifacts API URL
triggering_actorjsonUser who triggered the run
pull_requestsarrayAssociated pull requests
referenced_workflowsarrayReferenced workflows
head_commitjsonHead commit information
run_started_atstringRun start timestamp
created_atstringCreation timestamp
updated_atstringLast update timestamp

github_cancel_workflow_run

Cancel a workflow run. Returns 202 Accepted if cancellation is initiated, or 409 Conflict if the run cannot be cancelled (already completed).

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
run_idnumberYesWorkflow run ID to cancel
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
cancelledbooleanWhether cancellation was initiated
run_idnumberWorkflow run ID

github_rerun_workflow

Rerun a workflow run. Optionally enable debug logging for the rerun. Returns 201 Created on success.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
run_idnumberYesWorkflow run ID to rerun
enable_debug_loggingbooleanNoEnable debug logging for the rerun (default: false)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
rerun_requestedbooleanWhether rerun was requested
run_idnumberWorkflow run ID

github_list_projects

List GitHub Projects V2 for an organization or user. Returns up to 20 projects with their details including ID, title, number, URL, and status.

Input

ParameterTypeRequiredDescription
owner_typestringYesOwner type: "org" for organization or "user" for user
owner_loginstringYesOrganization or user login name
apiKeystringYesGitHub Personal Access Token with project read permissions

Output

ParameterTypeDescription
itemsarrayArray of project objects
idstringProject node ID
titlestringProject title
numbernumberProject number
urlstringProject URL
closedbooleanWhether project is closed
publicbooleanWhether project is public
shortDescriptionstringShort description
totalCountnumberTotal number of projects

github_get_project

Get detailed information about a specific GitHub Project V2 by its number. Returns project details including ID, title, description, URL, and status.

Input

ParameterTypeRequiredDescription
owner_typestringYesOwner type: "org" for organization or "user" for user
owner_loginstringYesOrganization or user login name
project_numbernumberYesProject number
apiKeystringYesGitHub Personal Access Token with project read permissions

Output

ParameterTypeDescription
idstringProject node ID
titlestringProject title
numbernumberProject number
urlstringProject URL
closedbooleanWhether project is closed
publicbooleanWhether project is public
shortDescriptionstringShort description
readmestringProject readme
createdAtstringCreation timestamp
updatedAtstringLast update timestamp

github_create_project

Create a new GitHub Project V2. Requires the owner Node ID (not login name). Returns the created project with ID, title, and URL.

Input

ParameterTypeRequiredDescription
owner_idstringYesOwner Node ID (format: PVT_... or MDQ6...). Use GitHub GraphQL API to get this ID from organization or user login.
titlestringYesProject title
apiKeystringYesGitHub Personal Access Token with project write permissions

Output

ParameterTypeDescription
idstringProject node ID
titlestringProject title
numbernumberProject number
urlstringProject URL
closedbooleanWhether project is closed
publicbooleanWhether project is public
shortDescriptionstringShort description

github_update_project

Update an existing GitHub Project V2. Can update title, description, visibility (public), or status (closed). Requires the project Node ID.

Input

ParameterTypeRequiredDescription
project_idstringYesProject Node ID (format: PVT_...)
titlestringNoNew project title
shortDescriptionstringNoNew project short description
project_publicbooleanNoSet project visibility (true = public, false = private)
closedbooleanNoSet project status (true = closed, false = open)
apiKeystringYesGitHub Personal Access Token with project write permissions

Output

ParameterTypeDescription
idstringProject node ID
titlestringProject title
numbernumberProject number
urlstringProject URL
closedbooleanWhether project is closed
publicbooleanWhether project is public
shortDescriptionstringShort description

github_delete_project

Delete a GitHub Project V2. This action is permanent and cannot be undone. Requires the project Node ID.

Input

ParameterTypeRequiredDescription
project_idstringYesProject Node ID (format: PVT_...)
apiKeystringYesGitHub Personal Access Token with project admin permissions

Output

ParameterTypeDescription
idstringDeleted project node ID
titlestringDeleted project title
numbernumberDeleted project number
urlstringDeleted project URL
On this page

On this page

Usage Instructions
Tools
github_pr
Input
Output
github_comment
Input
Output
github_repo_info
Input
Output
github_latest_commit
Input
Output
github_issue_comment
Input
Output
github_list_issue_comments
Input
Output
github_update_comment
Input
Output
github_delete_comment
Input
Output
github_list_pr_comments
Input
Output
github_create_pr
Input
Output
github_update_pr
Input
Output
github_merge_pr
Input
Output
github_list_prs
Input
Output
github_get_pr_files
Input
Output
github_close_pr
Input
Output
github_request_reviewers
Input
Output
github_get_file_content
Input
Output
github_create_file
Input
Output
github_update_file
Input
Output
github_delete_file
Input
Output
github_get_tree
Input
Output
github_list_branches
Input
Output
github_get_branch
Input
Output
github_create_branch
Input
Output
github_delete_branch
Input
Output
github_get_branch_protection
Input
Output
github_update_branch_protection
Input
Output
github_create_issue
Input
Output
github_update_issue
Input
Output
github_list_issues
Input
Output
github_get_issue
Input
Output
github_close_issue
Input
Output
github_add_labels
Input
Output
github_remove_label
Input
Output
github_add_assignees
Input
Output
github_create_release
Input
Output
github_update_release
Input
Output
github_list_releases
Input
Output
github_get_release
Input
Output
github_delete_release
Input
Output
github_list_workflows
Input
Output
github_get_workflow
Input
Output
github_trigger_workflow
Input
Output
github_list_workflow_runs
Input
Output
github_get_workflow_run
Input
Output
github_cancel_workflow_run
Input
Output
github_rerun_workflow
Input
Output
github_list_projects
Input
Output
github_get_project
Input
Output
github_create_project
Input
Output
github_update_project
Input
Output
github_delete_project
Input
Output
Start building today
Trusted by over 60,000 builders.
Build Agentic workflows visually on a drag-and-drop canvas or with natural language.
Get started