GitHub API
Tools that enable LLMs to interact directly with the GitHub API.
Arcade Toolkit enables seamless interaction between LLMs and the GitHub API, allowing for efficient management and development of GitHub repositories. It provides developers with tools for automation, collaboration, and project management.
Capabilities
- Automate GitHub actions and workflows for repositories.
- Manage branches, access permissions, and team collaborations.
- Handle repository secrets, issues, pull requests, and releases.
- Perform analytics on contributions, notifications, and security alerts.
- Integrate GitHub Apps and customize environment settings.
OAuth
Provider: Github
Scopes: None
Secrets
The toolkit supports several types of secrets such as GitHub tokens, webhooks, and environment variables. For example, it allows the management of GIT_SERVER_URL securely.
Available tools(818)
| Tool name | Description | Secrets | |
|---|---|---|---|
Accept a GitHub repository invitation.
This tool accepts an invitation to join a GitHub repository for the authenticated user. Use it when you need to confirm participation in a repo after receiving an invitation. | 1 | ||
Grant specified apps push access to a protected branch.
Use this tool to grant specific GitHub Apps push access to protected branches in repositories. Apps must have 'write' access to 'contents' to be authorized.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 | ||
Add custom labels to a self-hosted runner in an enterprise.
Use this tool to attach custom labels to a self-hosted runner within an enterprise on GitHub. Requires authentication with a token that has the `manage_runners:enterprise` scope. | 1 | ||
Add a new email to the authenticated GitHub user's account.
Use this tool to add an email address to the authenticated GitHub account of the user. This action requires user scope authentication.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | 1 | ||
Add an authorized SSH key to GitHub Enterprise.
This tool adds an authorized SSH key to a GitHub Enterprise account. It is useful when you want to securely access your GitHub repositories using SSH. Make sure to provide the SSH key in the required format. | 1 | ||
Add a reaction to a GitHub release.
Use this tool to create a reaction to a specific release on GitHub. If a reaction already exists, it will return a confirmation with status 200 OK. | 1 | ||
Add a GPG key to your authenticated GitHub account.
This tool allows you to add a GPG key to your GitHub account after authenticating via Basic Auth or OAuth with the appropriate scope. Use it to enhance security by managing GPG keys on GitHub. | 1 | ||
Add labels to a GitHub issue to categorize it.
Use this tool to apply one or more labels to a specific issue in a GitHub repository. It helps in categorizing and organizing issues for better project management.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| 1 | ||
Add custom labels to a self-hosted runner in an organization.
This tool adds custom labels to a self-hosted GitHub Actions runner configured in an organization. Use this tool when you need to organize or categorize runners with specific labels. Requires authentication with an access token having the `admin:org` scope. | 1 | ||
Add organization access to a self-hosted runner group in an enterprise.
Use this tool to add an organization to a selected list that can access a self-hosted runner group. The runner group's visibility must be set to 'selected'. Requires an access token with 'manage_runners:enterprise' scope. | 1 | ||
Add or update a collaborator on a GitHub repository.
Use this tool to add a new collaborator or update the permission level of an existing collaborator on a GitHub repository. The invitee will receive a notification, and changes are instantly applied. Be aware of rate limits and permissions restrictions. | 1 | ||
Add or update a GitHub team's permissions on an organization project.
Use this tool to add a project to a GitHub team or update a team's permissions on a project within the same organization. The user must have admin permissions for the project. | 1 | ||
Add a collaborator to an organization project.
This tool adds a collaborator to a specified organization project and assigns a permission level. It requires the user to be an organization owner or a project admin. | 1 | ||
Add a reaction to a GitHub commit comment.
Use this tool to add a reaction (like, love, etc.) to a comment on a GitHub commit. It confirms if the reaction was already added with an HTTP `200` status. | 1 | ||
Add a reaction to a GitHub issue comment.
Use this tool to add a specific reaction to a comment on a GitHub issue. It checks if the reaction type has already been added, returning an HTTP `200` status in that case. | 1 | ||
Add a reaction to a GitHub issue.
Use this tool to add a specific reaction to a GitHub issue. If a reaction has already been added by the user, a response with HTTP status 200 will confirm this. Suitable for managing issue reactions on GitHub repositories. | 1 | ||
Add a reaction to a GitHub team discussion.
Use this tool to add a specific reaction emoji to a team discussion in a GitHub organization. It requires OAuth access tokens with the `write:discussion` scope. This is useful for engaging with team discussions directly through the API. | 1 | ||
Adds a reaction to a pull request review comment on GitHub.
Use this tool to add a reaction to a specific pull request review comment on GitHub. This can be helpful for acknowledging comments or expressing opinions quickly. A successful addition results in an HTTP `200` status. | 1 | ||
Add a reaction to a GitHub team discussion comment.
Use this tool to add a reaction emoji to a specific GitHub team discussion comment within an organization. Useful for engaging with team discussions or acknowledging comments. Requires appropriate OAuth scope. | 1 | ||
Add repository access to a self-hosted runner group.
This tool is used to add a repository to the list of selected repositories that can access a self-hosted runner group within an organization. It should be called when you need to manage repository access for a self-hosted runner group with `selected` visibility. Requires authentication with an `admin:org` scoped access token. | 1 | ||
Add a repository to a GitHub installation for the authenticated user.
Use this tool to add a specific repository to a GitHub installation. The authenticated user must have admin access to the repository. A personal access token is required to authenticate the user. | 1 | ||
Add a repository to a GitHub organization secret.
Use this tool to add a repository to an organization's secret in GitHub when the `visibility` is set to `selected`. Requires an access token with `admin:org` scope or a GitHub App with `dependabot_secrets` permission. | 1 | ||
Add a repository to an organization's secret.
This tool adds a specified repository to an organization secret with 'selected' visibility. It requires authentication with an access token having 'admin:org' scope. GitHub Apps need 'secrets' organization permission. | 1 | ||
Add a repository to an organization's selected variables.
Use this tool to add a repository to a specific organization variable that is available to selected repositories on GitHub. This requires an access token with `admin:org` scope or GitHub App permission `organization_actions_variables:write`. The repository and organization must have the `visibility` field set to `selected`. | 1 | ||
Adds a repository to a GitHub required workflow.
Use this tool to add a repository to a GitHub required workflow. Ensure the workflow is set to run on selected repositories. Authentication with an access token having `admin:org` scope is required. | 1 |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
GithubApi.AcceptGithubRepoInvitation
Accept a GitHub repository invitation. This tool accepts an invitation to join a GitHub repository for the authenticated user. Use it when you need to confirm participation in a repo after receiving an invitation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invitation_id | integer | Required | The unique identifier for the GitHub invitation to be accepted. |
Requirements
Output
json— Response from the API endpoint 'repos/accept-invitation-for-authenticated-user'.GithubApi.AddAppAccessRestrictions
Grant specified apps push access to a protected branch. Use this tool to grant specific GitHub Apps push access to protected branches in repositories. Apps must have 'write' access to 'contents' to be authorized. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The repository account owner. The name is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the repository. This is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
branch_name | string | Optional | The name of the branch to grant push access. Cannot contain wildcard characters. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'repos/add-app-access-restrictions'.GithubApi.AddCustomLabelsToRunner
Add custom labels to a self-hosted runner in an enterprise. Use this tool to attach custom labels to a self-hosted runner within an enterprise on GitHub. Requires authentication with a token that has the `manage_runners:enterprise` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
custom_labels | array<string> | Required | An array of names for the custom labels to add to the self-hosted runner. |
enterprise_identifier | string | Required | The slug or ID of the enterprise for the self-hosted runner. It identifies the enterprise name or ID in GitHub. |
runner_unique_id | integer | Required | The unique integer identifier for the self-hosted runner. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise'.GithubApi.AddEmailToGithubAccount
Add a new email to the authenticated GitHub user's account. Use this tool to add an email address to the authenticated GitHub account of the user. This action requires user scope authentication. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'users/add-email-for-authenticated-user'.GithubApi.AddGithubAuthorizedSshKey
Add an authorized SSH key to GitHub Enterprise. This tool adds an authorized SSH key to a GitHub Enterprise account. It is useful when you want to securely access your GitHub repositories using SSH. Make sure to provide the SSH key in the required format.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
public_ssh_key | string | Required | The public SSH key to add to GitHub Enterprise. Ensure it is in the correct format. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/add-authorized-ssh-key'.GithubApi.AddGithubReleaseReaction
Add a reaction to a GitHub release. Use this tool to create a reaction to a specific release on GitHub. If a reaction already exists, it will return a confirmation with status 200 OK.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
reaction_type | string | Required | The reaction type for the release, e.g., '+1', 'laugh', 'heart'. Choose from '+1', 'laugh', 'heart', 'hooray', 'rocket', 'eyes'. |
release_identifier | integer | Required | The unique identifier for the GitHub release to which the reaction will be added. |
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository on GitHub. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'reactions/create-for-release'.GithubApi.AddGpgKeyToGithub
Add a GPG key to your authenticated GitHub account. This tool allows you to add a GPG key to your GitHub account after authenticating via Basic Auth or OAuth with the appropriate scope. Use it to enhance security by managing GPG keys on GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gpg_key_ascii_armored_format | string | Required | A GPG key in ASCII-armored format to be added to your GitHub account. |
new_gpg_key_name | string | Optional | A descriptive name for the new GPG key to be added to your GitHub account. |
Requirements
Output
json— Response from the API endpoint 'users/create-gpg-key-for-authenticated-user'.GithubApi.AddLabelsToGithubIssue
Add labels to a GitHub issue to categorize it. Use this tool to apply one or more labels to a specific issue in a GitHub repository. It helps in categorizing and organizing issues for better project management. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The GitHub account owner of the repository. This value is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the GitHub repository where the issue exists. It is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
issue_number | integer | Optional | The numeric identifier of the issue to which labels will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'issues/add-labels'.GithubApi.AddLabelsToRunner
Add custom labels to a self-hosted runner in an organization. This tool adds custom labels to a self-hosted GitHub Actions runner configured in an organization. Use this tool when you need to organize or categorize runners with specific labels. Requires authentication with an access token having the `admin:org` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
custom_labels_to_add | array<string> | Required | An array of strings representing the custom labels to add to the self-hosted runner. Each label is a string. |
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
runner_id | integer | Required | Unique identifier of the self-hosted runner to which labels are added. |
Requirements
Output
json— Response from the API endpoint 'actions/add-custom-labels-to-self-hosted-runner-for-org'.GithubApi.AddOrgAccessToRunnerGroup
Add organization access to a self-hosted runner group in an enterprise. Use this tool to add an organization to a selected list that can access a self-hosted runner group. The runner group's visibility must be set to 'selected'. Requires an access token with 'manage_runners:enterprise' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug or ID of the enterprise. Use either the enterprise name slug or its ID. |
organization_id | integer | Required | The unique identifier of the organization to add access to the self-hosted runner group. |
runner_group_id | integer | Required | Unique identifier for the self-hosted runner group. Required for adding organization access to it. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise'.GithubApi.AddOrUpdateGithubCollaborator
Add or update a collaborator on a GitHub repository. Use this tool to add a new collaborator or update the permission level of an existing collaborator on a GitHub repository. The invitee will receive a notification, and changes are instantly applied. Be aware of rate limits and permissions restrictions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub user handle for the collaborator to be added or updated. |
repository_name | string | Required | The name of the GitHub repository. This input is not case sensitive. |
repository_owner | string | Required | The GitHub username of the account owner of the repository. This is not case sensitive. |
permission_level_for_github_collaborator | string | Optional | Specify the permission to grant or update for a collaborator on an organization-owned GitHub repository. Only valid for such repositories. |
Requirements
Output
json— Response from the API endpoint 'repos/add-collaborator'.GithubApi.AddOrUpdateGithubTeamProjectPermissions
Add or update a GitHub team's permissions on an organization project. Use this tool to add a project to a GitHub team or update a team's permissions on a project within the same organization. The user must have admin permissions for the project.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name. This is not case sensitive. |
project_id | integer | Required | The unique identifier of the project to update or add to the team. |
team_slug | string | Required | The slug representation of the GitHub team's name within the organization. This is used to identify the team in the request. |
project_permission_level | string | Optional | Permission level to grant the team for the project. Options: 'read', 'write', 'admin'. Default uses the team's current level. |
Requirements
Output
json— Response from the API endpoint 'teams/add-or-update-project-permissions-in-org'.GithubApi.AddProjectCollaborator
Add a collaborator to an organization project. This tool adds a collaborator to a specified organization project and assigns a permission level. It requires the user to be an organization owner or a project admin.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
collaborator_username | string | Required | The GitHub username of the collaborator to be added to the project. |
project_id | integer | Required | The unique identifier of the project to which a collaborator is being added. This ID is required to specify the exact project for collaboration. |
collaborator_permission_level | string | Optional | The permission level to assign to the collaborator. Options are: 'read', 'write', or 'admin'. |
Requirements
Output
json— Response from the API endpoint 'projects/add-collaborator'.GithubApi.AddReactionToCommitComment
Add a reaction to a GitHub commit comment. Use this tool to add a reaction (like, love, etc.) to a comment on a GitHub commit. It confirms if the reaction was already added with an HTTP `200` status.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_id | integer | Required | The unique identifier of the GitHub commit comment to which the reaction will be added. |
reaction_type | string | Required | The type of reaction to add to the commit comment, e.g., '+1', 'heart', 'laugh'. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The GitHub username of the repository owner. This value is case-insensitive. |
Requirements
Output
json— Response from the API endpoint 'reactions/create-for-commit-comment'.GithubApi.AddReactionToGithubComment
Add a reaction to a GitHub issue comment. Use this tool to add a specific reaction to a comment on a GitHub issue. It checks if the reaction type has already been added, returning an HTTP `200` status in that case.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_unique_identifier | integer | Required | The unique identifier for the GitHub comment to which a reaction is being added. |
reaction_type | string | Required | The type of reaction to add to the issue comment. Valid options: '+1', '-1', 'laugh', 'confused', 'heart', 'hooray', 'rocket', 'eyes'. |
repository_name | string | Required | The name of the GitHub repository. This name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'reactions/create-for-issue-comment'.GithubApi.AddReactionToGithubIssue
Add a reaction to a GitHub issue. Use this tool to add a specific reaction to a GitHub issue. If a reaction has already been added by the user, a response with HTTP status 200 will confirm this. Suitable for managing issue reactions on GitHub repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_issue_number | integer | Required | The number that uniquely identifies the issue on GitHub. |
reaction_type_to_add | string | Required | The reaction type to add to the issue. Options include '+1', '-1', 'laugh', 'confused', 'heart', 'hooray', 'rocket', 'eyes'. |
repository_name | string | Required | The name of the GitHub repository. This is not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'reactions/create-for-issue'.GithubApi.AddReactionToGithubTeamDiscussion
Add a reaction to a GitHub team discussion. Use this tool to add a specific reaction emoji to a team discussion in a GitHub organization. It requires OAuth access tokens with the `write:discussion` scope. This is useful for engaging with team discussions directly through the API.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
discussion_id | integer | Required | The unique identifier number for the team discussion. |
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
reaction_type | string | Required | The reaction type to add to the team discussion. Valid options include: '+1', '-1', 'laugh', 'confused', 'heart', 'hooray', 'rocket', 'eyes'. |
team_slug | string | Required | The URL-friendly version of the team's name. |
Requirements
Output
json— Response from the API endpoint 'reactions/create-for-team-discussion-in-org'.GithubApi.AddReactionToPrComment
Adds a reaction to a pull request review comment on GitHub. Use this tool to add a reaction to a specific pull request review comment on GitHub. This can be helpful for acknowledging comments or expressing opinions quickly. A successful addition results in an HTTP `200` status.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_unique_id | integer | Required | The unique identifier of the pull request review comment. |
reaction_type_for_pr_comment | string | Required | Specifies the type of reaction to add to the pull request review comment. Valid options are '+1', '-1', 'laugh', 'confused', 'heart', 'hooray', 'rocket', 'eyes'. |
repository_name | string | Required | The name of the repository where the comment is located. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'reactions/create-for-pull-request-review-comment'.GithubApi.AddReactionToTeamDiscussionComment
Add a reaction to a GitHub team discussion comment. Use this tool to add a reaction emoji to a specific GitHub team discussion comment within an organization. Useful for engaging with team discussions or acknowledging comments. Requires appropriate OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_identifier | integer | Required | The unique number identifying the team discussion comment to react to. |
discussion_identifier | integer | Required | The number identifying the discussion within the team. |
organization_name | string | Required | The name of the organization. This value is not case sensitive. |
reaction_type | string | Required | The type of reaction emoji to add to the team discussion comment. Accepted values are: '+1', '-1', 'laugh', 'confused', 'heart', 'hooray', 'rocket', 'eyes'. |
team_slug | string | Required | The slug of the team name within the organization, used to identify the team. |
Requirements
Output
json— Response from the API endpoint 'reactions/create-for-team-discussion-comment-in-org'.GithubApi.AddRepoAccessToRunnerGroup
Add repository access to a self-hosted runner group. This tool is used to add a repository to the list of selected repositories that can access a self-hosted runner group within an organization. It should be called when you need to manage repository access for a self-hosted runner group with `selected` visibility. Requires authentication with an `admin:org` scoped access token.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. It is not case sensitive. |
repository_unique_id | integer | Required | The unique identifier of the repository to add access for. |
runner_group_identifier | integer | Required | Provide the unique integer identifier for the self-hosted runner group. |
Requirements
Output
json— Response from the API endpoint 'actions/add-repo-access-to-self-hosted-runner-group-in-org'.GithubApi.AddRepositoryToGithubInstallation
Add a repository to a GitHub installation for the authenticated user. Use this tool to add a specific repository to a GitHub installation. The authenticated user must have admin access to the repository. A personal access token is required to authenticate the user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
installation_id | integer | Required | The unique identifier of the GitHub installation. |
repository_id | integer | Required | Provide the unique integer identifier of the repository to add to the installation. |
Requirements
Output
json— Response from the API endpoint 'apps/add-repo-to-installation-for-authenticated-user'.GithubApi.AddRepositoryToSecret
Add a repository to a GitHub organization secret. Use this tool to add a repository to an organization's secret in GitHub when the `visibility` is set to `selected`. Requires an access token with `admin:org` scope or a GitHub App with `dependabot_secrets` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
repository_id_for_org_secret | integer | Required | The ID of the repository to be added to the organization secret. This ID should be an integer. |
secret_name | string | Required | The name of the organization secret to which a repository will be added. This is case-insensitive. |
Requirements
Output
json— Response from the API endpoint 'dependabot/add-selected-repo-to-org-secret'.GithubApi.AddRepoToOrgSecret
Add a repository to an organization's secret. This tool adds a specified repository to an organization secret with 'selected' visibility. It requires authentication with an access token having 'admin:org' scope. GitHub Apps need 'secrets' organization permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The organization's name. It is not case sensitive. |
repository_id | integer | Required | The unique integer ID of the repository to be added to the organization secret. This ID specifies which repository you want to include. |
secret_name | string | Required | The name of the organization secret to which the repository will be added. |
Requirements
Output
json— Response from the API endpoint 'actions/add-selected-repo-to-org-secret'.GithubApi.AddRepoToOrgVariable
Add a repository to an organization's selected variables. Use this tool to add a repository to a specific organization variable that is available to selected repositories on GitHub. This requires an access token with `admin:org` scope or GitHub App permission `organization_actions_variables:write`. The repository and organization must have the `visibility` field set to `selected`.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. This is not case sensitive. |
repository_id | integer | Required | The integer ID of the repository to be added to the organization variable. This is a required field. |
variable_name | string | Required | The name of the organization variable to which the repository will be added. |
Requirements
Output
json— Response from the API endpoint 'actions/add-selected-repo-to-org-variable'.GithubApi.AddRepoToRequiredWorkflow
Adds a repository to a GitHub required workflow. Use this tool to add a repository to a GitHub required workflow. Ensure the workflow is set to run on selected repositories. Authentication with an access token having `admin:org` scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The organization name for GitHub. It is not case sensitive. |
repository_unique_identifier | integer | Required | The unique identifier for the GitHub repository to be added to the required workflow. |
required_workflow_identifier | integer | Required | The unique integer ID of the required workflow to which the repository will be added. |
Requirements
Output
json— Response from the API endpoint 'actions/add-selected-repo-to-required-workflow'.GithubApi.AddRunnerToGroup
Add a self-hosted runner to an organization's runner group. Use this tool to add a self-hosted runner to a specific runner group within an organization on GitHub. Ensure you authenticate with an access token that has the `admin:org` scope to perform this operation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
runner_group_identifier | integer | Required | The unique integer identifier of the self-hosted runner group to which the runner will be added. |
runner_identifier | integer | Required | Unique identifier of the self-hosted runner to be added to the group. |
Requirements
Output
json— Response from the API endpoint 'actions/add-self-hosted-runner-to-group-for-org'.GithubApi.AddSecurityManagerTeam
Add a team as a security manager for an organization. Use this tool to designate a specific team as the security manager for a GitHub organization. Requires organization admin rights and a token with `write:org` scope. Useful for managing security roles within an organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. This is not case sensitive. Required for adding a team as a security manager. |
team_slug | string | Required | The slug of the team name to be added as a security manager. This is case-insensitive. |
Requirements
Output
json— Response from the API endpoint 'orgs/add-security-manager-team'.GithubApi.AddSelfHostedRunnerToGroup
Add a self-hosted runner to an enterprise group in GitHub. Use this tool to add a self-hosted runner to a specified runner group within an enterprise on GitHub. Authentication with an access token having the 'manage_runners:enterprise' scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | Slug version or ID of the enterprise for adding the runner. |
runner_group_identifier | integer | Required | Unique identifier of the self-hosted runner group. |
self_hosted_runner_id | integer | Required | Unique identifier of the self-hosted runner to be added to the group. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/add-self-hosted-runner-to-group-for-enterprise'.GithubApi.AddSshKeyToGithubAccount
Add a public SSH key to your GitHub account. Use this tool to add a public SSH key to the authenticated user's GitHub account, enabling SSH access. Authentication is required via Basic Auth or OAuth with the appropriate scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
public_ssh_key | string | Required | The public SSH key content to add to your GitHub account. Ensure it is in the correct format. |
ssh_key_title | string | Optional | A descriptive name for the new SSH key added to the GitHub account. |
Requirements
Output
json— Response from the API endpoint 'users/create-public-ssh-key-for-authenticated-user'.GithubApi.AddStatusCheckContextsToBranch
Add status check contexts to a protected branch. This tool allows users to add status check contexts to a specified protected branch in a GitHub repository. It should be called when managing branch protection rules and ensuring specific contexts are required for status checks. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The account owner of the repository. The name is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the repository to add status check contexts to. This is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
branch_name | string | Optional | The name of the branch to add status check contexts to. Cannot contain wildcard characters. Use GraphQL API for wildcards. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'repos/add-status-check-contexts'.GithubApi.AddTeamAccessToBranch
Grant push access to teams for a specific branch. Use this tool to grant specified teams push access to a protected branch within a repository. Applicable to repositories on GitHub Free, Pro, Team, and Enterprise plans. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The account owner of the repository. The name is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the repository. It is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
branch_name | string | Optional | Specify the branch name to grant team access. Wildcard characters are not allowed. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'repos/add-team-access-restrictions'.GithubApi.AddUpdateGithubTeamMembership
Add or update a user's membership in a GitHub team. This tool adds a member to a GitHub organization's team or updates their role if they are already a member. It is used by authenticated organization owners or team maintainers. If the person isn't part of the organization, an invitation is sent, and their membership will be pending until accepted.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_team_slug | string | Required | The slug identifier of the team's name within the organization. This is not case-sensitive. |
github_user_handle | string | Required | The GitHub user account handle to add or update in the organization team. |
organization_name | string | Required | The name of the GitHub organization (case insensitive) to which the team belongs. |
user_team_role | string | Optional | Specifies the role for the user in the team, either 'member' or 'maintainer'. |
Requirements
Output
json— Response from the API endpoint 'teams/add-or-update-membership-for-user-in-org'.GithubApi.ApproveOrRejectPendingDeployments
Approve or reject pending deployments for a workflow run. This tool approves or rejects pending deployments that are awaiting a required reviewer's decision. It requires access to repository contents and deployments, and authentication using a token with `repo` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
deployment_review_comment | string | Required | A comment to accompany the approval or rejection of the deployment review. |
deployment_review_state | string | Required | Specify 'approved' to approve or 'rejected' to reject deployments to the environments. |
environment_ids | array<integer> | Required | List of environment IDs to approve or reject. Each ID must be an integer. |
repository_name | string | Required | The name of the repository. This value is not case-sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
workflow_run_id | integer | Required | The unique identifier of the workflow run to be approved or rejected. |
Requirements
Output
json— Response from the API endpoint 'actions/review-pending-deployments-for-run'.GithubApi.AssignGithubIssue
Assign users to a GitHub issue. Use this tool to assign up to 10 users to a GitHub issue without replacing existing assignees.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issue_number | integer | Required | The number that identifies the GitHub issue to which assignees will be added. |
repository_name | string | Required | The name of the repository. This field is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
assignee_usernames | array<string> | Optional | Usernames of people to assign to the issue. Only users with push access can be assigned. |
Requirements
Output
json— Response from the API endpoint 'issues/add-assignees'.GithubApi.CancelGithubWorkflowRun
Cancels a GitHub workflow run using its ID. Use this tool to cancel an ongoing GitHub Actions workflow run. Authentication with an access token having `repo` scope is required. Useful for stopping workflows that may be executing erroneously or need interruption.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This is not case sensitive and should match the repository where the workflow run is located. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
workflow_run_id | integer | Required | The unique identifier of the GitHub workflow run to be canceled. This should be an integer value. |
Requirements
Output
json— Response from the API endpoint 'actions/cancel-workflow-run'.GithubApi.CheckBranchCommitSignatureStatus
Check if a branch requires signed commits for protection. Use this tool to determine if a branch in a GitHub repository requires signed commits. This is relevant for repositories with branch protection enabled. Appropriate permissions are needed to access this information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_name | string | Required | The name of the branch to check. It cannot contain wildcard characters. |
repository_name | string | Required | The name of the GitHub repository. This is not case sensitive. |
repository_owner | string | Required | The username of the repository owner. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-commit-signature-protection'.GithubApi.CheckCommitSignatureVerification
Fetches verification status of a commit's signature on GitHub. Use this tool to check whether a commit's signature in a GitHub repository is verified. It provides details about the verification status, including whether it's verified, the reason for the status, and details about the signature and payload. Call this tool when you need to verify the authenticity of a commit.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository to verify the commit signature. Not case-sensitive. |
repository_owner | string | Required | The account owner of the repository. This value is not case sensitive. |
commit_author_filter | string | Optional | GitHub login or email address to filter commits by author. |
commit_file_path_filter | string | Optional | Specify a file path to filter commits that only include changes to this path. |
only_commits_before_date | string | Optional | Filter commits to only include those before this date, formatted as `YYYY-MM-DDTHH:MM:SSZ`. |
results_page_number | integer | Optional | Page number of the results to fetch, used for pagination. |
results_per_page | integer | Optional | Specifies the number of commits to return per page, up to a maximum of 100. |
start_commit_sha_or_branch | string | Optional | SHA or branch to start listing commits from. Defaults to the repository's default branch, usually 'main'. |
updated_after_timestamp | string | Optional | Timestamp in ISO 8601 format to filter notifications updated after this time. |
Requirements
Output
json— Response from the API endpoint 'repos/list-commits'.GithubApi.CheckConfigStatus
Check the status of the most recent configuration process. Use this tool to determine whether the latest configuration process is pending, configuring, done, or failed. It may take several seconds after starting the process to check its status.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-configuration-status'.GithubApi.CheckGithubOrgMembership
Checks if a user is a public member of a GitHub organization. Use this tool to determine if a specific user is publicly a member of a particular GitHub organization. This can be useful for confirming a user's affiliation with an organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub user account handle to check for public organization membership. |
organization_name | string | Required | The case-insensitive name of the GitHub organization. |
Requirements
Output
json— Response from the API endpoint 'orgs/check-public-membership-for-user'.GithubApi.CheckGithubRepoCollaborator
Check if a user is a collaborator on a GitHub repository. This tool checks if a specific user is a collaborator on a GitHub repository, including outside collaborators, organization members with direct or team access, and organization owners. It requires authentication with appropriate permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub username to check collaboration status for. |
repository_name | string | Required | The name of the GitHub repository, case-insensitive. |
repository_owner | string | Required | The account owner of the GitHub repository, not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/check-collaborator'.GithubApi.CheckGithubTokenValidity
Check GitHub OAuth token validity with reduced rate limits.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_app_client_id | string | Required | The unique client ID of the GitHub application for OAuth authentication. |
oauth_access_token | string | Required | The OAuth access token to verify its validity with the GitHub API. |
Requirements
Output
json— Response from the API endpoint 'apps/check-token'.GithubApi.CheckIfGistIsStarred
Determine if a specific gist is starred on GitHub. This tool checks the starred status of a specific GitHub gist using its gist ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gist_identifier | string | Required | The unique identifier for the gist to check if it is starred. |
Requirements
Output
json— Response from the API endpoint 'gists/check-is-starred'.GithubApi.CheckIfUserIsFollowed
Check if a user is followed by the authenticated GitHub user. Use this tool to verify if the authenticated GitHub user is following another specified user. It determines the follow status between the authenticated user and the target user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The handle for the GitHub user account to check if they are followed by the authenticated user. |
Requirements
Output
json— Response from the API endpoint 'users/check-person-is-followed-by-authenticated'.GithubApi.CheckMaintenanceStatus
Retrieve the maintenance status of your GitHub installation. Use this tool to check the maintenance status of your GitHub installation. It's useful for determining if the installation is currently under maintenance.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-maintenance-status'.GithubApi.CheckOrgMigrationStatus
Fetches the status of an organization's migration. This tool retrieves the current status of a specific migration for an organization on GitHub. The migration status can be 'pending', 'exporting', 'exported', or 'failed'. Use this tool to monitor migration progress or verify completion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
migration_id | integer | Required | The unique identifier of the migration. Expected as an integer. |
organization_name | string | Required | The name of the organization, not case sensitive, for which to fetch migration status. |
exclude_attributes | array<string> | Optional | List of attribute names to exclude from the API response for improved performance. |
Requirements
Output
json— Response from the API endpoint 'migrations/get-status-for-org'.GithubApi.CheckPrMergeStatus
Check if a pull request has been merged. Use this tool to determine if a specific pull request in a GitHub repository has been merged. This is useful for tracking development progress and managing project contributions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pull_request_number | integer | Required | The unique number identifying the specific pull request to check. |
repository_name | string | Required | The name of the repository. Input is case insensitive. |
repository_owner | string | Required | The account owner of the repository. This value is not case sensitive. It specifies which user's or organization's repository contains the pull request. |
Requirements
Output
json— Response from the API endpoint 'pulls/check-if-merged'.GithubApi.CheckRepoCollaboratorPermission
Check a collaborator's permission level in a GitHub repo. Use this tool to find out if a collaborator has `admin`, `write`, `read`, or `none` permissions in a specific GitHub repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
collaborator_username | string | Required | The GitHub user account handle to check permissions for. |
repository_name | string | Required | The name of the GitHub repository (case insensitive). |
repository_owner | string | Required | The account owner of the repository (not case sensitive). |
Requirements
Output
json— Response from the API endpoint 'repos/get-collaborator-permission-level'.GithubApi.CheckRepoStarredByUser
Check if a repository is starred by the authenticated user. This tool verifies whether the authenticated user has starred a specific GitHub repository, identified by its owner and repository name.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository to check. This is case insensitive. |
repository_owner_account | string | Required | The account owner of the repository. This value is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'activity/check-repo-is-starred-by-authenticated-user'.GithubApi.CheckTeamProjectPermissions
Check team's permissions for an organization's project. Use this tool to determine if a team has `read`, `write`, or `admin` permissions for a specific project within an organization. This includes projects inherited from a parent team.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. It is not case sensitive. |
project_unique_identifier | integer | Required | The unique integer ID of the project to check permissions for. |
team_slug | string | Required | The slug of the team name used to identify the team within the organization. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'teams/check-permissions-for-project-in-org'.GithubApi.CheckTeamRepoPermissions
Check a team's permissions for a specific repository within an organization. This tool verifies whether a team has specific permissions (admin, push, maintain, triage, or pull) for a given repository within an organization on GitHub. It can be used to ensure access rights are correctly configured. If the team lacks permissions, a 404 response indicates no access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The organization name on GitHub. It is not case sensitive. Required to check team permissions. |
repository_name | string | Required | The name of the repository for which you want to check permissions. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository, not case sensitive. |
team_slug | string | Required | The slug of the team name. Used to identify the team whose permissions you are checking. |
Requirements
Output
json— Response from the API endpoint 'teams/check-permissions-for-repo-in-org'.GithubApi.CheckThreadSubscription
Check if the authenticated user is subscribed to a thread. This tool determines if the current user is subscribed to a specific thread on GitHub. Subscriptions are present if the user is participating in the conversation, such as replying, being @mentioned, or manually subscribing to the thread.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
notification_thread_id | integer | Required | The unique identifier of the notification thread, retrieved from notification data. |
Requirements
Output
json— Response from the API endpoint 'activity/get-thread-subscription-for-authenticated-user'.GithubApi.CheckUserAssignmentPermission
Check if a user can be assigned to a GitHub issue. This tool checks if a specified user has permission to be assigned to an issue within a given GitHub repository. It should be called when you need to verify a user's eligibility to be an assignee for issues in a repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. Input is not case sensitive. |
user_assignee | string | Required | The username of the GitHub user to check for issue assignment permissions. |
Requirements
Output
json— Response from the API endpoint 'issues/check-user-can-be-assigned'.GithubApi.CheckUserAssignPermission
Check if a user can be assigned to a GitHub issue. Use this tool to verify if a specific user can be assigned as an assignee to a particular issue in a GitHub repository. A 204 status indicates permission, while a 404 indicates the user cannot be assigned.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
assignee_username | string | Required | The GitHub username of the person to check for assignment permission. |
issue_identifier | integer | Required | The number that identifies the specific issue in the repository. |
repository_name | string | Required | The name of the repository, not case sensitive, where the issue is located. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'issues/check-user-can-be-assigned-to-issue'.GithubApi.CheckUserFollowingStatus
Verify if a user follows another GitHub user. This tool checks if one GitHub user follows another. Use it to determine follow relationships between two users on GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The handle for the GitHub user account initiating the following request. |
target_username | string | Required | The username of the GitHub account you want to check if the main user follows. |
Requirements
Output
json— Response from the API endpoint 'users/check-following-for-user'.GithubApi.CheckUserMembershipInOrg
Checks if a user is a member of a GitHub organization. This tool determines whether a specified user is a member of a specified GitHub organization, either publicly or privately. Use this tool to verify membership status in organizational repositories or workflows.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The username or handle for the GitHub user account being checked for organization membership. |
organization_name | string | Required | The case-insensitive name of the GitHub organization to check membership against. |
Requirements
Output
json— Response from the API endpoint 'orgs/check-membership-for-user'.GithubApi.CompareDependencyChanges
Get dependency changes between two commits of a repository. Use this tool to retrieve a diff of dependency changes based on updates to dependency manifests between two specified commits in a GitHub repository. It is useful for understanding what dependencies have been added, removed, or updated.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_and_head_commit_specification | string | Required | Specify the base and head commits in the format `{base}...{head}` for comparison. |
repository_name | string | Required | The name of the repository to compare. It is not case sensitive. |
repository_owner_name | string | Required | The account owner of the repository. The name is not case sensitive. |
dependency_manifest_file_path | string | Optional | The full path, relative to the repository root, of the dependency manifest file. |
Requirements
Output
json— Response from the API endpoint 'dependency-graph/diff-range'.GithubApi.CompareGithubCommits
Compares two commits in a GitHub repository. Use this tool to compare two commits in a GitHub repository, including those in different branches or forks. Returns details about file changes, commit order, and signature verification status. Useful for understanding code changes and repository history.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
base_and_head_branch_comparison | string | Required | Specify branches/base and head in the format `BASE...HEAD` or `USERNAME:BASE...USERNAME:HEAD` to compare them. |
repository_name | string | Required | The name of the GitHub repository to compare commits in. This input is not case sensitive. |
repository_owner | string | Required | The username of the account that owns the repository. This name is not case sensitive. |
page_number | integer | Optional | Page number of the results to fetch. Used for pagination to navigate through commit comparisons. |
results_per_page | integer | Optional | Specifies the number of commit results returned per page. Maximum allowed is 100. |
Requirements
Output
json— Response from the API endpoint 'repos/compare-commits'.GithubApi.CompleteGithubAppHandshake
Complete the GitHub App Manifest handshake to retrieve app details. Use this tool to finalize the creation of a GitHub App via the manifest flow, retrieving the app's id, pem (private key), and webhook_secret using a temporary code.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
temporary_code_for_github_app | string | Required | The temporary code provided during the GitHub App Manifest flow to retrieve the app's id, pem, and webhook_secret. |
Requirements
Output
json— Response from the API endpoint 'apps/create-from-manifest'.GithubApi.ConfigureGithubActionsCache
Set GitHub Actions cache usage policy for a repository. Use this tool to configure the cache usage policy for GitHub Actions in a repository. Authentication with an access token with 'repo' scope is required, or GitHub Apps need 'actions:write' permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_cache_size_limit_gb | integer | Required | Specify the size limit for all GitHub Actions caches in the repository, in gigabytes. |
repository_name | string | Required | The name of the GitHub repository. This field is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is the GitHub username or organization name and is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/set-actions-cache-usage-policy'.GithubApi.ConfigureGithubActionsPermissions
Configure GitHub Actions permissions for an organization. Use this tool to set the GitHub Actions permissions policy for repositories and allowed actions within an organization. Note that enterprise-level restrictions cannot be overridden. Requires authentication with an 'admin:org' token or 'administration' organization permission for GitHub Apps.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
repository_execution_policy | string | Required | Specifies which repositories in the organization are allowed to run GitHub Actions. Options: 'all', 'none', 'selected'. |
allowed_actions_policy | string | Optional | Specifies the permissions policy for actions: 'all', 'local_only', or 'selected'. |
Requirements
Output
json— Response from the API endpoint 'actions/set-github-actions-permissions-organization'.GithubApi.ConfigureGithubPagesSite
Configures a GitHub Pages site for a repository. This tool is used to configure a Pages site for a GitHub repository on an Enterprise Server. It requires administrative permissions on the repository and a token with appropriate scopes. Use this when you need to set up or manage a GitHub Pages site. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The account owner of the repository. This is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the repository to configure. It is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'repos/create-pages-site'.GithubApi.ConfigureGithubTokenPermissions
Set default workflow permissions for a repository's GitHub Actions. This tool updates the default permissions granted to the `GITHUB_TOKEN` when workflows run in a GitHub repository. It also configures GitHub Actions' ability to submit approving pull request reviews. Authentication with a token having `repo` scope is required, or GitHub Apps must have `administration` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is not case sensitive. |
default_workflow_permissions | string | Optional | Specify the default permissions ('read' or 'write') for the GITHUB_TOKEN when running workflows. |
enable_pull_request_approval | boolean | Optional | Set to true to allow GitHub Actions to approve pull requests. Enabling this may pose a security risk. |
Requirements
Output
json— Response from the API endpoint 'actions/set-github-actions-default-workflow-permissions-repository'.GithubApi.ConvertMemberToOutsideCollaborator
Convert GitHub org member to outside collaborator. Use this tool to convert an organization member into an outside collaborator on GitHub. The member will lose their organization membership and retain access only to repositories allowed by their team memberships. This action might be restricted by enterprise policies.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub user handle to be converted to an outside collaborator. |
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
perform_asynchronously | boolean | Optional | Set to true to perform the request asynchronously, queuing the job with a 202 status code. |
Requirements
Output
json— Response from the API endpoint 'orgs/convert-member-to-outside-collaborator'.GithubApi.CreateEnterpriseScimGroup
Create a SCIM group for a GitHub enterprise account. Facilitates the creation of a SCIM group within a GitHub enterprise. This tool should be used when you need to establish a new group with optional member inclusion. Any specified members will be added as external group members, and it's important to maintain mapping of their identifiers. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/provision-enterprise-group'.GithubApi.CreateEnterpriseUser
Creates a new user in GitHub enterprise with external authentication. This tool should be called to create a new user in GitHub Enterprise when using external authentication mechanisms like LDAP. It ensures the login name is normalized and manages existing account conflicts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_username | string | Required | The user's username for the GitHub enterprise account. It will be normalized to contain only alphanumeric characters or single hyphens. |
user_email | string | Optional | The email address of the user. Required for built-in authentication but optional for CAS, LDAP, or SAML auth methods. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/create-user'.GithubApi.CreateGist
Create a new gist with one or more files on GitHub. Use this tool to add a new gist containing one or more code files on GitHub. Avoid naming files with the 'gistfile' format followed by a number, as it may conflict with GitHub's internal naming scheme. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'gists/create'.GithubApi.CreateGistComment
Create a comment on a GitHub gist. This tool is used to add a comment to a specific GitHub gist by providing the necessary gist ID and comment content.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_text | string | Required | The text content of the comment to be added to the gist. |
gist_unique_identifier | string | Required | The unique identifier of the gist to comment on. |
Requirements
Output
json— Response from the API endpoint 'gists/create-comment'.GithubApi.CreateGitCommit
Create a new Git commit on a GitHub repository. This tool creates a new Git commit on a specified GitHub repository and verifies the commit's signature. It returns information about the verification status, including whether it's verified and the reason, if applicable. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The account owner of the repository. This name is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the GitHub repository (case insensitive). Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'git/create-commit'.GithubApi.CreateGithubAppInstallationToken
Create an installation access token for a GitHub App. Use this tool to generate an installation access token for a GitHub App, allowing it to make authenticated API requests for its installation on an organization or individual account. Tokens expire in one hour and can be restricted to specific repositories by providing `repository_ids`. Requires JWT authentication. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
installation_id | integer | Optional | The unique identifier for the GitHub App installation. Required to create the access token. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'apps/create-installation-access-token'.GithubApi.CreateGithubBlob
Create a new blob in a GitHub repository. This tool creates a new blob object in a specified GitHub repository. It is useful when you need to add or modify a blob within the repository, typically for storing binary data or files.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
blob_content | string | Required | The content for the new GitHub blob. Accepts text or encoded binary data. |
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. This is not case sensitive. |
content_encoding | string | Optional | Specify the encoding for the blob content. Supported values are 'utf-8' and 'base64'. |
Requirements
Output
json— Response from the API endpoint 'git/create-blob'.GithubApi.CreateGithubCheckRun
Create a new check run for a GitHub repository commit. This tool creates a new check run associated with a specific commit in a GitHub repository. It requires the 'checks:write' permission in the GitHub App. Note that this tool is sensitive to the branch it's applied to, as it only processes pushes in the repository where it's created, not in forked repositories. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The account owner of the repository. The name is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the repository. It is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'checks/create'.GithubApi.CreateGithubCheckSuite
Manually create a check suite on GitHub. Use this tool to manually create a check suite in a GitHub repository when automatic creation is disabled. Ensure your GitHub App has the `checks:write` permission before using this endpoint.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
head_commit_sha | string | Required | The SHA of the head commit for the check suite. Ensure it's a valid commit SHA. |
repository_name | string | Required | The name of the GitHub repository where the check suite will be created. It is not case sensitive. |
repository_owner_account | string | Required | Specify the account owner of the repository. This name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'checks/create-suite'.GithubApi.CreateGithubCommitComment
Create a comment on a specific GitHub commit. Use this tool to add a comment to a specific commit on a GitHub repository using the commit's SHA identifier. Useful for discussing changes directly within the commit history. Be mindful of rate limiting when using this endpoint.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_content | string | Required | The text of the comment to be added to the commit. It should be a clear and concise message. |
commit_sha | string | Required | The SHA identifier of the commit to comment on. It uniquely identifies the commit within the repository. |
repository_name | string | Required | The name of the GitHub repository where the commit resides. It's not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. Name is not case sensitive. |
deprecated_line_number | integer | Optional | Line number in the file to comment on. **Deprecated**. Use the `position_in_diff` instead. |
line_index_in_diff | integer | Optional | Line index in the diff to comment on. |
relative_file_path | string | Optional | Relative path of the file to comment on within the repository. |
Requirements
Output
json— Response from the API endpoint 'repos/create-commit-comment'.GithubApi.CreateGithubCommitStatus
Create a commit status for a specific SHA on GitHub. Use this tool to set a commit status for a specific SHA in a GitHub repository if you have push access. Useful for marking build status, testing results, or other commit contexts. Be mindful of the 1000 status limit per SHA and context.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
commit_sha | string | Required | The SHA hash of the commit to set the status for. This uniquely identifies the commit in the repository. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. Enter the owner's username (not case sensitive). |
status_state | string | Required | The state of the status for the commit. Possible values are 'error', 'failure', 'pending', or 'success'. |
commit_status_target_url | string | Optional | The URL associated with the status for easy navigation in GitHub. Example: a deep link to CI build output. |
status_description | string | Optional | A short description of the commit status, providing context or details about the status. |
status_label | string | Optional | A case-insensitive string label to differentiate this status from other systems. |
Requirements
Output
json— Response from the API endpoint 'repos/create-commit-status'.GithubApi.CreateGithubDeployKey
Create a read-only deploy key for a GitHub repository. Use this tool to generate a read-only deploy key for a specified GitHub repository. Ideal for automating and securing repository access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
deploy_key_contents | string | Required | The public key contents to be added as a deploy key. |
repository_name | string | Required | The case-insensitive name of the GitHub repository. |
repository_owner | string | Required | The account owner of the GitHub repository. Name is not case sensitive. |
key_title | string | Optional | A name for the deploy key for identification purposes. |
read_only_access | boolean | Optional | Set to `true` for read-only access. `False` allows both read and write access. |
Requirements
Output
json— Response from the API endpoint 'repos/create-deploy-key'.GithubApi.CreateGithubDeployment
Create a GitHub deployment for a specified repository ref. Use this tool to create deployments for a specific branch, tag, or SHA in a GitHub repository. Configure parameters like environment, auto-merge, and required contexts. Suitable for deploying to production, staging, or testing environments. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The account owner of the repository. This input is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the repository to deploy. Not case-sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'repos/create-deployment'.GithubApi.CreateGithubDeploymentBranchPolicy
Creates a deployment branch policy for a GitHub environment. This tool is used to create a deployment branch policy within a specified environment on GitHub. It requires authentication with a valid access token with the 'repo' scope or a GitHub App with 'administration:write' permission for the repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_name_pattern | string | Required | A pattern that branches must match to deploy to the environment. Wildcard characters won't match '/'. |
environment_name | string | Required | The name of the environment for which to create a deployment branch policy. |
repository_name | string | Required | The name of the GitHub repository, not case sensitive. |
repository_owner | string | Required | The account owner of the repository. Case insensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/create-deployment-branch-policy'.GithubApi.CreateGithubDeploymentStatus
Create deployment statuses for a GitHub deployment. This tool allows users with appropriate permissions to create deployment statuses on GitHub for a specific deployment. It requires push access for users, and specific access scopes for GitHub and OAuth Apps. Use this tool to update the status of your deployments directly within GitHub repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
deployment_id | integer | Required | The unique identifier for the deployment. This integer value specifies which deployment the status will be associated with. |
deployment_status_state | string | Required | The desired state of the deployment status. Options include: 'error', 'failure', 'inactive', 'in_progress', 'queued', 'pending', 'success'. |
repository_name | string | Required | The name of the GitHub repository. Case insensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
add_inactive_status_to_previous_deployments | boolean | Optional | Specifies if an 'inactive' status should be added to prior non-transient, non-production deployments with the same repository and environment. Defaults to true. |
deployment_environment | string | Optional | Specifies the target deployment environment, such as `production`, `staging`, or `qa`. |
deployment_environment_url | string | Optional | Sets the URL for accessing your deployment environment. Defaults to an empty string if not provided. |
deployment_output_url | string | Optional | The full URL of the deployment's output. It replaces `target_url` and automatically sets `target_url` to the same value. Recommended for output logs. |
deployment_status_target_url | string | Optional | Specify the URL containing output related to the deployment status. Note that it's recommended to use `log_url` instead, which replaces this parameter. |
status_description | string | Optional | A brief description of the deployment status, up to 140 characters. |
Requirements
Output
json— Response from the API endpoint 'repos/create-deployment-status'.GithubApi.CreateGithubEnterpriseRegistrationToken
Generate a registration token for GitHub Enterprise runners. Use this tool to obtain a registration token for configuring self-hosted GitHub Enterprise runners. The token expires after one hour and requires authentication with a token having the `manage_runners:enterprise` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_slug_or_id | string | Required | The slug version of the enterprise name or the enterprise ID for GitHub Enterprise. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/create-registration-token-for-enterprise'.GithubApi.CreateGithubEnvVariable
Create an environment variable for GitHub Actions workflows. This tool creates an environment variable that can be referenced in a GitHub Actions workflow. Authentication with an access token and appropriate permissions is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
environment_name | string | Required | Specify the name of the environment where the variable will be created. This is required for defining the scope within GitHub Actions workflows. |
repository_identifier | integer | Required | The unique identifier of the repository for which the environment variable is being created. |
variable_name | string | Required | The name of the environment variable to be created. |
variable_value | string | Required | The value assigned to the environment variable. Must be a string. |
Requirements
Output
json— Response from the API endpoint 'actions/create-environment-variable'.GithubApi.CreateGithubFork
Create a fork of a GitHub repository for the user. Create a fork of a GitHub repository for the authenticated user. Note that the forking process happens asynchronously and might take some time. Contact GitHub support if it takes longer than 5 minutes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository to fork. It's not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. This name is not case-sensitive. |
fork_default_branch_only | boolean | Optional | Set to true to fork only the default branch of the repository. |
new_fork_name | string | Optional | Specify a new name for the forked repository when forking an existing repository. |
organization_name | string | Optional | Optional. Specify the organization name to fork into. If not provided, the fork will default to the user's account. |
Requirements
Output
json— Response from the API endpoint 'repos/create-fork'.GithubApi.CreateGithubIssue
Create a new issue in a GitHub repository. Use this tool to create a new issue in a specific GitHub repository. This can be done by any user with pull access to the repository. Note that if issues are disabled for the repository, a 410 status will be returned. Be cautious of triggering secondary rate limits by creating content too quickly. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The account owner of the GitHub repository. Provide the username or organization name, case insensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the GitHub repository. Case insensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'issues/create'.GithubApi.CreateGithubLabel
Creates a label in a specified GitHub repository. Use this tool to add a new label to a GitHub repository, which can help categorize and manage issues effectively.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
label_name | string | Required | The name of the label, supporting emojis using either native emoji or colon-style markup. |
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. Case insensitive. |
label_color_hex | string | Optional | The hexadecimal color code for the label, without the leading '#'. |
label_description | string | Optional | A short description of the label, with a maximum of 100 characters. |
Requirements
Output
json— Response from the API endpoint 'issues/create-label'.GithubApi.CreateGithubMilestone
Create a milestone in a GitHub repository. Use this tool to create a new milestone in a specified GitHub repository, useful for project management and tracking.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
milestone_title | string | Required | The title of the milestone to be created in the GitHub repository. |
repository_name | string | Required | The name of the repository, not case sensitive. |
repository_owner | string | Required | The GitHub username or organization name that owns the repository. Not case sensitive. |
milestone_description | string | Optional | A text description of the milestone to be created in the GitHub repository. |
milestone_due_date | string | Optional | The due date for the milestone in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. |
milestone_state | string | Optional | State of the milestone, either 'open' or 'closed'. |
Requirements
Output
json— Response from the API endpoint 'issues/create-milestone'.GithubApi.CreateGithubOrganization
Create a new organization on GitHub. This tool is used to create a new organization on GitHub Enterprise. Call it when you need to set up a new organization within a GitHub Enterprise setup.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
admin_user_login | string | Required | The login username of the user designated to manage the new GitHub organization. |
organization_username | string | Required | The username for the organization in GitHub. |
organization_display_name | string | Optional | The display name for the organization to be created on GitHub. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/create-org'.GithubApi.CreateGithubOrganizationRepo
Create a new repository in a GitHub organization. Use this tool to create a new repository within a specified GitHub organization. The user must have appropriate OAuth scopes and be a member of the organization. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
organization_name | string | Optional | The name of the GitHub organization where the repository will be created. The name is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'repos/create-in-org'.GithubApi.CreateGithubOrgVariable
Create an organization variable for GitHub Actions workflows. Creates an organization variable in GitHub that can be referenced in Actions workflows. Requires an access token with `admin:org` scope or `organization_actions_variables:write` permission for GitHub Apps.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. It is not case sensitive. |
repository_access_visibility | string | Required | Type of repositories in the organization that can access the variable: 'all', 'private', or 'selected'. |
variable_name | string | Required | The name of the organization variable to be created. This name will be used to reference the variable in workflows. |
variable_value | string | Required | The value assigned to the organization variable in GitHub. |
repository_ids_with_variable_access | array<integer> | Optional | List of repository IDs allowed to access the organization variable. Required when 'visibility' is 'selected'. |
Requirements
Output
json— Response from the API endpoint 'actions/create-org-variable'.GithubApi.CreateGithubOrgWebhook
Create a webhook for a GitHub organization. This tool is used to set up a webhook for a GitHub organization to post payloads in JSON format. Call this tool when you need to automate notifications or integrate with other services based on GitHub events. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
organization_name | string | Optional | The name of the GitHub organization. This value is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'orgs/create-webhook'.GithubApi.CreateGithubPagesDeployment
Create a GitHub Pages deployment for a repository. Use this tool to deploy a GitHub Pages site for a repository. Requires write permissions or `pages:write` permission for GitHub Apps.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
artifact_url | string | Required | URL of the artifact (.zip or .tar) with static assets for deployment. Must belong to the repository. |
oidc_token_for_deployment | string | Required | The OIDC token from GitHub Actions used to certify the deployment origin. |
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is not case sensitive. |
build_version_identifier | string | Optional | A unique string representing the version of the deployment build. |
target_environment_for_deployment | string | Optional | Specify the target environment for the GitHub Pages deployment (e.g., 'production', 'staging'). |
Requirements
Output
json— Response from the API endpoint 'repos/create-pages-deployment'.GithubApi.CreateGithubProjectBoard
Create a project board for a GitHub repository. This tool creates a project board for a specified GitHub repository. It's useful when you want to organize tasks or issues in the form of a project board within a repository. It returns information about the creation status and any errors due to disabled projects or insufficient privileges.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_name | string | Required | The name of the project board to be created in the repository. |
repository_name | string | Required | The name of the GitHub repository. It is not case-sensitive. |
repository_owner | string | Required | The username of the account that owns the repository. This is not case sensitive. |
project_description | string | Optional | Provide a descriptive text for the project board to help clarify its purpose and content. |
Requirements
Output
json— Response from the API endpoint 'projects/create-for-repo'.GithubApi.CreateGithubProjectCard
Create a project card in a specified GitHub column. Use this tool to create a new project card in a specified column within a GitHub project. It helps organize tasks or notes in a project on GitHub. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
column_identifier | integer | Optional | The unique identifier of the GitHub project column where the card will be added. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'projects/create-card'.GithubApi.CreateGithubPullRequest
Create a draft pull request on GitHub repositories. Use this tool to create a draft pull request on a specified GitHub repository. Requires write access to the head or source branch. Suitable for users with appropriate permissions on public, private or organization-owned repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository for the pull request. It is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. Case-insensitive. |
source_branch | string | Required | The name of the branch where your changes are implemented. Use `username:branch` format for cross-repository cases. |
target_branch | string | Required | The branch name where changes are to be merged. Must be an existing branch in the current repository. |
is_draft | boolean | Optional | Set to true to create the pull request as a draft. See GitHub documentation for more on draft pull requests. |
issue_number_for_conversion | integer | Optional | Specify the issue number in the repository to convert into a pull request. Required unless a title is provided. |
maintainers_can_modify | boolean | Optional | Indicates if maintainers can modify the pull request. Set to true to allow modifications. |
pull_request_content | string | Optional | The descriptive content or message for the pull request. |
pull_request_title | string | Optional | The title of the new pull request. This is required unless an `issue` is specified. |
source_repository_name | string | Optional | Name of the repository where changes in the pull request were made. Required for cross-repository pull requests within the same organization. |
Requirements
Output
json— Response from the API endpoint 'pulls/create'.GithubApi.CreateGithubPullRequestReview
Create a review for a GitHub pull request. Use this tool to create a review for a specific pull request on GitHub, either in the 'PENDING' state or by submitting it. Ideal for adding comments or feedback on code changes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The account owner of the repository (case-insensitive). Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the repository where the pull request exists, not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
pull_request_number | integer | Optional | The number that uniquely identifies the pull request for which the review is being created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'pulls/create-review'.GithubApi.CreateGithubRelease
Creates a new release in a specified GitHub repository. This tool allows users with push access to create a release in a specified GitHub repository. It triggers notifications and may be subject to rate limiting. Use this tool when you need to publish a new version or release of your software on GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository on GitHub. This name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
tag_name_for_release | string | Required | The name of the tag for the release. This is used to label the GitHub release. |
auto_generate_release_notes | boolean | Optional | Automatically generate the name and body for the release. If 'name' is provided, it is used; otherwise, a name is auto-generated. 'Body' is prepended to generated notes if specified. |
commit_reference | string | Optional | The branch or commit SHA from which the Git tag is created. Defaults to the repo's default branch. |
draft | boolean | Optional | Set to `true` for a draft (unpublished) release, or `false` for a published one. |
mark_as_prerelease | boolean | Optional | Set to `true` for a prerelease, `false` for a full release. |
release_body_text | string | Optional | Text describing the contents of the tag. This is the message or notes for the release, providing context or details about changes. |
release_name | string | Optional | The name of the release. This identifies the release and can be a version or descriptive text. |
set_latest_release | boolean | Optional | Set whether this release should be the latest. Use 'true', 'false', or 'legacy'. Drafts and prereleases cannot be set as latest. |
Requirements
Output
json— Response from the API endpoint 'repos/create-release'.GithubApi.CreateGithubRepoForUser
Create a new GitHub repository for the authenticated user. This tool creates a new repository for the authenticated user. It requires appropriate OAuth scopes: `public_repo` or `repo` for public repositories, and `repo` for private repositories. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'repos/create-for-authenticated-user'.GithubApi.CreateGithubRepoVariable
Create a variable for a GitHub repository to use in Actions workflows. Use this tool to create a repository variable that can be referenced in a GitHub Actions workflow. Ensure that you authenticate with a token having the 'repo' scope, or ensure GitHub Apps have 'actions_variables:write' permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. This value is not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. Case insensitive. |
variable_name | string | Required | The name of the repository variable to create. |
variable_value | string | Required | The content or data for the repository variable. |
Requirements
Output
json— Response from the API endpoint 'actions/create-repo-variable'.GithubApi.CreateGithubRepoWebhook
Create a webhook for a GitHub repository. This tool sets up a webhook for a specified GitHub repository, allowing integrations to receive events. Use this when you want to trigger actions in response to repository events. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The account owner of the GitHub repository. It is case insensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the GitHub repository. The name is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'repos/create-webhook'.GithubApi.CreateGithubRequiredWorkflow
Create a required workflow in a GitHub organization. This tool creates a required workflow within a specified GitHub organization. It requires an access token with 'admin:org' scope for authentication. Use this tool when setting up or enforcing organizational workflow standards on GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
repository_identifier | string | Required | The ID of the repository that contains the workflow file. Use this to specify which repository's workflow file should be used. |
workflow_file_path | string | Required | Path of the workflow file to set as required for the organization. |
repository_ids_for_selected_scope | array<integer> | Optional | List of repository IDs to enable the workflow when `scope` is 'selected'. |
workflow_scope | string | Optional | Specify whether to enable the required workflow for all repositories or only selected ones within the organization. Use 'all' for all repositories and 'selected' when specifying particular repositories. |
Requirements
Output
json— Response from the API endpoint 'actions/create-required-workflow'.GithubApi.CreateGithubScopedToken
Create a GitHub repository and permission scoped token. This tool generates a repository and/or permission scoped user-to-server access token for GitHub. It requires a non-scoped token and the client's Basic Authentication details. Use this when specific repository access or permission is needed for an app. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
github_client_id | string | Optional | The client ID of your GitHub app used for authentication. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'apps/scope-token'.GithubApi.CreateGithubTeam
Create a new team in a GitHub organization. Use this tool to create a new team within a specified GitHub organization. The authenticated user must be a member or owner of the organization. Upon creation, the user becomes a team maintainer by default.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The case-insensitive name of the GitHub organization where the team will be created. |
team_name | string | Required | The name of the team to be created. It should be a string. |
deprecated_repository_permission | string | Optional | Specifies the permission for new repositories, though it is deprecated. Options are `pull` or `push`. |
ldap_distinguished_name | string | Optional | The distinguished name (DN) of the LDAP entry to map to a team. Ensure LDAP synchronization is enabled. |
parent_team_id | integer | Optional | The numerical ID of the team to assign as the parent for the new team. |
repository_names_to_add_to_team | array<string> | Optional | Array of full repository names (e.g., "organization-name/repository-name") to associate with the team. |
team_description | string | Optional | A brief description of the team being created. This helps specify the team's purpose or role within the organization. |
team_maintainers_github_ids | array<string> | Optional | List of GitHub IDs for organization members who will become team maintainers. |
team_privacy_level | string | Optional | Specifies if the team is 'secret' or 'closed'. Defaults: 'secret' for non-nested teams, 'closed' for parent/child teams. |
Requirements
Output
json— Response from the API endpoint 'teams/create'.GithubApi.CreateGithubUserProjectBoard
Create a project board for a GitHub user. This tool creates a project board for an authenticated GitHub user. It returns a `410 Gone` status if the user does not have existing classic projects, or `401 Unauthorized` if privileges are insufficient.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_name | string | Required | The name for the GitHub project board to be created. It should be a string representing the desired name. |
project_body | string | Optional | The content or description of the GitHub project board. It should be a concise string summarizing the project's purpose or details. |
Requirements
Output
json— Response from the API endpoint 'projects/create-for-authenticated-user'.GithubApi.CreateGitReference
Create a new reference in a GitHub repository. Use this tool to create a new reference in a GitHub repository, such as a branch or a tag. Ensure the repository is not empty and contains at least one branch.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
full_reference_name | string | Required | The fully qualified reference name (e.g., 'refs/heads/master'). Must start with 'refs' and include at least two slashes. |
reference_sha | string | Required | The SHA-1 value for the reference. Required for creating a new reference in the repository. |
repository_name | string | Required | The case-insensitive name of the GitHub repository to create a reference in. |
repository_owner | string | Required | The account owner of the repository, not case sensitive. |
authentication_token | string | Optional | The GitHub authentication token required to authorize the API request. |
Requirements
Output
json— Response from the API endpoint 'git/create-ref'.GithubApi.CreateGitTag
Create a Git tag object on GitHub. Use this tool to create a Git tag object on GitHub. Note that this does not automatically create the reference to make a tag in the repository; an additional call is required to create the reference. The response includes a verification object with details on the commit's signature verification, providing insights into if and why a signature was verified, or any issues that occurred.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
git_object_sha | string | Required | The SHA of the Git object to tag, typically a commit, tree, or blob. |
repository_name | string | Required | The name of the repository. This value is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
tag_message | string | Required | The message or description for the tag, providing context or details about it. |
tag_name | string | Required | The name of the tag, typically a version (e.g., 'v0.0.1'). |
tag_object_type | string | Required | Specifies the type of the object being tagged. Acceptable values are 'commit', 'tree', or 'blob'. |
author_of_tag_name | string | Optional | The name of the author of the tag. It should be a string providing the full name. |
tagger_email | string | Optional | The email address of the tag author. This should be in a valid email format. |
tagging_date | string | Optional | The date and time when the object was tagged, in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. |
Requirements
Output
json— Response from the API endpoint 'git/create-tag'.GithubApi.CreateGitTree
Create or modify a git tree in a GitHub repository. Use this tool to create or modify a tree structure in a specified GitHub repository. It is useful for organizing files and directories within a repository's tree. Note that after creating or modifying a tree, you must commit the changes and update the branch reference. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The GitHub account owner of the repository. The name is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the repository. It is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'git/create-tree'.GithubApi.CreateGlobalWebhook
Create a global webhook in GitHub Enterprise Admin. Use this tool to create a global webhook for GitHub Enterprise. It should be called when you need to set up notifications for all repositories across the organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
payload_delivery_url | string | Required | The destination URL where the webhook payloads will be delivered. Ensure this URL is accessible and properly configured to handle incoming requests. |
webhook_type | string | Required | Specifies the type of webhook. Must be set to "web". |
hmac_key_for_signature | string | Optional | The key for generating the HMAC hex digest in the X-Hub-Signature header. Optional. |
payload_content_type | string | Optional | Specifies the media type for payload serialization. Options: 'json', 'form'. Default is 'form'. |
send_notifications | boolean | Optional | Set to `true` to send notifications when the webhook is triggered. |
ssl_verification | string | Optional | Set '0' to verify SSL certificate of the host for the URL; '1' to skip verification. Default is '0'. Avoid setting to '1' to prevent security risks. |
trigger_events | array<string> | Optional | List of events that trigger the webhook. Default events are `user` and `organization`. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/create-global-webhook'.GithubApi.CreateImpersonationOauthToken
Create an impersonation OAuth token for a GitHub user. This tool is used to generate an impersonation OAuth token for a specified GitHub user, typically for enterprise administration purposes. It should be called when there is a need to access a user's resources on their behalf in an enterprise GitHub environment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub user account handle for which to create the impersonation OAuth token. |
oauth_scopes_list | array<string> | Required | A list of scopes defining the permissions for the OAuth token. Each scope is a string representing a specific set of access rights. Refer to [scopes documentation](https://docs.github.com/[email protected]/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) for valid options. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/create-impersonation-o-auth-token'.GithubApi.CreateOrgProjectGithub
Create a project board for a GitHub organization. This tool creates a project board within a specified GitHub organization. It should be called when you need to set up a new project board for organizational tasks. It returns details about the created project or errors if projects are disabled, insufficient privileges are available, or the organization lacks classic projects.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name. Not case sensitive. |
project_name | string | Required | The name of the project board to be created. It will serve as the identifier for the project within the organization. Must be a string. |
project_description | string | Optional | The description of the project to be created for the GitHub organization. This should be a clear and concise explanation of the project's purpose. |
Requirements
Output
json— Response from the API endpoint 'projects/create-for-org'.GithubApi.CreateOrgRunnerRegistrationToken
Generate a registration token for GitHub organization runners. Use this tool to obtain a registration token for configuring a self-hosted runner in a GitHub organization. The token is valid for one hour and requires authentication with an access token having the 'admin:org' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. This is not case-sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/create-registration-token-for-org'.GithubApi.CreateOrUpdateGithubRepoSecret
Create or update a GitHub repository secret with an encrypted value. Use this tool to create or update a secret in a GitHub repository by providing an encrypted value. Requires authentication with a token having the `repo` scope or GitHub App permissions. Useful for managing sensitive information in repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
secret_name | string | Required | The name of the secret to create or update in the repository. |
encrypted_secret_value | string | Optional | The secret's value encrypted with LibSodium using a repository's public key. |
encryption_key_id | string | Optional | Provide the ID of the key used to encrypt the secret. |
Requirements
Output
json— Response from the API endpoint 'actions/create-or-update-repo-secret'.GithubApi.CreateOrUpdateOrgSecret
Create or update an organization's secret on GitHub. Use this tool to create or update a secret within a GitHub organization using an encrypted value. The secret must be encrypted with LibSodium, and authentication requires a token with 'admin:org' scope. GitHub Apps need 'secrets' organization permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
repository_visibility | string | Required | Specifies which type of organization repositories have access to the organization secret. Choices are 'all', 'private', or 'selected'. |
secret_name | string | Required | The name of the secret. It's used to identify the secret within the organization. |
encrypted_secret_value | string | Optional | The secret's encrypted value using LibSodium and a GitHub org public key. |
encryption_key_id | string | Optional | The ID of the public key used to encrypt the secret. This must match the key used during encryption. |
repository_ids_for_secret_access | array<integer> | Optional | Array of repository ids allowed access to the secret. Provide only when `visibility` is `selected`. |
Requirements
Output
json— Response from the API endpoint 'actions/create-or-update-org-secret'.GithubApi.CreatePreReceiveEnvironment
Create a new pre-receive environment on GitHub Enterprise. This tool is used to create a pre-receive environment in GitHub Enterprise. It should be called when you need to set up an environment for pre-receive hooks.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pre_receive_environment_name | string | Required | The name of the new pre-receive environment to be created. |
tarball_download_url | string | Required | URL to download the tarball for the pre-receive environment setup. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/create-pre-receive-environment'.GithubApi.CreatePreReceiveHook
Create a pre-receive hook for GitHub enterprise administration. Use this tool when you need to create a pre-receive hook for managing GitHub enterprise repositories. It's crucial for setting up checks before code is accepted. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/create-pre-receive-hook'.GithubApi.CreateProjectColumn
Create a new column in a GitHub project. This tool creates a new column in a specified GitHub project board. Useful for organizing tasks or issues within project management workflows.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
column_name | string | Required | The name of the column to be created in the GitHub project. |
project_id | integer | Required | The unique integer identifier for the GitHub project where the column will be created. |
Requirements
Output
json— Response from the API endpoint 'projects/create-column'.GithubApi.CreatePullRequestReviewComment
Create a review comment on a GitHub pull request. This tool is used to create a review comment in the diff of a GitHub pull request. It uses parameters like `line`, `side`, `start_line`, and `start_side` for precise placement of comments in the pull request diff to provide feedback or suggestions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The GitHub username or organization name of the repository owner. This value is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the GitHub repository where the pull request exists. This value is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
pull_request_number | integer | Optional | The unique number that identifies the pull request within the repository. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'pulls/create-review-comment'.GithubApi.CreateReplyToReviewComment
Create a reply to a top-level review comment on a pull request. This tool creates a reply to a top-level review comment on a pull request. Users can utilize this tool when they need to respond to review comments made on their pull requests, ensuring proper communication and collaboration. Note that replies to replies are not supported. Creating content too quickly may trigger secondary rate limits.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pull_request_number | integer | Required | The number identifying the pull request to reply to. |
repository_name | string | Required | The name of the repository. This name is not case sensitive and identifies the repository where the reply will be posted. |
repository_owner | string | Required | The account owner of the repository. Not case sensitive. |
review_comment_text | string | Required | The content of the reply to the top-level review comment. This should be a string containing the reply text. |
review_comment_unique_id | integer | Required | The unique identifier for the top-level review comment you are replying to. Replies to replies are not supported. |
Requirements
Output
json— Response from the API endpoint 'pulls/create-reply-for-review-comment'.GithubApi.CreateRepoDependencySnapshot
Create a snapshot of a repository's dependencies. This tool creates a new snapshot of a GitHub repository's dependencies. It requires authentication with an access token that has the `repo` scope. Use this tool to capture the current state of a repository's dependencies for analysis or auditing. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The account owner of the GitHub repository. This name is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the GitHub repository to create a dependency snapshot for. The name is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'dependency-graph/create-repository-snapshot'.GithubApi.CreateRepoFromTemplate
Create a new repository from a template. Use this tool to create a new GitHub repository using an existing repository template. Specify the template by providing the template owner's and repository's names. Ensure the template is accessible and the necessary OAuth scopes are authorized. This tool is useful when needing to quickly start a new project with predefined settings and structure.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
new_repository_name | string | Required | The name of the new repository to be created using the template. |
template_repository_name | string | Required | The name of the repository template to use for creating the new repository. |
template_repository_owner | string | Required | Username or organization name that owns the template repository. |
create_private_repository | boolean | Optional | Set to true to create a private repository, or false to create a public one. |
include_all_branches_from_template | boolean | Optional | Set to true to include files from all branches in the template repository, not just the default branch. Default: false. |
repository_description | string | Optional | A short description of the new GitHub repository to be created from the template. |
repository_owner | string | Optional | The organization or user that will own the new repository. Must be a valid organization member if creating under an organization. |
Requirements
Output
json— Response from the API endpoint 'repos/create-using-template'.GithubApi.CreateRepoRegistrationToken
Obtain a registration token for GitHub repository actions. Use this tool to get a token needed to configure a self-hosted runner for a GitHub repository. The token expires after one hour and requires authentication with a `repo`-scoped token.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. Provide the GitHub username or organization name. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/create-registration-token-for-repo'.GithubApi.CreateRepositoryAutolink
Create an autolink reference in a GitHub repository. Use this tool to create an autolink reference in a GitHub repository, provided you have admin access. It's helpful for linking external resources or references directly from issues and pull requests.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
autolink_key_prefix | string | Required | The prefix that triggers link creation when found in issues, pull requests, or commits. |
repository_name | string | Required | The name of the repository. This is not case sensitive. |
repository_owner_account | string | Required | The account owner of the repository. The name is not case sensitive. |
url_template_for_autolink | string | Required | URL containing `<num>` for reference. It should match the characters based on `is_alphanumeric` value. |
match_alphanumeric_characters | boolean | Optional | Determines if the autolink reference matches alphanumeric characters. True includes A-Z, 0-9, '-', false matches only numeric characters. |
Requirements
Output
json— Response from the API endpoint 'repos/create-autolink'.GithubApi.CreateRepositoryTagProtection
Create tag protection for a GitHub repository. This tool creates a tag protection state for a repository on GitHub, available only to repository administrators.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
tag_protection_pattern | string | Required | An optional glob pattern for matching when enforcing tag protection. |
Requirements
Output
json— Response from the API endpoint 'repos/create-tag-protection'.GithubApi.CreateRunnerGroupForOrg
Create a self-hosted runner group for an organization. This tool creates a new self-hosted runner group for an organization on GitHub. Requires authentication with an access token having the `admin:org` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. It is not case sensitive. |
runner_group_name | string | Required | Name of the self-hosted runner group to be created. This should be a descriptive and distinct name within your organization. |
accessible_repository_ids | array<integer> | Optional | List of repository IDs that can access the runner group. |
allow_public_repositories | boolean | Optional | Set to true to allow the runner group to be used by public repositories. |
allowed_workflows | array<string> | Optional | List of workflows names the runner group is permitted to run. Considered only if 'restricted_to_workflows' is true. |
restrict_to_selected_workflows | boolean | Optional | Set to true to restrict the runner group to run only the workflows in the selected_workflows array. |
runner_group_visibility | string | Optional | Specify the visibility of the runner group: 'selected' for individual repositories, 'all' for all repositories, or 'private' for private repositories only. |
runner_ids_to_add | array<integer> | Optional | List of runner IDs to include in the newly created runner group for the organization. |
Requirements
Output
json— Response from the API endpoint 'actions/create-self-hosted-runner-group-for-org'.GithubApi.CreateSelfHostedRunnerGroup
Create a self-hosted runner group for an enterprise. Use this tool to create a new self-hosted runner group for an enterprise on GitHub. Requires authentication with an access token having the `manage_runners:enterprise` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_name_or_id | string | Required | The slug version of the enterprise name or the enterprise ID to identify the enterprise. |
runner_group_name | string | Required | Name of the runner group to be created. |
allow_public_repository_use | boolean | Optional | Set to true to allow the runner group to be used by public repositories. |
organization_ids_for_access | array<integer> | Optional | List of IDs for organizations allowed to access the runner group. |
restrict_to_selected_workflows | boolean | Optional | Set to true to restrict the runner group to only the workflows in 'selected_workflows'. |
runner_group_visibility | string | Optional | Specifies the visibility of the runner group: 'selected' for individual organizations or 'all' for all organizations. |
runner_ids | array<integer> | Optional | List of runner IDs to be added to the new runner group. |
workflows_allowed_for_runner_group | array<string> | Optional | List of workflows the runner group can run. Ignored unless `restricted_to_workflows` is `true`. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/create-self-hosted-runner-group-for-enterprise'.GithubApi.CreateSshSigningKeyGithub
Create an SSH signing key for your GitHub account. This tool allows authenticated users to create an SSH signing key for their GitHub account. Authentication is required via Basic Authentication or OAuth with the `write:ssh_signing_key` scope. It should be used when you need to add SSH signing keys to your GitHub profile.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
public_ssh_key | string | Required | The public SSH key to add to your GitHub account. Check for existing SSH keys before adding. |
ssh_key_title | string | Optional | A descriptive name for the new SSH signing key. |
Requirements
Output
json— Response from the API endpoint 'users/create-ssh-signing-key-for-authenticated-user'.GithubApi.CreateTeamDiscussionComment
Create a new comment on a team discussion in an organization. Use this tool to add a comment to an existing team discussion in a GitHub organization. This action requires appropriate permissions and will generate notifications. Be mindful of rate limits when using this tool.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_body_text | string | Required | The text content of the comment to be added to the team discussion. |
discussion_number | integer | Required | The number that identifies the specific discussion within the team to which you want to add a comment. |
organization_name | string | Required | The name of the organization where the team discussion is located. This is not case sensitive. |
team_slug | string | Required | The slug identifier for the team name within the organization, used to specify which team's discussion to comment on. |
Requirements
Output
json— Response from the API endpoint 'teams/create-discussion-comment-in-org'.GithubApi.CreateTeamDiscussionGithub
Create a discussion post on a GitHub team's page. Use this tool to create a new discussion post on a specified team's page within an organization on GitHub. This requires appropriate OAuth access tokens with the `write:discussion` scope. Be aware that creating content too quickly can lead to rate limiting. This action will trigger notifications associated with the created discussion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
discussion_body_text | string | Required | The content of the discussion post. Provide detailed text for the discussion body. |
discussion_post_title | string | Required | The title for the discussion post on the team's page. |
organization_name | string | Required | The organization name, not case-sensitive, for which the team discussion will be created. |
team_slug | string | Required | The unique slug of the team name. This is required to specify which team's page the discussion will be posted on. |
create_private_post | boolean | Optional | Set to `true` to create a private post visible only to team members and maintainers, or `false` for a public post visible to all organization members. |
Requirements
Output
json— Response from the API endpoint 'teams/create-discussion-in-org'.GithubApi.DeclineRepoInvitation
Decline an invitation to join a GitHub repository. Use this tool to decline an invitation for an authenticated user to join a specific GitHub repository. It should be called when a user decides not to accept a repository invitation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invitation_id | integer | Required | The unique identifier of the GitHub repository invitation to decline. |
Requirements
Output
json— Response from the API endpoint 'repos/decline-invitation-for-authenticated-user'.GithubApi.DeleteAdminBranchProtection
Remove admin enforcement on a protected branch. This tool removes admin enforcement from a protected branch on GitHub. It requires admin or owner permissions for the repository and that branch protection is enabled. Use when you need to disable admin restrictions on a branch.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_name | string | Required | The exact name of the branch for which admin enforcement will be removed. Wildcards are not allowed. |
repository_name | string | Required | The name of the repository. It is not case sensitive and should not include any special characters. |
repository_owner | string | Required | The GitHub account owner of the repository. This is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-admin-branch-protection'.GithubApi.DeleteBranchProtection
Remove protection from a specified GitHub branch. Use this tool to remove protection from a specific branch in a GitHub repository. Applicable for public repositories under GitHub Free and in both public and private repositories under GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. Ideal for scenarios where branch updates are needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_name | string | Required | The name of the branch to remove protection from. Cannot contain wildcard characters. |
repository_name | string | Required | The name of the GitHub repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-branch-protection'.GithubApi.DeleteCodeScanningAnalysis
Delete a specific code scanning analysis from a GitHub repository. Use this tool to delete a specific code scanning analysis from a repository on GitHub. Ensure you have the correct access token with the required scope. This tool should be called when you want to remove analyses, particularly in cases where the analysis is marked as deletable. It provides URLs for further deletions, allowing you to manage and maintain analyses effectively.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
analysis_id | integer | Required | The ID of the analysis to delete, obtained from the `GET /repos/{owner}/{repo}/code-scanning/analyses` endpoint. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
allow_final_analysis_deletion | string | Optional | Set to 'true' to allow deletion if the analysis is the last in a set, preventing a 400 error. |
Requirements
Output
json— Response from the API endpoint 'code-scanning/delete-analysis'.GithubApi.DeleteCommitCommentReaction
Delete a reaction from a commit comment on GitHub. Use this tool to delete a specific reaction from a commit comment in a GitHub repository. This is useful when you need to manage or clean up reactions on comments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_unique_identifier | integer | Required | The unique identifier for the specific commit comment you want to target. |
reaction_unique_identifier | integer | Required | The unique identifier for the reaction to be deleted from a commit comment. |
repository_name | string | Required | The case-insensitive name of the repository. |
repository_owner | string | Required | The account owner of the repository. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'reactions/delete-for-commit-comment'.GithubApi.DeleteCustomRunnerLabel
Remove a custom label from a self-hosted runner in an organization. Removes a specified custom label from a self-hosted runner within an organization and returns the updated list of labels on the runner. Requires authentication with an access token having the `admin:org` scope. If the label is not found, a `404 Not Found` status is returned.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
custom_label_name | string | Required | The name of the custom label to remove from the self-hosted runner. |
organization_name | string | Required | The case-insensitive name of the organization. |
runner_identifier | integer | Required | Unique identifier of the self-hosted runner. Must be an integer. |
Requirements
Output
json— Response from the API endpoint 'actions/remove-custom-label-from-self-hosted-runner-for-org'.GithubApi.DeleteDeploymentBranchPolicy
Delete a deployment branch policy for a GitHub environment. Use this tool to delete a deployment branch policy in a specified environment on GitHub. Authentication with a token having `repo` scope is required, or GitHub Apps must have `administration:write` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_policy_identifier | integer | Required | The unique identifier of the branch policy to be deleted. |
environment_name | string | Required | The name of the GitHub environment for which the deployment branch policy will be deleted. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-deployment-branch-policy'.GithubApi.DeleteGistComment
Delete a comment from a GitHub gist. This tool deletes a specific comment from a GitHub gist when provided with the gist and comment IDs. It should be called when a user needs to remove an undesired or outdated comment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_identifier | integer | Required | The unique identifier of the comment to be deleted. |
gist_identifier | string | Required | The unique identifier for the specific GitHub gist from which the comment is to be deleted. |
Requirements
Output
json— Response from the API endpoint 'gists/delete-comment'.GithubApi.DeleteGithubActionsCache
Delete a GitHub Actions cache by ID for a repository. Use this tool to delete a specific GitHub Actions cache from a repository using its cache ID. Requires authentication with a token having `repo` scope. Useful for managing and cleaning up repository caches.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_actions_cache_id | integer | Required | The unique identifier for the GitHub Actions cache to be deleted. |
repository_name | string | Required | The name of the repository. Not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/delete-actions-cache-by-id'.GithubApi.DeleteGithubArtifact
Deletes a specified GitHub artifact. Use this tool to delete an artifact from a GitHub workflow run. Authentication with an access token having the `repo` scope is required, or a GitHub App must have `actions:write` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
artifact_unique_identifier | integer | Required | The unique identifier of the artifact to be deleted. Must be an integer value. |
repository_name | string | Required | The name of the GitHub repository where the artifact resides. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository, case-insensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/delete-artifact'.GithubApi.DeleteGithubCommitComment
Deletes a specific commit comment on GitHub. Use this tool to remove a comment from a commit on a GitHub repository by specifying the owner, repository, and comment ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_id | integer | Required | The unique identifier of the commit comment to be deleted. |
repository_name | string | Required | The name of the GitHub repository. This value is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-commit-comment'.GithubApi.DeleteGithubDeployKey
Delete a deploy key from a GitHub repository. Use this tool to delete an SSH deploy key from a specified GitHub repository. This is useful when you need to remove access provided by the key or when updating it (as keys are immutable on GitHub).
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
deploy_key_id | integer | Required | The unique identifier for the deploy key to be deleted from the repository. |
repository_name | string | Required | The name of the GitHub repository. This value is not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. Not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-deploy-key'.GithubApi.DeleteGithubDeployment
Delete a GitHub repository deployment. Deletes a deployment from a GitHub repository. If there's only one deployment, it can be deleted regardless of status. If multiple deployments exist, only inactive ones can be deleted. Ideal for users with `repo` or `repo_deployment` scopes managing deployments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
deployment_id | integer | Required | The unique identifier of the GitHub deployment to be deleted. This should be an integer. |
repository_name | string | Required | The name of the repository. This name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-deployment'.GithubApi.DeleteGithubEnterpriseUser
Delete a GitHub Enterprise user and their data. Use this tool to permanently delete a user on GitHub Enterprise, including all their data such as repositories and personal settings. Consider if suspending the user would be a better option before using this tool.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The handle for the GitHub user account to be deleted. Ensure it's the correct user, as this action is irreversible. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/delete-user'.GithubApi.DeleteGithubEnvironmentSecret
Delete a GitHub environment secret by name. This tool deletes a specific secret from an environment in a GitHub repository. It requires authentication with an access token having the `repo` scope or a GitHub App with `secrets` repository permission. Use this tool to securely manage and remove secrets from your environments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
environment_name | string | Required | Specify the name of the GitHub environment from which the secret will be deleted. |
repository_id | integer | Required | The unique identifier of the repository to delete the secret from. |
secret_name_to_delete | string | Required | The name of the secret to be deleted from the environment. |
Requirements
Output
json— Response from the API endpoint 'actions/delete-environment-secret'.GithubApi.DeleteGithubEnvVariable
Deletes an environment variable in a GitHub repository environment. This tool is used to delete an environment variable from a specific environment in a GitHub repository. Authentication with an access token having the `repo` scope is required. GitHub Apps need the `environment:write` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
environment_name | string | Required | The name of the environment from which the variable will be deleted. |
repository_id | integer | Required | The unique identifier of the GitHub repository where the environment variable will be deleted. |
variable_name | string | Required | The name of the environment variable to delete. |
Requirements
Output
json— Response from the API endpoint 'actions/delete-environment-variable'.GithubApi.DeleteGithubFile
Delete a file from a GitHub repository. This tool deletes a specified file from a GitHub repository. It should be called when you need to remove a file, ensuring that either committer or author details such as name and email are provided. This action cannot be done concurrently with file creation or updates.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
commit_message | string | Required | The commit message explaining why the file is being deleted. This information is mandatory. |
file_path | string | Required | The file path in the repository to be deleted. This path is case-sensitive. |
file_sha_to_delete | string | Required | The SHA of the file to be deleted. This is required to identify the specific file version in the repository. |
repository_name | string | Required | The name of the GitHub repository from which the file will be deleted. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository in a case-insensitive format. |
author_email | string | Optional | Email of the author or committer for the commit. Required if using author or committer details. |
author_name | string | Optional | The name of the author or committer of the commit. Required if 'author' is used. |
branch_name | string | Optional | The name of the branch from which to delete the file. Defaults to the repository's default branch (usually 'master'). |
committer_email | string | Optional | The email of the committer for the commit. This is required for deleting a file. |
committer_name | string | Optional | The name of the committer or author of the commit for deleting the file. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-file'.GithubApi.DeleteGithubGist
Delete a GitHub gist by its ID. Use this tool to delete a specific GitHub gist by providing its gist ID. Useful for managing personal gists on GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gist_identifier | string | Required | The unique identifier for the GitHub gist to be deleted. |
Requirements
Output
json— Response from the API endpoint 'gists/delete'.GithubApi.DeleteGithubIssueComment
Delete a specific comment from a GitHub issue. Use this tool to delete a specific comment from an issue in a GitHub repository. Specify the comment ID, along with the owner and repository names, to remove the comment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issue_comment_id | integer | Required | The unique identifier of the comment to be deleted. |
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is not case sensitive. Provide the username or organization name. |
Requirements
Output
json— Response from the API endpoint 'issues/delete-comment'.GithubApi.DeleteGithubIssueCommentReaction
Deletes a reaction from a GitHub issue comment. Use this tool to remove a specific reaction from an issue comment on GitHub. Provide the necessary repository and comment identifiers to successfully delete the reaction.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issue_comment_id | integer | Required | The unique identifier of the issue comment from which the reaction will be deleted. |
reaction_identifier | integer | Required | The unique identifier of the reaction to be deleted from the issue comment. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'reactions/delete-for-issue-comment'.GithubApi.DeleteGithubIssueReaction
Deletes a reaction from a GitHub issue. Use this tool to delete a specific reaction on an issue in a GitHub repository. This is useful for managing feedback and maintaining issues without unnecessary reactions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issue_number | integer | Required | The number identifying the issue in the repository. |
reaction_identifier | integer | Required | The unique identifier of the reaction to be deleted from a GitHub issue. |
repository_name | string | Required | The name of the GitHub repository. This value is not case sensitive. It identifies which repository the issue belongs to. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'reactions/delete-for-issue'.GithubApi.DeleteGithubLabel
Delete a label from a GitHub repository. Use this tool to delete a specific label from a GitHub repository. It should be called when you need to remove a label identified by its name from a particular repository, specified by the owner and repository name.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
label_name | string | Required | The name of the label to delete from the repository. It should match the label exactly. |
repository_name | string | Required | The name of the GitHub repository from which to delete the label. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. Not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'issues/delete-label'.GithubApi.DeleteGithubMilestone
Delete a milestone from a GitHub repository. Use this tool to delete a specific milestone from a GitHub repository by providing the repository owner, name, and milestone number.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
milestone_identifier | integer | Required | The unique number that identifies the milestone to be deleted. |
repository_name | string | Required | The repository name on GitHub, not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. This should match the GitHub username or organization name. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'issues/delete-milestone'.GithubApi.DeleteGithubOrgMigrationArchive
Delete a previous GitHub organization migration archive. Use this tool to delete a migration archive for a GitHub organization. Migration archives are automatically deleted after seven days, but you might need to delete them sooner for organizational purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
migration_identifier | integer | Required | The unique identifier of the migration archive to delete. |
organization_name | string | Required | The GitHub organization name. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'migrations/delete-archive-for-org'.GithubApi.DeleteGithubOrgSecret
Deletes a secret from a GitHub organization. Use this tool to delete a specific secret from a GitHub organization by its name. Requires authentication with an access token with `admin:org` scope or a GitHub App with `secrets` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name, not case sensitive. |
secret_name | string | Required | The name of the secret to be deleted from the GitHub organization. Ensure the name is correct and case insensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/delete-org-secret'.GithubApi.DeleteGithubOrgVariable
Delete an organization's variable on GitHub. Deletes a specified variable from an organization on GitHub. Requires authentication with an access token with the `admin:org` scope, or GitHub App with `organization_actions_variables:write` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. This is not case sensitive. |
variable_name | string | Required | The name of the organization variable to delete. It should be a string matching the variable's identifier. |
Requirements
Output
json— Response from the API endpoint 'actions/delete-org-variable'.GithubApi.DeleteGithubPagesSite
Delete a GitHub Pages site from a repository. Use this tool to delete a GitHub Pages site from a specified repository. Requires repository admin or maintainer permissions with appropriate GitHub token scopes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository from which to delete the GitHub Pages site. This name is not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. Case insensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-pages-site'.GithubApi.DeleteGithubPersonalAccessToken
Delete a GitHub personal access token. Deletes a specified GitHub personal access token. Use when you need to remove a token. If the token is in use, such as being accessed by the token itself, a '403 - Forbidden' status will be returned.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_token_id | integer | Required | The unique identifier of the GitHub personal access token to delete. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/delete-personal-access-token'.GithubApi.DeleteGithubProjectColumn
Deletes a specific project column on GitHub. This tool deletes a specified column from a project on GitHub. It should be called when a user wants to remove a column from their project setup.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_column_id | integer | Required | The unique integer identifier of the GitHub project column to be deleted. |
Requirements
Output
json— Response from the API endpoint 'projects/delete-column'.GithubApi.DeleteGithubPublicKey
Delete a public key from GitHub Enterprise. Use this tool to delete a specific public key from a GitHub Enterprise account. This should be called when an obsolete or compromised key needs to be removed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
public_key_identifier | string | Required | The unique identifier of the public key to delete from GitHub Enterprise. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/delete-public-key'.GithubApi.DeleteGithubPullRequestPendingReview
Delete a pending review for a GitHub pull request. Use this tool to delete a pending review from a specified pull request on GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pull_request_number | integer | Required | The number identifying the specific pull request to delete the pending review from. |
repository_name | string | Required | The name of the GitHub repository. This is not case sensitive. |
repository_owner_name | string | Required | The GitHub account owner of the repository. This is not case sensitive. |
unique_review_identifier | integer | Required | The unique identifier of the pending GitHub review to be deleted. |
Requirements
Output
json— Response from the API endpoint 'pulls/delete-pending-review'.GithubApi.DeleteGithubRelease
Delete a GitHub release with push access permissions. Call this tool to delete a release from a GitHub repository if you have push access. It removes the specified release identified by its release ID in the given repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
release_identifier | integer | Required | The unique identifier of the GitHub release to delete. This is an integer value. |
repository_name | string | Required | The name of the repository. It's not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository, not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-release'.GithubApi.DeleteGithubRepoAutolink
Delete an autolink reference from a GitHub repository. Use this tool to delete a specific autolink reference from a GitHub repository by providing the repository owner, repository name, and autolink ID. This action is restricted to repository administrators.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
autolink_identifier | integer | Required | The unique integer identifier of the autolink to be deleted from the repository. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-autolink'.GithubApi.DeleteGithubRepoSecret
Deletes a secret from a GitHub repository. Use this tool to remove a specific secret from a GitHub repository by providing the secret's name. Authentication with a `repo`-scoped access token is required. GitHub Apps need the `secrets` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
secret_name | string | Required | The specific name of the secret to delete from the repository. |
Requirements
Output
json— Response from the API endpoint 'actions/delete-repo-secret'.GithubApi.DeleteGithubRepository
Deletes a specified GitHub repository. Use this tool to delete a GitHub repository when you have admin access and the necessary permissions. Ensure that OAuth is used with the 'delete_repo' scope if required. Be aware of organization-level restrictions that might prohibit deletion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository you want to delete. This is not case sensitive. |
repository_owner_name | string | Required | The account owner of the repository; not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/delete'.GithubApi.DeleteGithubRepoVariable
Delete a repository variable on GitHub using its name. This tool deletes a specified variable from a GitHub repository. It requires authentication with an access token that has the 'repo' scope. Suitable for use in managing repository configurations or cleanup tasks.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository to delete the variable from. It is not case-sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
variable_name | string | Required | The name of the variable to delete from the repository. It should match exactly as stored. |
Requirements
Output
json— Response from the API endpoint 'actions/delete-repo-variable'.GithubApi.DeleteGithubRequiredWorkflow
Deletes a required workflow in a GitHub organization. Use this tool to delete a specific required workflow configured in a GitHub organization. Requires authentication with an `admin:org` scope access token.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name. This is case insensitive. |
workflow_identifier | integer | Required | The unique identifier of the required workflow to be deleted. |
Requirements
Output
json— Response from the API endpoint 'actions/delete-required-workflow'.GithubApi.DeleteGithubReviewComment
Delete a review comment on a GitHub pull request. Use this tool to delete a specific review comment on a GitHub pull request. It should be called when you need to remove an unnecessary or incorrect comment. Requires the repository owner, repository name, and the comment ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_id | integer | Required | The unique identifier for the review comment to delete. This must be an integer and corresponds to the specific comment you intend to remove from the GitHub pull request. |
repository_name | string | Required | The name of the repository, case-insensitive. |
repository_owner | string | Required | The GitHub account owner of the repository, not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'pulls/delete-review-comment'.GithubApi.DeleteGithubSshSigningKey
Delete an SSH signing key from your GitHub account. Call this tool to remove an SSH signing key from the authenticated user's GitHub account. Authentication is required via Basic Authentication or OAuth with the `admin:ssh_signing_key` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ssh_signing_key_identifier | integer | Required | The unique identifier of the SSH signing key to delete. It must be an integer. |
Requirements
Output
json— Response from the API endpoint 'users/delete-ssh-signing-key-for-authenticated-user'.GithubApi.DeleteGithubTeamDiscussionReaction
Delete a reaction from a GitHub team discussion. Use this tool to delete a reaction from a specific team discussion on GitHub. Requires appropriate OAuth scope: `write:discussion`.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
discussion_number | integer | Required | The number that identifies the GitHub team discussion to delete a reaction from. Must be an integer. |
organization_name | string | Required | The organization name. This value is not case sensitive and identifies the GitHub organization. |
reaction_unique_identifier | integer | Required | The unique identifier for the specific reaction to be deleted from the discussion. |
team_slug | string | Required | The slug (URL-friendly version) of the team name in GitHub, used to identify a team within an organization. |
Requirements
Output
json— Response from the API endpoint 'reactions/delete-for-team-discussion'.GithubApi.DeleteGithubWorkflowRun
Delete a specific GitHub workflow run. Use this tool to delete a specific workflow run in a GitHub repository. Requires write access to the repository. For private repositories, an access token with `repo` scope is necessary. GitHub Apps need `actions:write` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. The name is not case sensitive. |
workflow_run_id | integer | Required | The unique identifier of the GitHub workflow run to be deleted. This should be an integer value. |
Requirements
Output
json— Response from the API endpoint 'actions/delete-workflow-run'.GithubApi.DeleteGithubWorkflowRunLogs
Deletes all logs for a specified workflow run on GitHub. Use this tool to delete all logs associated with a specific workflow run in a GitHub repository. Authentication with a token having `repo` scope is necessary, and GitHub Apps need `actions:write` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case-sensitive. |
repository_owner_name | string | Required | The account owner of the repository. This name is not case sensitive. |
workflow_run_id | integer | Required | The unique identifier of the workflow run to delete logs for. |
Requirements
Output
json— Response from the API endpoint 'actions/delete-workflow-run-logs'.GithubApi.DeleteGitReference
Deletes a specified Git reference in a repository. Use this tool to delete a specific Git reference from a repository on GitHub. It is useful for managing and cleaning up branches, tags, or other references in a repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
git_reference_to_delete | string | Required | The Git reference to delete, such as a branch or tag name. This should match the exact format used in the repository. |
repository_name | string | Required | The name of the repository to delete the reference from. It is not case sensitive. |
repository_owner | string | Required | The GitHub username of the repository owner. This is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'git/delete-ref'.GithubApi.DeleteGlobalWebhook
Delete a global webhook in GitHub Enterprise. Use this tool to delete a global webhook in a GitHub Enterprise setup. It should be called when there's a need to remove a webhook that is no longer required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_id | integer | Required | The unique identifier of the global webhook to be deleted. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/delete-global-webhook'.GithubApi.DeleteImpersonationOauthToken
Deletes an impersonation OAuth token for a user in GitHub Enterprise Admin. Use this tool to remove an OAuth token for a specific user's impersonation in GitHub Enterprise Admin. This is useful for security and access management in organization environments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub user account handle for which the impersonation OAuth token will be deleted. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/delete-impersonation-o-auth-token'.GithubApi.DeleteOrgWebhook
Delete a webhook from a GitHub organization. Use this tool to delete a specific webhook from a GitHub organization by specifying the organization and webhook ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is case insensitive. |
webhook_identifier | integer | Required | The unique identifier of the webhook to be deleted. It should be provided as an integer. |
Requirements
Output
json— Response from the API endpoint 'orgs/delete-webhook'.GithubApi.DeletePreReceiveEnvironment
Delete a specified pre-receive environment in GitHub Enterprise. This tool deletes a specified pre-receive environment by its ID in GitHub Enterprise. If the environment cannot be deleted, a `422 Unprocessable Entity` response is returned with potential error messages indicating that the default environment cannot be modified or deleted, hooks are present, or a download is in progress.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pre_receive_environment_identifier | integer | Required | The unique integer identifier of the pre-receive environment to be deleted. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/delete-pre-receive-environment'.GithubApi.DeletePreReceiveHook
Delete a pre-receive hook from GitHub Enterprise Admin. This tool deletes a pre-receive hook from a GitHub Enterprise Server instance. Use it when you need to remove a specific pre-receive hook, identified by its ID, from the administrative settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pre_receive_hook_identifier | integer | Required | The unique identifier for the pre-receive hook to delete. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/delete-pre-receive-hook'.GithubApi.DeleteProjectBoard
Deletes a specified project board on GitHub. Use this tool to delete a GitHub project board with a given project ID. It is useful for managing and cleaning up project boards. If projects are disabled, a `404 Not Found` status will be returned.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_identifier | integer | Required | The unique identifier of the GitHub project board to be deleted. |
Requirements
Output
json— Response from the API endpoint 'projects/delete'.GithubApi.DeleteProjectCard
Delete a project card from GitHub projects. Call this tool when you need to delete a specific project card from a GitHub project board by providing the card ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
card_id | integer | Required | The unique identifier of the project card to delete. |
Requirements
Output
json— Response from the API endpoint 'projects/delete-card'.GithubApi.DeletePullRequestCommentReaction
Delete a reaction from a pull request comment. Use this tool to delete a specific reaction from a pull request review comment on GitHub. Ideal for managing or retracting reactions erroneously added.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_unique_id | integer | Required | The unique identifier of the pull request comment to delete a reaction from. |
reaction_unique_identifier | integer | Required | The unique identifier for the reaction to delete from the pull request comment. |
repository_name | string | Required | The name of the GitHub repository. It is case insensitive. |
repository_owner | string | Required | The account owner of the repository. This is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'reactions/delete-for-pull-request-comment'.GithubApi.DeleteReleaseAsset
Deletes a specific release asset on GitHub. Use this tool to delete a specified release asset from a GitHub repository. Provide the owner, repository name, and asset ID to perform the deletion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
asset_identifier | integer | Required | The unique identifier for the GitHub release asset to be deleted. |
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-release-asset'.GithubApi.DeleteReleaseReaction
Delete a reaction from a GitHub release. Use this tool to delete a specific reaction from a GitHub release by providing the repository owner, repo, release ID, and reaction ID. It should be called when you need to manage reactions on releases.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
reaction_identifier | integer | Required | The unique identifier for the reaction to be deleted from a release. |
release_id | integer | Required | The unique identifier of the GitHub release. Use this to specify which release's reaction you wish to delete. |
repository_name | string | Required | The name of the repository. This field is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'reactions/delete-for-release'.GithubApi.DeleteRepoEnvironment
Deletes a specific environment in a GitHub repository. Use this tool to delete an environment from a repository on GitHub. Authentication with a valid access token is required. Suitable when you need to remove obsolete or unused environments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
environment_name | string | Required | The name of the GitHub repository environment to delete. This field is case insensitive. |
repository_name | string | Required | The name of the GitHub repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This value is not case sensitive. Specify the GitHub username or organization handle that owns the repository. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-an-environment'.GithubApi.DeleteRepoFromOrgSecret
Remove a repository from a GitHub organization secret. Use this tool to remove a specific repository from an organization secret in GitHub. This is applicable when the repository access visibility is set to 'selected'. Ensure authentication with an access token that has the 'admin:org' scope. GitHub Apps require 'dependabot_secrets' permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
repository_id | integer | Required | The unique identifier of the repository to be removed from the organization secret. |
secret_name | string | Required | The name of the GitHub organization secret to remove the repository from. |
Requirements
Output
json— Response from the API endpoint 'dependabot/remove-selected-repo-from-org-secret'.GithubApi.DeleteRepoInvitation
Delete a repository invitation on GitHub. Use this tool to delete a specific invitation to collaborate on a GitHub repository. It requires the owner, repository name, and invitation ID to perform the deletion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invitation_id | integer | Required | The unique identifier for the repository invitation to be deleted. It must be an integer. |
repository_name | string | Required | The name of the GitHub repository to delete the invitation from. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This value is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-invitation'.GithubApi.DeleteRepositoryTagProtection
Deletes a tag protection from a GitHub repository. This tool is used to delete a tag protection state within a specified GitHub repository. It is only accessible to repository administrators.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This field is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
tag_protection_identifier | integer | Required | The unique identifier for the tag protection to be deleted. Required for identifying which tag protection state to remove. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-tag-protection'.GithubApi.DeleteRepoWebhook
Delete a webhook from a GitHub repository. Use this tool to remove a specific webhook from a GitHub repository by providing the repository owner, name, and hook ID. It is helpful for managing webhooks that are no longer needed or require updating.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. This input is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This name is not case sensitive. Provide the GitHub username or organization name. |
webhook_identifier | integer | Required | The unique integer identifier of the webhook to be deleted. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-webhook'.GithubApi.DeleteRunnerGroupFromOrganization
Delete a self-hosted runner group from an organization. Use this tool to delete a self-hosted runner group from a specified organization on GitHub. Requires authentication with an access token with `admin:org` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization on GitHub. This is not case-sensitive. |
runner_group_id | integer | Required | The unique integer ID of the self-hosted runner group to delete. |
Requirements
Output
json— Response from the API endpoint 'actions/delete-self-hosted-runner-group-from-org'.GithubApi.DeleteScimGroupFromEnterprise
Delete a SCIM group from an enterprise. Use this tool to delete a SCIM group from an enterprise using the GitHub API. Ideal for managing user groups within enterprise accounts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
scim_group_id | string | Required | The unique identifier of the SCIM group to delete from an enterprise. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/delete-scim-group-from-enterprise'.GithubApi.DeleteSelfHostedRunnerGroup
Delete a self-hosted runner group for an enterprise. Use this tool to delete a self-hosted runner group from an enterprise. It requires authentication with an access token that has the `manage_runners:enterprise` scope. Call this tool when you need to manage enterprise runner groups on GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug version of the enterprise name or the enterprise ID to identify which enterprise the runner group belongs to. |
runner_group_id | integer | Required | Unique identifier for the self-hosted runner group to be deleted. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/delete-self-hosted-runner-group-from-enterprise'.GithubApi.DeleteTeamDiscussion
Delete a discussion from a team's page on GitHub. This tool deletes a specified discussion from a team's page within an organization on GitHub. It requires an OAuth access token with `write:discussion` scope. Use this tool when you need to remove a discussion from a team's page.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
discussion_number | integer | Required | The unique number identifying the discussion to be deleted. |
organization_name | string | Required | The organization name on GitHub. It is not case sensitive. |
team_slug | string | Required | The slug identifier of the team name on GitHub. This is required to specify which team's discussion is to be deleted. |
Requirements
Output
json— Response from the API endpoint 'teams/delete-discussion-in-org'.GithubApi.DeleteTeamDiscussionComment
Deletes a comment on a team discussion in an organization. Use this tool to delete a specific comment from a team discussion within a GitHub organization. Ideal for managing discussions and removing unwanted comments. Requires `write:discussion` OAuth scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_identifier | integer | Required | The unique number identifying the comment to be deleted. |
discussion_identifier | integer | Required | The unique number identifying the discussion for the comment to be deleted. |
organization_name | string | Required | The name of the organization. It is not case sensitive. |
team_slug | string | Required | The slug of the team name in the organization. Case insensitive. |
Requirements
Output
json— Response from the API endpoint 'teams/delete-discussion-comment-in-org'.GithubApi.DeleteTeamDiscussionCommentReaction
Delete a reaction from a team discussion comment on GitHub. Use this tool to delete a reaction from a specific comment in a team discussion on GitHub. You need appropriate OAuth access tokens with `write:discussion` scope. Specify team, organization, discussion, comment, and reaction details to execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_identifier | integer | Required | The number that identifies the comment in the team discussion. |
discussion_identifier | integer | Required | The number identifying the specific discussion in the team. |
organization_name | string | Required | The organization name on GitHub. It is not case sensitive. |
reaction_id | integer | Required | The unique identifier of the reaction to be deleted. This should be an integer value. |
team_slug | string | Required | The slug of the team name, used to identify the team in the organization. |
Requirements
Output
json— Response from the API endpoint 'reactions/delete-for-team-discussion-comment'.GithubApi.DeleteTeamInOrg
Delete a team in a GitHub organization. Use this tool to delete a team within a GitHub organization. The action requires the user to be an organization owner or team maintainer. Deleting a parent team will also delete its child teams.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The case-insensitive name of the GitHub organization containing the team to be deleted. |
team_slug | string | Required | The unique slug identifier of the team within the organization to be deleted. |
Requirements
Output
json— Response from the API endpoint 'teams/delete-in-org'.GithubApi.DeleteUserEmail
Delete an email for the authenticated GitHub user. Use this tool to delete an email address associated with the authenticated user's GitHub account. This action requires user authentication and appropriate permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'users/delete-email-for-authenticated-user'.GithubApi.DeleteUserFromEnterprise
Permanently delete a SCIM user from an enterprise account. This tool permanently deletes a SCIM user from a GitHub enterprise account. It removes all user data, obfuscates personal information, and deletes associated credentials. This action is irreversible and should be used with caution.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
scim_user_identifier | string | Required | The unique identifier of the SCIM user to be permanently deleted from the enterprise. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/delete-user-from-enterprise'.GithubApi.DemoteGithubSiteAdministrator
Demote a GitHub site administrator. This tool is used to demote a GitHub site administrator account. It cannot be used to demote your own account. Call this tool when you need to reduce the administrative privileges of a user on GitHub Enterprise.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub user account handle to be demoted. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/demote-site-administrator'.GithubApi.DisableCommitSignatureProtection
Disable required signed commits on a branch. This tool disables required signed commits on a specified branch in a GitHub repository. It requires admin or owner permissions and is applicable when branch protection is enabled.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_name | string | Required | The name of the branch where you want to disable commit signature protection. Wildcards are not allowed. |
repository_name | string | Required | The name of the GitHub repository, case insensitive. |
repository_owner | string | Required | The account owner of the repository. Not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/delete-commit-signature-protection'.GithubApi.DisableGithubActionsRepo
Disable GitHub Actions for a specific repo in an organization. Use this tool to remove a repository from the selected list of repositories enabled for GitHub Actions within an organization. This is applicable when the organization's repository permission policy is set to 'selected'. Authentication with an access token having 'admin:org' scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
repository_unique_id | integer | Required | The unique integer identifier of the repository to be disabled for GitHub Actions. |
Requirements
Output
json— Response from the API endpoint 'actions/disable-selected-repository-github-actions-organization'.GithubApi.DisableLfsForGithubRepo
Disable Git LFS for a specified GitHub repository. Use this tool to disable Git Large File Storage (LFS) for a specific GitHub repository. Requires admin access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository to disable LFS for. This value is not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. This is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/disable-lfs-for-repo'.GithubApi.DisableOrgGithubActions
Disable GitHub Actions for an organization in an enterprise. This tool removes a specified organization from the list enabled for GitHub Actions within an enterprise. It requires the enterprise permission policy for `enabled_organizations` to be set to `selected`, and an access token with `admin:enterprise` scope is needed for authentication. Use this when you need to disable GitHub Actions for an organization in your enterprise.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug version of the enterprise name or the enterprise ID to identify it for the operation. |
organization_unique_identifier | integer | Required | The unique identifier of the organization to disable GitHub Actions for. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/disable-selected-organization-github-actions-enterprise'.GithubApi.DismissPullRequestReview
Dismiss a pull request review on GitHub. This tool allows you to dismiss a review on a pull request within a GitHub repository. It requires repository administrator privileges or permissions to dismiss reviews on protected branches.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
dismissal_message | string | Required | The message explaining the reason for dismissing the pull request review. |
pull_request_number | integer | Required | The unique number identifying the pull request to dismiss the review for. |
repository_name | string | Required | The name of the GitHub repository. The name is not case sensitive. |
repository_owner | string | Required | The username of the repository owner. This is not case sensitive and refers to the account that owns the repository. |
review_identifier | integer | Required | The unique identifier for the pull request review to be dismissed. |
dismissal_event | string | Optional | This is a required event type for dismissing a pull request review. Use 'DISMISS' to perform the dismissal action. |
Requirements
Output
json— Response from the API endpoint 'pulls/dismiss-review'.GithubApi.DownloadGithubMigrationArchive
Fetch the URL to download a GitHub migration archive. Use this tool to obtain the URL for downloading a GitHub migration archive as a `tar.gz` file. It includes various repository data and attachments, useful for backing up or migrating GitHub data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
migration_unique_id | integer | Required | The unique identifier for the GitHub migration. This ID is required to fetch the migration archive URL. |
Requirements
Output
json— Response from the API endpoint 'migrations/get-archive-for-authenticated-user'.GithubApi.DownloadGithubReleaseAsset
Download binary content of a GitHub release asset. This tool downloads the binary content of a specific asset from a GitHub release. It should be called when you need to obtain the asset file from a GitHub repository release. The endpoint returns binary data, and clients must handle 200 or 302 HTTP responses.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
asset_unique_identifier | integer | Required | The unique identifier of the asset to download from a GitHub release. Must be an integer. |
repository_name | string | Required | The name of the GitHub repository, not case sensitive. |
repository_owner | string | Required | The account owner of the repository. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-release-asset'.GithubApi.DownloadGithubRepoTarball
Retrieve a URL to download a GitHub repository tarball. This tool provides a redirect URL for downloading a tar archive of a GitHub repository. If the `:ref` is omitted, it defaults to the repository’s main branch. Note that for private repositories, the link expires after five minutes. Ensure your HTTP framework can follow redirects, or use the 'Location' header for a second GET request.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_or_commit_ref | string | Required | Specify the branch name or commit SHA for the repository. If omitted, the default branch is used. |
repository_name | string | Required | The name of the GitHub repository. This input is not case sensitive. Specify the repository whose tarball you want to download. |
repository_owner | string | Required | The GitHub account owner of the repository. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/download-tarball-archive'.GithubApi.DownloadGithubRepoZip
Retrieve a URL to download a GitHub repository as a zip file. This tool retrieves a redirect URL for downloading a zip archive of a specified GitHub repository. If no branch is specified, the repository's default branch will be used. Note that for private repositories, the links expire after five minutes, and empty repositories will return a 404 error.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. Not case sensitive. |
repository_reference | string | Required | Specify the branch, tag, or commit SHA to retrieve the zip archive from. Defaults to the repository's default branch if omitted. |
Requirements
Output
json— Response from the API endpoint 'repos/download-zipball-archive'.GithubApi.DownloadGithubWorkflowJobLogs
Retrieve a URL to download GitHub workflow job logs. Use this tool to get a link for downloading logs of a specific GitHub workflow job. The link is a plain text file URL and expires in 1 minute. Users must have read access to the repository. For private repositories, an access token with 'repo' scope is required, or 'actions:read' permission for GitHub Apps.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository (case insensitive). |
repository_owner | string | Required | The account owner of the GitHub repository. Provide the name in a non-case sensitive format. |
workflow_job_id | integer | Required | The unique identifier of the GitHub workflow job to download logs for. |
Requirements
Output
json— Response from the API endpoint 'actions/download-job-logs-for-workflow-run'.GithubApi.DownloadWorkflowRunLogs
Get a redirect URL to download workflow run log files. This tool retrieves a URL for downloading an archive of log files from a specific GitHub repository workflow run. The link expires after one minute. Use this tool when you need access to the logs for analysis or debugging, ensuring you have the necessary read access or appropriate access token if the repository is private.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. This field is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is case-insensitive. |
workflow_run_id | integer | Required | The unique identifier of the workflow run to download logs for. |
Requirements
Output
json— Response from the API endpoint 'actions/download-workflow-run-logs'.GithubApi.EditGithubReleaseAsset
Edit a GitHub release asset with push access. This tool allows users with push access to a GitHub repository to edit details of a release asset, such as its name or description. It should be called when there is a need to update release asset information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
release_asset_identifier | integer | Required | The unique integer identifier of the release asset to update. |
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
alternate_asset_description | string | Optional | Provide an alternate short description of the release asset, used instead of the filename. |
file_name_of_asset | string | Optional | The file name of the asset. This is used to uniquely identify the asset file for the release. |
release_asset_state | string | Optional | Specifies the state of the release asset. Possible values might include 'uploaded', 'deleted', etc. (API documentation does not explicitly define options). |
Requirements
Output
json— Response from the API endpoint 'repos/update-release-asset'.GithubApi.EditGithubReviewComment
Edit a review comment on a GitHub pull request.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_identifier | integer | Required | The unique identifier for the GitHub review comment to be edited. |
comment_text | string | Required | The content of the updated review comment. |
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository, not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'pulls/update-review-comment'.GithubApi.EnableGithubActionsForOrg
Enable GitHub Actions for a selected organization in an enterprise. This tool adds an organization to the list enabled for GitHub Actions within an enterprise. The enterprise's permissions must allow 'selected' organizations. Requires an access token with 'admin:enterprise' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_slug_or_id | string | Required | The slug or ID of the enterprise to identify it for GitHub Actions enablement. Accepts slug version or enterprise ID. |
organization_id | integer | Required | The unique identifier for the organization to enable GitHub Actions. Must be an integer. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/enable-selected-organization-github-actions-enterprise'.GithubApi.EnableGithubActionsForRepo
Enable a repository for GitHub Actions in an organization. Adds a repository to the list of selected repositories enabled for GitHub Actions within an organization. Requires organization permission policy for `enabled_repositories` set to `selected`. Authentication with `admin:org` scope is necessary.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization to enable GitHub Actions for, not case sensitive. |
repository_unique_identifier | integer | Required | The unique identifier of the repository to enable for GitHub Actions. |
Requirements
Output
json— Response from the API endpoint 'actions/enable-selected-repository-github-actions-organization'.GithubApi.EnableGitLfs
Enables Git LFS for a specified repository. Use this tool to activate Git Large File Storage (LFS) for a given repository. The access token must have the `admin:enterprise` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/enable-lfs-for-repo'.GithubApi.FetchCommitInfo
Retrieve details and signature verification for a Git commit. Use this tool to fetch a Git commit object, including detailed information about the commit and its signature verification status. It's ideal for checking commit integrity and authenticity in a GitHub repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
commit_sha | string | Required | The SHA hash of the commit to retrieve details and verification status for. |
repository_name | string | Required | The name of the repository to query. This input is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'git/get-commit'.GithubApi.FetchDeploymentStatusGithub
Retrieve a deployment status from a GitHub repository. Used to view detailed information about a specific deployment status for a deployment in a GitHub repository. Suitable for users with pull access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
deployment_id | integer | Required | The unique identifier of the deployment to retrieve the status for. Must be an integer. |
deployment_status_id | integer | Required | The unique integer identifier for the deployment status in the GitHub repository. |
repository_name | string | Required | The name of the repository (case-insensitive). |
repository_owner | string | Required | The GitHub account owner of the repository. Not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-deployment-status'.GithubApi.FetchGithubActionsCachePolicy
Retrieve the cache usage policy for GitHub Actions in a repository. This tool retrieves the GitHub Actions cache usage policy for a specified repository. It requires authentication with an access token that has the `repo` scope. GitHub Apps need the `actions:read` permission to access this endpoint.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/get-actions-cache-usage-policy'.GithubApi.FetchGithubActionsPerms
Retrieve GitHub Actions permissions for a repository. Use this tool to get information on whether GitHub Actions is enabled for a repository and what actions are permitted. Requires authentication with a token with `repo` scope or a GitHub App with `administration` repository permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/get-github-actions-permissions-repository'.GithubApi.FetchGithubIssueEvent
Retrieve details of a specific GitHub issue event. Use this tool to fetch information about a specific event related to an issue in a GitHub repository. Provide the owner, repository, and event ID to get detailed event information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_id | integer | Required | The unique identifier for the GitHub issue event to retrieve details for. It must be an integer. |
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. Provide the GitHub username or organization name. |
Requirements
Output
json— Response from the API endpoint 'issues/get-event'.GithubApi.FetchGitignoreTemplate
Fetches the raw .gitignore template by name. Use this tool to retrieve the raw source of a specified .gitignore template from GitHub. It is useful when you need to include or reference specific ignore rules for different development environments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gitignore_template_name | string | Required | The name of the .gitignore template to fetch from GitHub. This is required to specify which template's raw content to retrieve. |
Requirements
Output
json— Response from the API endpoint 'gitignore/get-template'.GithubApi.FetchOpenRepoInvitations
List open repository invitations for the authenticated user. This tool retrieves all open repository invitations for the currently authenticated GitHub user. It's useful for checking pending repository collaborations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
page_number | integer | Optional | Specify the page number of results to retrieve for open repository invitations. |
results_per_page | integer | Optional | Specify the number of results to display per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-invitations-for-authenticated-user'.GithubApi.FetchOrgActionsCacheUsage
Fetches GitHub Actions cache usage for a specified organization. This tool retrieves the total cache usage of GitHub Actions for a specified organization. The data is updated every 5 minutes. Authentication with the 'read:org' scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. It should not be case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/get-actions-cache-usage-for-org'.GithubApi.FetchOrgMigrationArchiveUrl
Fetches the URL to download an organization's migration archive. Use this tool to obtain the URL for downloading an archive of a migration for a specific organization on GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
migration_identifier | integer | Required | The unique identifier for the specific migration. This should be an integer value. |
organization_name | string | Required | The name of the organization. This value is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'migrations/download-archive-for-org'.GithubApi.FetchRepoReadme
Retrieve the README from a specific repository directory. This tool retrieves the README file from a specified directory within a GitHub repository. It supports retrieving the content in various formats, including raw text and rendered HTML.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
readme_directory_path | string | Required | The path within the repository to search for the README file. Default is repository root if not specified. |
repository_name | string | Required | The name of the repository. This input is case insensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. Case insensitive. |
commit_branch_or_tag_name | string | Optional | The name of the commit, branch, or tag. Defaults to the repository's default branch (usually 'master'). |
Requirements
Output
json— Response from the API endpoint 'repos/get-readme-in-directory'.GithubApi.FindGithubLabels
Search for labels in a GitHub repository by keywords. Use this tool to find labels in a specific GitHub repository whose names or descriptions match provided search keywords. Ideal for locating labels like 'bug' or 'enhancement' quickly. Returns up to 100 results per page, with optional text match metadata for enhanced search insights.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_id | integer | Required | The ID of the repository where labels will be searched. |
search_keywords | string | Required | Keywords to search for in label names or descriptions. Excludes qualifiers. |
result_page_number | integer | Optional | Specifies the page number of the search results to fetch. Useful for pagination. |
results_per_page | integer | Optional | The number of label results to display per page, with a maximum of 100. |
sort_labels_by | string | Optional | Specifies how to sort the query results by the timestamp fields 'created' or 'updated'. Defaults to 'best match'. |
sort_order | string | Optional | Determines if the highest ('desc') or lowest ('asc') matches appear first. Requires 'sort' to be set. |
Requirements
Output
json— Response from the API endpoint 'search/labels'.GithubApi.FollowGithubUser
Follow a specified user on GitHub. This tool allows you to follow a GitHub user. Ensure you are authenticated with the necessary permissions ('user:follow' scope) to execute this action. Useful when you want to keep up with updates from specific users on GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub username of the account you want to follow. Ensure it is a valid GitHub user handle. |
Requirements
Output
json— Response from the API endpoint 'users/follow'.GithubApi.ForkGist
Fork a GitHub gist to your account. Use this tool to create a fork of an existing GitHub gist into your account. This can be useful for modifying or duplicating code snippets while keeping track of the original version.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gist_unique_identifier | string | Required | The unique identifier of the GitHub gist to be forked. This is required to specify which gist to duplicate. |
Requirements
Output
json— Response from the API endpoint 'gists/fork'.GithubApi.GenerateGithubReleaseNotes
Generate release notes for a GitHub repository. This tool generates a markdown-formatted name and body for release notes, detailing changes since the last release and contributor information. It's useful when preparing to create a new release but does not save the notes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
release_tag_name | string | Required | Specify the tag name for the release. Can be an existing tag or a new one. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. This is not case sensitive. |
previous_tag_name | string | Optional | The name of the previous tag to use as the starting point for the release notes. It specifies the range of changes for this release. |
release_configuration_file_path | string | Optional | Path to the configuration file in the repository for generating release notes. Defaults to '.github/release.yml' or '.github/release.yaml' if not specified. |
target_commit | string | Optional | The commitish value that will target the release's tag. Required if tag_name doesn't reference an existing tag. Otherwise, it's ignored. |
Requirements
Output
json— Response from the API endpoint 'repos/generate-release-notes'.GithubApi.GenerateGithubRunnerRemoveToken
Generate a token to remove a GitHub self-hosted runner. This tool generates a token needed to remove a self-hosted runner from a GitHub repository. The token is valid for one hour. Ensure authentication using an access token with the 'repo' scope before calling this tool.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This should match exactly as it appears on GitHub but is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/create-remove-token-for-repo'.GithubApi.GetAdminBranchProtectionStatus
Get admin branch protection status on GitHub. Use this tool to fetch the admin branch protection status for a specific branch within a GitHub repository. This is applicable to both public and private repositories across various GitHub plans.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_name | string | Required | The exact name of the branch. Wildcards are not allowed; use GraphQL API for wildcards. |
repository_name | string | Required | The name of the GitHub repository. This name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-admin-branch-protection'.GithubApi.GetAdvancedSecurityCommitters
Retrieve GitHub Advanced Security committers for an organization. Use this tool to obtain details about active committers using GitHub Advanced Security across repositories within a specified organization. This includes the total count of unique committers and repository-level details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The organization name for which to retrieve security committers. It is not case sensitive. |
results_page_number | integer | Optional | The page number of the results to fetch. Useful for paginating through large sets of results. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum limit of 100. |
Requirements
Output
json— Response from the API endpoint 'billing/get-github-advanced-security-billing-org'.GithubApi.GetAllAuthorizedSshKeys
Retrieve all authorized SSH keys for enterprise admin. Use this tool to fetch a comprehensive list of all SSH keys authorized within an enterprise GitHub environment. Useful for administrators managing access and security.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-all-authorized-ssh-keys'.GithubApi.GetAllGithubCodesOfConduct
Retrieve all GitHub codes of conduct. Call this tool to get a list of all codes of conduct available on GitHub. Useful for reviewing or selecting a code of conduct for a project.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'codes-of-conduct/get-all-codes-of-conduct'.GithubApi.GetAllowedActionsForEnterprise
Retrieve the actions allowed in a GitHub enterprise. This tool gets the selected actions permitted in a specified enterprise. The enterprise's permission policy must be configured to allow selected actions. Authentication with an access token having the `admin:enterprise` scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug version or ID of the enterprise to fetch allowed actions for. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-allowed-actions-enterprise'.GithubApi.GetAllowedActionsForOrganization
Retrieve the allowed GitHub Actions for an organization. Call this tool to get the list of selected GitHub Actions permitted for an organization, provided the organization policy is set to allow selected actions only. Requires an authenticated access token with `admin:org` scope or GitHub App with `administration` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. This is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/get-allowed-actions-organization'.GithubApi.GetAllowedActionsForRepo
Retrieve allowed GitHub Actions settings for a repository. Use this tool to fetch the settings for actions that are allowed in a GitHub repository. This is applicable when the repository's policy is set to `selected` for `allowed_actions`. Requires authentication with a token having `repo` scope or GitHub Apps with `administration` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The username or organization name of the repository owner. Case insensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/get-allowed-actions-repository'.GithubApi.GetAppsWithBranchAccess
Retrieve GitHub Apps with access to a protected branch. This tool lists the GitHub Apps that have push access to a specific protected branch. It should be called when you need to identify which installed GitHub Apps are authorized to interact with a branch under protection.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_name | string | Required | The name of the branch. Wildcard characters are not allowed; use exact names only. |
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository, not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-apps-with-access-to-protected-branch'.GithubApi.GetBranchAccessRestrictions
Retrieve access information for a protected branch. Use this tool to list users, apps, and teams with access to a specified protected branch within an organization-owned repository on GitHub. It provides details about who has permissions to interact with the branch.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_name | string | Required | The exact name of the branch to retrieve access information for. Wildcard characters are not allowed. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-access-restrictions'.GithubApi.GetBranchProtectionStatusChecks
Retrieve status check protections for a GitHub branch. Use this tool to get information on the status check protections for a specific branch in a GitHub repository. It is useful for ensuring that a branch has the required checks before merging.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_name | string | Required | The name of the branch. It must not contain wildcard characters. |
repository_name | string | Required | The name of the GitHub repository to check. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-status-checks-protection'.GithubApi.GetCodeOfConduct
Retrieve a specific code of conduct from GitHub. This tool retrieves the details of a specific code of conduct using its unique key from GitHub. It should be called when you need information about a particular community guideline.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
conduct_code_key | string | Required | The unique identifier for the specific code of conduct you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'codes-of-conduct/get-conduct-code'.GithubApi.GetCodeScanningAlert
Retrieve a single code scanning alert from a GitHub repo. Use this tool to get detailed information about a specific code scanning alert in a GitHub repository. An access token with appropriate scopes is required for private repositories, and GitHub Apps need read permission for security events.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
alert_number | integer | Required | The unique number identifying a specific code scanning alert on GitHub. Found at the end of the URL for an alert or in the `number` field from the `GET /repos/{owner}/{repo}/code-scanning/alerts` response. |
repository_name | string | Required | The name of the repository. This parameter is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'code-scanning/get-alert'.GithubApi.GetCodeScanningAnalysis
Retrieve detailed code scanning analysis for a GitHub repository. Use this tool to access a specific code scanning analysis for a GitHub repository, including information such as the Git reference, commit SHA, analysis datetime, code scanning tool name, and the number of alerts. It requires appropriate permissions for both private and public repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
analysis_id | integer | Required | The ID number of the code scanning analysis to retrieve for the repository. This ID is obtained from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. |
repository_name | string | Required | The name of the GitHub repository. The name is not case sensitive. |
repository_owner | string | Required | Specify the account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'code-scanning/get-analysis'.GithubApi.GetCombinedCommitStatus
Retrieve the combined status of a commit for a given reference. This tool provides a combined view of commit statuses for a specified reference (SHA, branch, or tag) in a GitHub repository. It is useful for users with pull access who need to verify the overall status of a commit, including whether it is in a 'failure', 'pending', or 'success' state.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
reference_specifier | string | Required | The ref parameter specifying the SHA, branch name, or tag name for the commit status. |
repository_name | string | Required | The name of the repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is a case-insensitive string. |
results_page_number | integer | Optional | The page number of commit status results to fetch. Useful for pagination. |
results_per_page | integer | Optional | The number of results to include per page, with a maximum limit of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/get-combined-status-for-ref'.GithubApi.GetCommentStatistics
Retrieve comment statistics from GitHub Enterprise. Use this tool to get detailed statistics about comments in a GitHub Enterprise instance. Useful for analyzing comment activity and engagement across repositories.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-comment-stats'.GithubApi.GetCommitActivity
Fetch yearly commit activity grouped by week. Use this tool to obtain commit activity statistics for a GitHub repository over the past year, categorized by week. Useful for analyzing commit trends and activity levels.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This value is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-commit-activity-stats'.GithubApi.GetCommitActivityByHour
Retrieve commit activity per hour for a GitHub repository. Provides an array with commit activity stats showing the day of the week, hour of the day, and the number of commits for each hour in a specific GitHub repository. Useful for analyzing commit patterns and identifying peak development times.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository to analyze. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository; this is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-punch-card-stats'.GithubApi.GetCommitDetails
Retrieve details of a single commit reference. Fetches full details of a specific commit from a repository, including verification status, file diffs, and commit metadata. Useful for checking commit history, signature verification, and differences. Accessing this information requires 'read' access to the repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
commit_reference | string | Required | The reference string (branch name, tag, or commit SHA) for the commit to fetch details about. |
repository_name | string | Required | The name of the repository. This is not case sensitive and required to identify the repository from which to fetch commit details. |
repository_owner | string | Required | The account owner of the repository, not case sensitive. |
results_page_number | integer | Optional | The page number of the commit results to fetch from the API. Use for pagination. |
results_per_page | integer | Optional | Specify the number of results to return per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/get-commit'.GithubApi.GetCommitStatuses
Retrieve commit statuses for a specific ref in a repository. Call this tool to get the statuses of commits for a specific ref (SHA, branch, or tag) in a GitHub repository. Useful for checking build or test statuses and integrations that provide feedback on commits.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The GitHub username or organization name that owns the repository. This is not case sensitive. |
repository_reference | string | Required | The reference for the commit, which can be a SHA, branch name, or tag name. It specifies the ref to fetch statuses for in the repository. |
results_page_number | integer | Optional | The page number to fetch the results from, useful for pagination. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-commit-statuses-for-ref'.GithubApi.GetCommonlyUsedLicenses
Fetch a list of commonly used software licenses. Retrieves a collection of the most commonly used open-source software licenses from GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
only_featured_licenses | boolean | Optional | Set to true to return only featured licenses. |
results_page_number | integer | Optional | Page number of the results to fetch. Use to navigate through pages of results. |
results_per_page | integer | Optional | Specify the number of licenses to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'licenses/get-all-commonly-used'.GithubApi.GetDefaultGithubActionsPermissions
Retrieve default GitHub Actions workflow permissions for a repository. This tool retrieves the default workflow permissions associated with the `GITHUB_TOKEN` in a specific GitHub repository. It also checks if GitHub Actions can submit approving pull request reviews for that repository. Authentication with an access token having the `repo` scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository, which is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/get-github-actions-default-workflow-permissions-repository'.GithubApi.GetDefaultGithubActionsWorkflowPermissions
Fetches default workflow permissions for an organization's GitHub Actions. This tool retrieves the default workflow permissions granted to the GITHUB_TOKEN for running workflows in a specified organization, and checks if GitHub Actions can submit approving pull request reviews. Requires authentication with an access token having 'admin:org' scope or 'administration' permission for GitHub Apps.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The organization name for which to fetch the workflow permissions. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/get-github-actions-default-workflow-permissions-organization'.GithubApi.GetDependabotAlert
Retrieve details of a specific Dependabot alert. Use this tool to get information about a specific Dependabot alert in a GitHub repository. Applicable for both private and public repositories, depending on token scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
dependabot_alert_number | integer | Required | The identifier number for the Dependabot alert in the repository. Obtainable from the alert URL or response from `GET /repos/{owner}/{repo}/dependabot/alerts`. |
repository_name | string | Required | The name of the repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'dependabot/get-alert'.GithubApi.GetDeploymentBranchPolicy
Retrieve deployment branch policy for a specific environment. Use this tool to get the deployment branch policy for a specific environment in a GitHub repository. Requires read access to the repository. For private repositories, an access token with the `repo` scope is needed. GitHub Apps need `actions:read` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_policy_identifier | integer | Required | The unique identifier of the branch policy in the environment. Should be an integer value. |
environment_name | string | Required | The name of the environment for which the deployment branch policy is being retrieved. |
repository_name | string | Required | The name of the repository. Not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. This is case insensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-deployment-branch-policy'.GithubApi.GetEnterpriseAnnouncementBanner
Retrieve the global announcement banner for your enterprise. This tool fetches the current message and expiration date of the global announcement banner in your enterprise on GitHub. It is useful for administrators who need to check or display the announcement details.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-announcement'.GithubApi.GetEnterpriseAuditLog
Retrieve the audit log for a specified enterprise. This tool fetches the audit log for an enterprise on GitHub. It is intended for use by enterprise admins with proper access rights. The audit log provides insights into various activities and changes within the enterprise.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_slug_or_id | string | Required | The slug or ID of the enterprise to fetch the audit log for. Either the slug version of the enterprise name or the enterprise ID can be used. |
after_cursor | string | Optional | A cursor from the Link header to search for events after this point. |
audit_log_event_order | string | Optional | Specify 'desc' for newest events first or 'asc' for oldest events first. Default is 'desc'. |
event_types_to_include | string | Optional | Specify event types to include: 'web' for web events, 'git' for Git events, or 'all' for both. Defaults to 'web'. |
result_page_number | integer | Optional | The page number of audit log results to fetch. |
results_per_page | integer | Optional | Specify the number of results to display per page, with a maximum limit of 100. |
search_events_before_cursor | string | Optional | A cursor to filter events occurring before the specified position in the audit log. |
search_phrase | string | Optional | A search phrase to filter audit log entries. Refer to [GitHub Docs](https://docs.github.com/[email protected]/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log) for more details. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-audit-log'.GithubApi.GetEnvironmentSecretInfo
Retrieve details of an environment secret on GitHub. Fetches metadata about a specific GitHub environment secret. This tool is useful for getting information like the name and existence of a secret without revealing its encrypted value. Authentication with a token having `repo` scope or `secrets` permission is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
environment_name | string | Required | The name of the environment to access the secret from. Required to specify which environment's secret details to retrieve. |
repository_id | integer | Required | The unique identifier of the GitHub repository. |
secret_name | string | Required | The name of the environment secret to retrieve information about. |
Requirements
Output
json— Response from the API endpoint 'actions/get-environment-secret'.GithubApi.GetGistComment
Retrieve a specific comment from a GitHub gist. Use this tool to obtain details about a specific comment on a GitHub gist using the gist and comment IDs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_id | integer | Required | Unique identifier for the gist comment to retrieve details for. |
gist_unique_id | string | Required | The unique identifier for the gist needed to retrieve a specific comment. |
Requirements
Output
json— Response from the API endpoint 'gists/get-comment'.GithubApi.GetGistRevision
Retrieve a specific revision of a GitHub gist. Use this tool to get details about a specific revision of a GitHub gist using the gist ID and SHA.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gist_identifier | string | Required | The unique identifier of the GitHub gist to retrieve a specific revision. |
revision_sha | string | Required | The SHA hash of the specific gist revision to retrieve. |
Requirements
Output
json— Response from the API endpoint 'gists/get-revision'.GithubApi.GetGitGistStatistics
Retrieve gist statistics from GitHub Enterprise. Use this tool to obtain statistics for gists from GitHub Enterprise. It should be called when you need detailed data about gists usage and distribution.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-gist-stats'.GithubApi.GetGithubActionsCachePolicy
Retrieve the GitHub Actions cache usage policy for an enterprise. Fetches the cache usage policy for GitHub Actions associated with a specific enterprise. Requires authentication with an access token that has the `admin:enterprise` scope or a GitHub App with the `enterprise_administration:write` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug version or ID of the enterprise for GitHub Actions cache policy retrieval. |
Requirements
Output
json— Response from the API endpoint 'actions/get-actions-cache-usage-policy-for-enterprise'.GithubApi.GetGithubActionsCacheUsage
Fetch GitHub Actions cache usage for a repository. Use this tool to get the current cache usage for GitHub Actions in a specific repository. Cache data is updated approximately every 5 minutes. Requires read access to the repository and appropriate permissions for private repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. Case insensitive name. |
Requirements
Output
json— Response from the API endpoint 'actions/get-actions-cache-usage'.GithubApi.GetGithubActionsCacheUsageForEnterprise
Retrieve GitHub Actions cache usage for an enterprise. Fetches the total cache usage for GitHub Actions in a specified enterprise. Useful for monitoring and managing enterprise-level actions resources. The data is refreshed every 5 minutes and requires an access token with the 'admin:enterprise' scope for authentication.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug or ID of the enterprise. Can be either the enterprise name in slug format or the enterprise ID. |
Requirements
Output
json— Response from the API endpoint 'actions/get-actions-cache-usage-for-enterprise'.GithubApi.GetGithubActionsCacheUsageForOrg
Retrieve GitHub Actions cache usage for an organization's repositories. Use this tool to get a list of repositories and their GitHub Actions cache usage for a specified organization. The data is refreshed every 5 minutes. Requires authentication with an access token with the `read:org` scope or a GitHub App with `organization_administration:read` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization to retrieve cache usage for. This is not case sensitive. |
page_number | integer | Optional | Specify the page number of the results to fetch. This is useful for paginated data retrieval. |
results_per_page | integer | Optional | The number of results to return per page, with a maximum of 100 entries. |
Requirements
Output
json— Response from the API endpoint 'actions/get-actions-cache-usage-by-repo-for-org'.GithubApi.GetGithubActionsPermissions
Get GitHub Actions permissions for an enterprise. Retrieve the GitHub Actions permissions policy and allowed actions for organizations within a specified enterprise. Requires authentication with an access token that has the `admin:enterprise` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | Identifier for the enterprise, either as a slug version of the name or the enterprise ID. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-github-actions-permissions-enterprise'.GithubApi.GetGithubActionsPermissionsForOrganization
Retrieve GitHub Actions permissions for an organization. Fetches the GitHub Actions permissions policy for repositories and allowed actions within a specified organization. Requires authentication with an access token having the `admin:org` scope or a GitHub App with `administration` organization permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The organization name for which to retrieve GitHub Actions permissions. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/get-github-actions-permissions-organization'.GithubApi.GetGithubActionsRunReviews
Retrieve reviews for a GitHub Actions run. Call this tool to get reviews and approval details for a specific GitHub Actions run in a repository. It requires an access token with `repo` scope for private repositories or `actions:read` permission for GitHub Apps.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. The input is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. Not case sensitive. |
workflow_run_id | integer | Required | The unique identifier of the GitHub Actions workflow run. This integer is required to fetch the reviews. |
Requirements
Output
json— Response from the API endpoint 'actions/get-reviews-for-run'.GithubApi.GetGithubAppDetailsBySlug
Retrieve GitHub App details using its slug. Use this tool to obtain details about a GitHub App by providing its URL-friendly slug. This can be accessed without authentication for public apps, but requires authentication for private ones using a personal or installation access token.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_app_slug | string | Required | The URL-friendly name of the GitHub App to retrieve details for. Found on the GitHub App settings page. |
Requirements
Output
json— Response from the API endpoint 'apps/get-by-slug'.GithubApi.GetGithubAppInfo
Retrieve details about the authenticated GitHub App. This tool returns information about the GitHub App associated with the authentication credentials. It provides details such as the number of installations linked to the app. It's useful to check app configuration and installation status.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'apps/get-authenticated'.GithubApi.GetGithubAppInstallationInfo
Fetch information of a GitHub App installation by ID. Use this tool to retrieve detailed information about a specific GitHub App installation using its installation ID. Useful for scenarios where you need to know the configuration or settings of a particular installation.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
installation_id | integer | Required | The unique identifier of the GitHub App installation to fetch information for. |
Requirements
Output
json— Response from the API endpoint 'apps/get-installation'.GithubApi.GetGithubAppInstallations
Retrieve GitHub App installations for the authenticated user. Lists GitHub App installations that the authenticated user can access with permissions such as `:read`, `:write`, or `:admin`. This requires a user-to-server OAuth access token, valid for a user who authorized the app. Useful for accessing repositories owned, collaborated on, or accessible through organization membership.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
results_page_number | integer | Optional | Page number of the results to fetch for GitHub App installations. |
results_per_page | integer | Optional | Specifies the number of results to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'apps/list-installations-for-authenticated-user'.GithubApi.GetGithubAppRepoInstallation
Fetches GitHub App installation info for a repository. Use this tool to get the installation information of a GitHub App for a specific repository. The installation can belong to an organization or user account, depending on the repository's owner.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. It is not case sensitive and identifies the specific repository for which to retrieve GitHub App installation information. |
repository_owner | string | Required | The account owner's name for the repository, not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'apps/get-repo-installation'.GithubApi.GetGithubAppWebhookConfig
Fetches the webhook configuration for a GitHub App. This tool retrieves the webhook configuration details for a specific GitHub App. It should be called when you need to review or manage the webhook settings of your GitHub App. Note that access requires authentication using a JWT.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'apps/get-webhook-config-for-app'.GithubApi.GetGithubAppWebhookDelivery
Retrieve delivery details for a GitHub App webhook. Fetches the delivery information for a specific webhook configured in a GitHub App. This tool should be called when you need to obtain details about a specific delivery event linked to a webhook. Ensure you are authenticated with a JWT to access this information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_delivery_id | integer | Required | The ID of the webhook delivery to retrieve. Must be an integer. |
Requirements
Output
json— Response from the API endpoint 'apps/get-webhook-delivery'.GithubApi.GetGithubArtifactDownloadUrl
Retrieve a URL to download a GitHub artifact zip file. Use this tool to get a redirect URL for downloading an artifact zip file from a GitHub repository. The URL is valid for 1 minute and requires read access to the repository. For private repositories, an access token with the 'repo' scope is needed. This tool is useful for automating the retrieval of artifact files from GitHub Actions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
archive_format_zip | string | Required | Specify the archive format as 'zip'. This is required for the download link. |
artifact_id | integer | Required | The unique identifier of the artifact to be downloaded. |
repository_name | string | Required | The name of the GitHub repository (not case sensitive). |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/download-artifact'.GithubApi.GetGithubBlobContent
Retrieve Base64 encoded content of a GitHub blob. Use this tool to fetch the content of a blob from a GitHub repository. It is useful for accessing file contents stored in GitHub in a Base64 encoded format. This tool supports blobs up to 100 megabytes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_sha_identifier | string | Required | The SHA identifier for the blob. This is used to access the specific file blob from the GitHub repository. |
repository_name | string | Required | The name of the GitHub repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'git/get-blob'.GithubApi.GetGithubBranchProtection
Retrieve protection settings for a GitHub branch. Use this tool to obtain protection settings for a specific branch in a GitHub repository. This is useful for understanding the rules and restrictions applied to the branch, including who can push changes or enforce specific merge rules.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_name | string | Required | The specific name of the GitHub branch to retrieve protection settings for. Must not contain wildcard characters. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-branch-protection'.GithubApi.GetGithubCheckRun
Retrieve a specific GitHub check run by its ID. Use this tool to get details of a single check run from a GitHub repository using its ID. This is applicable for both private and public repositories, with necessary permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
check_run_identifier | integer | Required | The unique identifier of the GitHub check run to retrieve. |
repository_name | string | Required | The name of the GitHub repository, not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'checks/get'.GithubApi.GetGithubCheckSuite
Retrieve a GitHub check suite by ID. Use this tool to get information about a specific check suite in a GitHub repository using its ID. Suitable for users with appropriate permissions on private or public repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
check_suite_id | integer | Required | The unique identifier for the GitHub check suite to retrieve. |
repository_name | string | Required | The name of the repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'checks/get-suite'.GithubApi.GetGithubCommitComment
Retrieve details of a specific commit comment on GitHub. Use this tool to get detailed information about a specific commit comment in a GitHub repository, identified by the owner, repository name, and comment ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_identifier | integer | Required | The unique identifier for the GitHub commit comment to be retrieved. |
repository_name | string | Required | The name of the repository. This value is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-commit-comment'.GithubApi.GetGithubContributorStats
Retrieve GitHub repository contributor statistics. Fetches the total number of commits made by each contributor to a GitHub repository. It also provides a weekly breakdown of additions, deletions, and commits.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case-sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. This is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-contributors-stats'.GithubApi.GetGithubDeployKey
Retrieve a deploy key from a GitHub repository. This tool retrieves the details of a specific deploy key associated with a GitHub repository. It should be used when you need to access information about a deploy key for a specified repository and key ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
deploy_key_id | integer | Required | The unique identifier of the deploy key to retrieve from the repository. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-deploy-key'.GithubApi.GetGithubDeploymentStatus
Retrieve details of a specific GitHub deployment. Call this tool to get information about a particular deployment in a GitHub repository, including its status and other related details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
deployment_id | integer | Required | The unique identifier for the deployment to retrieve details about. |
repository_name | string | Required | The name of the GitHub repository, not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-deployment'.GithubApi.GetGithubEnterpriseMetaInfo
Retrieve GitHub Enterprise Server meta information. This tool is used to obtain meta information about a GitHub Enterprise Server. It should be called when details about the server's configuration and capabilities are needed.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'meta/get'.GithubApi.GetGithubEnterpriseSettings
Retrieve the current settings of your GitHub Enterprise instance.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-settings'.GithubApi.GetGithubEnterpriseStats
Retrieve all statistics for GitHub Enterprise. This tool fetches comprehensive statistics related to GitHub Enterprise. It should be used when you need detailed operational insights into the GitHub Enterprise environment.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-all-stats'.GithubApi.GetGithubEnvironmentPublicKey
Fetch the public key for a GitHub environment. This tool retrieves the public key needed to encrypt environment secrets for a specified GitHub repository and environment. Use it when you need to secure secrets before creating or updating them. Requires appropriate access permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
environment_name | string | Required | The name of the GitHub environment for which to retrieve the public key. |
repository_id | integer | Required | The unique identifier of the GitHub repository. It must be an integer value. |
Requirements
Output
json— Response from the API endpoint 'actions/get-environment-public-key'.GithubApi.GetGithubEnvVariable
Retrieve specific environment variable details from GitHub. Call this tool to get information about a specific environment variable within a specified environment of a GitHub repository. Requires authentication with an access token having 'repo' scope or GitHub App permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
environment_name | string | Required | The name of the environment to retrieve the variable from. Required for identifying the specific environment. |
repository_id | integer | Required | The unique identifier of the GitHub repository. |
variable_name | string | Required | The name of the environment variable to retrieve from the GitHub repository. |
Requirements
Output
json— Response from the API endpoint 'actions/get-environment-variable'.GithubApi.GetGithubExternalGroupInfo
Retrieve information about a GitHub external group's usage. This tool displays information about a specific external group's usage within a GitHub organization. It provides details on the group's external members and the teams connected to this group. Useful for managing team membership through identity providers using Enterprise Managed Users for GitHub Enterprise Cloud.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_id | integer | Required | The unique identifier of the group. Must be an integer. |
organization_name | string | Required | The name of the GitHub organization. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'teams/external-idp-group-info-for-org'.GithubApi.GetGithubFeeds
Retrieve available GitHub feeds for an authenticated user. This tool retrieves a list of timeline resources available on GitHub Enterprise Server in Atom format. It includes global public timelines, public and private timelines for users, private timelines for user activities and organizations, and security advisories. Private feeds require Basic Auth for retrieval.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'activity/get-feeds'.GithubApi.GetGithubGist
Retrieve details of a specific GitHub gist using its ID. Use this tool to obtain information about a particular GitHub gist by providing the gist ID. It is helpful when you need to access the content, description, or other metadata of a GitHub gist.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gist_identifier | string | Required | The unique identifier for the GitHub gist you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'gists/get'.GithubApi.GetGithubGlobalWebhook
Retrieve details of a specific global webhook in GitHub Enterprise. Use this tool to obtain detailed information about a specific global webhook in a GitHub Enterprise setup by providing the hook ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
global_webhook_id | integer | Required | The unique identifier for the global webhook in GitHub Enterprise. Provide this ID to retrieve specific webhook details. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-global-webhook'.GithubApi.GetGithubIssueComment
Retrieve a comment from a GitHub issue. Use this tool to obtain detailed information about a specific comment on an issue within a GitHub repository. It requires specifying the repository owner, repository name, and comment ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_identifier | integer | Required | The unique integer identifier for the GitHub issue comment. |
repository_name | string | Required | The name of the repository. It is not case sensitive and is required to identify the repository within an account. |
repository_owner | string | Required | The account owner of the repository on GitHub. This is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'issues/get-comment'.GithubApi.GetGithubIssueDetails
Fetch details of a specific issue or pull request on GitHub. Use this tool to retrieve information about a particular issue or pull request from a GitHub repository. This tool returns a 301 status if the issue was transferred, 404 if inaccessible or deleted, and 410 if deleted but accessible. Pull requests are also considered issues and can be identified by the 'pull_request' key in the response.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issue_identifier | integer | Required | The unique number that identifies the issue or pull request on GitHub. |
repository_name | string | Required | The name of the GitHub repository. This is not case sensitive. |
repository_owner | string | Required | The GitHub username of the repository owner. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'issues/get'.GithubApi.GetGithubIssueStatistics
Retrieve statistics on GitHub issues for an enterprise. This tool fetches statistical data related to issues in a GitHub enterprise account. It should be called when you need insights on issue counts, trends, or other related metrics.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-issue-stats'.GithubApi.GetGithubLabel
Retrieve details of a GitHub repository label. Call this tool to get information about a specific label from a GitHub repository, including its details and specifications.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
label_name | string | Required | The specific name of the label to retrieve from the GitHub repository. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. Not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'issues/get-label'.GithubApi.GetGithubLicense
Retrieve a specific GitHub license by its key. Use this tool to get details about a specific license on GitHub by specifying its key. Useful when you need information about license terms and conditions for a repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
license_key | string | Required | The key of the GitHub license to retrieve information about. |
Requirements
Output
json— Response from the API endpoint 'licenses/get'.GithubApi.GetGithubMilestone
Retrieve details of a GitHub milestone for a repository. This tool is used to obtain information about a specific milestone in a GitHub repository. It should be called when you need to access details such as the milestone's due date, description, or state.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
milestone_id | integer | Required | The unique number identifying the milestone to retrieve details from a GitHub repository. |
repository_name | string | Required | The name of the repository for which the milestone information is needed. This name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'issues/get-milestone'.GithubApi.GetGithubNotificationThread
Retrieve information about a GitHub notification thread. Use this tool to get detailed information about a specific notification thread on GitHub. It's helpful for users who need to track updates or manage their notifications.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
notification_thread_id | integer | Required | The unique identifier of the notification thread, returned in the `id` field when retrieving notifications. |
Requirements
Output
json— Response from the API endpoint 'activity/get-thread'.GithubApi.GetGithubOrgInfo
Retrieve detailed information about a GitHub organization. This tool retrieves information about a specific GitHub organization, such as its plan and two-factor authentication requirements. It requires authentication as an organization owner or a GitHub App with the appropriate permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization to retrieve information for. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'orgs/get'.GithubApi.GetGithubOrgInstallationInfo
Retrieve GitHub organization's installation information. Use this tool to find installation details for an organization using an authenticated GitHub App. It requires a JWT for access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name. It is not case-sensitive. |
Requirements
Output
json— Response from the API endpoint 'apps/get-org-installation'.GithubApi.GetGithubOrgSecret
Retrieve details of a GitHub organization secret. Use this tool to get the details of a GitHub organization secret without exposing its encrypted value. Authentication with an access token with `admin:org` scope or GitHub App with `secrets` permission is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name. This name is not case sensitive. |
secret_name | string | Required | The name of the secret within the GitHub organization. It identifies which secret's details to retrieve. |
Requirements
Output
json— Response from the API endpoint 'actions/get-org-secret'.GithubApi.GetGithubOrgStats
Retrieve organization statistics from GitHub Enterprise. Use this tool to get detailed statistics about organizations in a GitHub Enterprise setup. It's useful for monitoring and analyzing organizational data.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-org-stats'.GithubApi.GetGithubPagesBuild
Retrieve details of a GitHub Pages build for a repository. Use this tool to get information about a specific GitHub Pages build in a repository on GitHub Enterprise Server. It requires the repository owner, repository name, and build ID to fetch the details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
build_identifier | integer | Required | The unique identifier for the GitHub Pages build. |
repository_name | string | Required | The name of the repository. This field is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-pages-build'.GithubApi.GetGithubPagesSite
Retrieve details of a GitHub Pages site for a repository. This tool is used to get information about a GitHub Pages site for a specified repository on GitHub Enterprise Server. It should be called when you need details about the Pages site configuration or status for a given repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. Not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-pages'.GithubApi.GetGithubPagesStats
Retrieve statistics for GitHub Pages in an enterprise account. Use this tool to obtain detailed statistics about GitHub Pages usage and performance within an enterprise account.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-pages-stats'.GithubApi.GetGithubPreReceiveEnvironment
Retrieve a GitHub pre-receive environment by ID. Use this tool to get detailed information about a specific pre-receive environment in GitHub for enterprise administration purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pre_receive_environment_id | integer | Required | The unique identifier for the GitHub pre-receive environment. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-pre-receive-environment'.GithubApi.GetGithubProjectById
Retrieve details of a GitHub project by its ID. Call this tool to obtain information about a specific GitHub project using its ID. It provides project details if accessible or returns an appropriate error status if there are issues like insufficient privileges or if projects are disabled.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_id | integer | Required | The unique identifier for the GitHub project to retrieve. |
Requirements
Output
json— Response from the API endpoint 'projects/get'.GithubApi.GetGithubProjectColumn
Retrieve details of a GitHub project column using its ID. Use this tool to obtain information about a specific column in a GitHub project. It should be called when you need to access the details of a project column using its column ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_column_id | integer | Required | The unique identifier for the project column to retrieve. |
Requirements
Output
json— Response from the API endpoint 'projects/get-column'.GithubApi.GetGithubRateLimit
Retrieve current GitHub API rate limit status. Use this tool to check the current API rate limit status on GitHub. It provides information on the remaining requests allowed in the current rate limit window without affecting your API usage.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'rate-limit/get'.GithubApi.GetGithubReleaseByTag
Retrieve GitHub release details by tag. Use this tool to get details of a published GitHub release using the specified repository owner, repository name, and release tag.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
release_tag | string | Required | The specific tag of the release to retrieve. This is used to identify and fetch details of the published release. |
repository_name | string | Required | Specify the name of the repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. Provide the GitHub username or organization name. |
Requirements
Output
json— Response from the API endpoint 'repos/get-release-by-tag'.GithubApi.GetGithubReleaseDetails
Retrieve details of a specific GitHub release. Use this tool to obtain details about a specific release from a GitHub repository. This includes the upload URL for release assets, which is a hypermedia resource.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
release_id | integer | Required | The unique identifier for the specific GitHub release being queried. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-release'.GithubApi.GetGithubReleases
Retrieve a list of releases for a GitHub repository. Use this tool to get a list of releases from a specific GitHub repository. Note that this list will only include releases, not regular Git tags. Draft releases will be listed only if the user has push access to the repository. This tool is useful for accessing information about software releases available on GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. Case insensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. The name is not case sensitive. |
results_page_number | integer | Optional | The specific page number of releases to fetch from a repository. |
results_per_page | integer | Optional | Specify the number of release results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-releases'.GithubApi.GetGithubRepoBranch
Retrieve details of a specific branch from a GitHub repository. Use this tool to obtain information about a particular branch within a specified GitHub repository. Provide the owner, repository name, and branch name to get the branch details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_name | string | Required | The name of the GitHub branch. Avoid using wildcard characters. For wildcard support, refer to the GitHub GraphQL API. |
repository_name | string | Required | The name of the GitHub repository (case-insensitive). |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-branch'.GithubApi.GetGithubRepoContent
Retrieve file or directory contents from a GitHub repository. Use this tool to get the contents of a specified file or directory in a GitHub repository. By specifying the file path or directory, you can fetch the required information. If no path is specified, the root directory contents are retrieved. It supports custom media types for raw or HTML content. Note that files larger than 100 MB are not supported.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_or_directory_path | string | Required | The file or directory path within the repository. If omitted, the root directory is accessed. |
repository_name | string | Required | The name of the GitHub repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This value is not case sensitive. |
commit_branch_or_tag | string | Optional | The name of the commit, branch, or tag to retrieve content from. Defaults to the repository's default branch, usually 'master'. |
Requirements
Output
json— Response from the API endpoint 'repos/get-content'.GithubApi.GetGithubRepoEnvironmentDetails
Retrieve details about a GitHub repository environment. Use this tool to get information on a specified environment within a GitHub repository. This can be used by anyone with read access to the repository. Access tokens with the 'repo' scope are required for private repositories, and GitHub Apps need 'actions:read' permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
environment_name | string | Required | The name of the environment to retrieve details for. It is case insensitive. |
repository_name | string | Required | The name of the GitHub repository (not case sensitive). |
repository_owner_account_name | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-environment'.GithubApi.GetGithubRepoPublicKey
Retrieve the public key for encrypting repository secrets. Use this tool to obtain the public key needed for encrypting secrets before creating or updating them in a GitHub repository. It can be accessed by anyone with read access to the repository. For private repositories, an access token with the `repo` scope is required. GitHub Apps need the `dependabot_secrets` repository permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository, not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'dependabot/get-repo-public-key'.GithubApi.GetGithubRepoRequiredWorkflow
Retrieve a specific required workflow from a GitHub repository. This tool fetches details of a required workflow from a specified GitHub repository. It can be used by anyone with read access to the repository. For private repositories, an access token with the 'repo' scope is needed. Useful for managing and auditing workflows in GitHub repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
required_workflow_id | integer | Required | The unique ID of the required workflow that has executed at least once in the repository. |
Requirements
Output
json— Response from the API endpoint 'actions/get-repo-required-workflow'.GithubApi.GetGithubRepositoryDetails
Retrieve detailed information about a GitHub repository. This tool retrieves detailed information about a specified GitHub repository. It provides details such as the parent and source repositories if the repository is a fork. Admin or owner permissions might be required to access certain security details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. This is not case sensitive. |
repository_owner | string | Required | Specify the account owner of the repository. This name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get'.GithubApi.GetGithubRepoVariable
Retrieve a specific variable from a GitHub repository. This tool retrieves information about a specific variable within a GitHub repository. It's useful when you need to access configuration or environment variables stored in a repository. Authentication with an access token having the `repo` scope is required, or GitHub Apps must have the `actions_variables:read` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
variable_name | string | Required | The name of the variable to retrieve from the repository. This is case-sensitive and must match the variable's exact name. |
Requirements
Output
json— Response from the API endpoint 'actions/get-repo-variable'.GithubApi.GetGithubReview
Retrieve details of a specific pull request review from GitHub. Use this tool to obtain a review for a specific pull request by providing the repository owner, repository name, pull request number, and review ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pull_request_number | integer | Required | The unique number identifying the pull request on GitHub. |
repository_name | string | Required | The name of the GitHub repository. This field is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. It is not case sensitive. |
review_id | integer | Required | The unique numeric identifier for the specific review of the pull request. |
Requirements
Output
json— Response from the API endpoint 'pulls/get-review'.GithubApi.GetGithubReviewCommentDetails
Get details for a specific GitHub review comment. Call this tool to obtain detailed information about a specific review comment on a GitHub pull request, such as the content, author, and creation time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_id | integer | Required | The unique identifier of the GitHub review comment you want to retrieve details for. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This value is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'pulls/get-review-comment'.GithubApi.GetGithubRootLinks
Retrieve Hypermedia links to GitHub's REST API resources. Call this tool to obtain Hypermedia links that provide access to various resources in GitHub's REST API. Useful for navigating the capabilities and endpoints available in GitHub's API.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'meta/root'.GithubApi.GetGithubSecretScanningAlert
Retrieve a specific secret scanning alert from a GitHub repository. Use this tool to obtain details of a secret scanning alert detected in a GitHub repository. This requires administrative access to the repository or organization, and an appropriate personal access token. It also supports GitHub Apps with specific read permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
alert_identifier | integer | Required | The unique integer number identifying a GitHub secret scanning alert. This is found at the URL's end for the alert or in the `number` field of the alert response. |
repository_name | string | Required | The case-insensitive name of the repository from which to retrieve the secret scanning alert. |
repository_owner | string | Required | The username of the account owner for the repository. Case insensitive. |
Requirements
Output
json— Response from the API endpoint 'secret-scanning/get-alert'.GithubApi.GetGithubSecurityBillingInfo
Retrieve GitHub Advanced Security billing details for an enterprise. This tool retrieves data on active committers using GitHub Advanced Security for an enterprise, listed per repository. It provides information on the number of distinct user logins and the total repositories with committer information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug or ID representing the enterprise name for security billing info. |
results_page_number | integer | Optional | Specify the page number of results to fetch. Use to navigate through paginated data. |
results_per_page | integer | Optional | The number of results per page to return. Maximum is 100. |
Requirements
Output
json— Response from the API endpoint 'billing/get-github-advanced-security-billing-ghe'.GithubApi.GetGithubStatusCheckContexts
Retrieve status check contexts for a protected GitHub branch. This tool fetches all status check contexts for a specific protected branch in a GitHub repository. Useful for understanding the checks required for branch protections. Suitable for repositories with branch protection enabled.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_name | string | Required | The name of the branch. Cannot include wildcard characters. |
repository_name | string | Required | The name of the GitHub repository. This value is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-all-status-check-contexts'.GithubApi.GetGithubTeamDiscussionComment
Retrieve a specific comment from a GitHub team discussion. Use this tool to get details of a specific comment within a team discussion on GitHub. This is useful for accessing detailed information about comments in organizational discussions. Ensure OAuth tokens have the `read:discussion` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_identifier | integer | Required | The specific number identifying the comment in the discussion. |
discussion_id | integer | Required | The unique number identifying the specific discussion on GitHub. |
organization_name | string | Required | The name of the GitHub organization. This is not case sensitive. |
team_slug | string | Required | The slug (URL-friendly version) of the GitHub team's name. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'teams/get-discussion-comment-in-org'.GithubApi.GetGithubTokenWorkflowPermissions
Retrieve GitHub Actions default workflow permissions for an enterprise. This tool retrieves the default permissions for the `GITHUB_TOKEN` in workflows within a specified enterprise, including settings for pull request review approvals. Use this tool to understand and manage workflow access within your GitHub enterprise.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug version of the enterprise name or the enterprise ID. |
Requirements
Output
json— Response from the API endpoint 'actions/get-github-actions-default-workflow-permissions-enterprise'.GithubApi.GetGithubUserHovercardInfo
Retrieve detailed hovercard info for a GitHub user. Fetches hovercard information about a specified GitHub user, offering insights related to their pull requests, issues, repositories, and organizations. Requires authentication through basic auth or OAuth with the `repo` scope. Enhanced details can be obtained by specifying `subject_type` and `subject_id` parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_username | string | Required | The GitHub username for which to retrieve hovercard information. |
additional_info_type | string | Optional | Specifies the type of related information for the user's hovercard. Options: `organization`, `repository`, `issue`, `pull_request`. Required with `subject_id`. |
subject_identifier | string | Optional | The ID corresponding to the specified `subject_type` (e.g., organization, repository). Required if `subject_type` is used. |
Requirements
Output
json— Response from the API endpoint 'users/get-context-for-user'.GithubApi.GetGithubUserInfo
Fetch public details of a GitHub user using their username. This tool retrieves publicly available information about a GitHub user's account. It is useful for obtaining details such as username, profile information, and publicly visible email addresses if set by the user. Ideal for applications needing GitHub user data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_username | string | Required | The GitHub user's handle. Used to fetch their public profile information. |
Requirements
Output
json— Response from the API endpoint 'users/get-by-username'.GithubApi.GetGithubUserInstallation
Retrieve a user's GitHub App installation information. Use to find installation details for a user authenticated with a GitHub App using a JWT.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The handle (username) of the GitHub user account to retrieve installation details for. |
Requirements
Output
json— Response from the API endpoint 'apps/get-user-installation'.GithubApi.GetGithubUserProfile
Retrieve authenticated user's GitHub profile information. Fetches public and private profile information for the authenticated GitHub user if authenticated with the `user` scope. Returns only public information otherwise.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'users/get-authenticated'.GithubApi.GetGithubUserStats
Retrieve user statistics from GitHub Enterprise. This tool retrieves user statistics from a GitHub Enterprise instance. It should be called when needing detailed user data to analyze usage and activity metrics.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-user-stats'.GithubApi.GetGithubWebhookDelivery
Retrieve a webhook delivery for a GitHub organization. This tool is used to obtain details about a specific delivery of a webhook configured in a GitHub organization. It provides information about the delivery for a given organization, hook, and delivery identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
hook_identifier | integer | Required | The unique identifier of the webhook hook. This is an integer value used to specify which webhook's delivery details to retrieve for the organization. |
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
webhook_delivery_id | integer | Required | The unique identifier of the specific delivery to be retrieved. This should be an integer. |
Requirements
Output
json— Response from the API endpoint 'orgs/get-webhook-delivery'.GithubApi.GetGithubWorkflowJob
Retrieve a specific job from a GitHub workflow run. Use this tool to get details of a specific job from a GitHub workflow run. Requires read access to the repository. For private repositories, an access token with 'repo' scope is needed. GitHub Apps need 'actions:read' permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
job_identifier | integer | Required | Unique integer identifier of the workflow job to retrieve. |
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. Case insensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/get-job-for-workflow-run'.GithubApi.GetGithubWorkflowRun
Retrieve details of a specific GitHub workflow run. Use this tool to get information about a specific workflow run on GitHub. It requires read access to the repository; for private repositories, an access token with `repo` scope is needed. Ideal for tracking and reviewing the status and details of a workflow run.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. It is not case sensitive and is used to identify the repo for the workflow run. |
repository_owner | string | Required | The account owner of the repository, not case sensitive. |
workflow_run_id | integer | Required | The unique identifier of the GitHub workflow run. Must be an integer. |
omit_pull_requests | boolean | Optional | If true, omits pull requests from the response, resulting in an empty array. |
Requirements
Output
json— Response from the API endpoint 'actions/get-workflow-run'.GithubApi.GetGithubWorkflowRunAttempt
Retrieve details of a specific GitHub workflow run attempt. Use this tool to access detailed information about a specific workflow run attempt in a GitHub repository. Accessible with repository read permissions. Requires an access token for private repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository, not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This value is not case sensitive. |
workflow_attempt_number | integer | Required | The numeric identifier for the specific attempt of the workflow run to be retrieved. |
workflow_run_id | integer | Required | The unique identifier of the GitHub workflow run. This integer specifies the exact run to retrieve information for. |
omit_pull_requests | boolean | Optional | Set to true to omit pull requests from the response. |
Requirements
Output
json— Response from the API endpoint 'actions/get-workflow-run-attempt'.GithubApi.GetGitReference
Fetch a specific Git reference from a repository. Use this tool to retrieve a branch or tag reference from a Git repository on GitHub. Input the specific branch or tag name formatted correctly to obtain the reference. Returns a 404 if the reference does not exist.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
git_reference | string | Required | The reference to the Git branch or tag, formatted as `heads/<branch name>` or `tags/<tag name>`. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'git/get-ref'.GithubApi.GetGitTagSignatureVerification
Retrieve verification details of a git tag signature. This tool is used to get the verification details of a git tag's signature from a GitHub repository. It provides information about whether the signature is verified and the reason for the verification status.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. This value is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. This name is not case sensitive. |
tag_sha | string | Required | The SHA hash identifier of the git tag to be verified. This should be a string. |
Requirements
Output
json— Response from the API endpoint 'git/get-tag'.GithubApi.GetGitTree
Fetch a git tree by its SHA1 value from a GitHub repo. Use this tool to retrieve a single tree structure from a GitHub repository using its SHA1 value. If the response indicates `truncated`, the tree array exceeds the maximum limit, requiring non-recursive methods for complete retrieval. This is useful for accessing specific parts of a repository's file structure.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. This is case-insensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
tree_sha | string | Required | The SHA1 value of the tree to fetch. This identifier is necessary to specify which tree structure should be retrieved from the repository. |
enable_recursive_retrieval | string | Optional | If set, returns objects/subtrees referenced by the provided tree SHA. Use values: '0', '1', 'true', 'false'. Omit to disable recursion. |
Requirements
Output
json— Response from the API endpoint 'git/get-tree'.GithubApi.GetHooksStatistics
Retrieves statistics about enterprise webhooks on GitHub. Use this tool to obtain detailed statistics on webhook usage and performance within a GitHub Enterprise environment. It helps administrators monitor and analyze webhook activity.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-hooks-stats'.GithubApi.GetIssueTimelineEvents
Retrieve timeline events for a GitHub issue. Use this tool to fetch and list all timeline events for a specific issue in a GitHub repository. It should be called when detailed event information about an issue's timeline is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issue_identifier | integer | Required | The unique number identifying the GitHub issue. |
repository_name | string | Required | The name of the repository in GitHub. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository, not case sensitive. |
results_page_number | integer | Optional | Page number of results to fetch, used for pagination. |
results_per_page | integer | Optional | Specify the number of timeline events to retrieve per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'issues/list-events-for-timeline'.GithubApi.GetLatestGithubPagesBuild
Retrieve the latest GitHub Pages build information. This tool fetches the latest build information for GitHub Pages of a specified repository. It should be called when the user wants to know the most recent build status or details for a GitHub Pages site.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. Enter the name without considering case sensitivity. |
Requirements
Output
json— Response from the API endpoint 'repos/get-latest-pages-build'.GithubApi.GetLatestGithubRelease
Retrieve the latest full release from a GitHub repository. This tool fetches the most recent full release from a specified GitHub repository, excluding prerelease and draft releases. It is useful for monitoring updates and obtaining the latest stable release information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository to retrieve the latest release from. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-latest-release'.GithubApi.GetLicenseInformation
Retrieve GitHub Enterprise license information. Use this tool to fetch information about your GitHub Enterprise license settings. It is helpful for administrators who need to manage license details.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-license-information'.GithubApi.GetMilestoneStatistics
Retrieve GitHub enterprise milestone statistics. Use this tool to get statistics about milestones in a GitHub enterprise environment. It is useful for understanding project progress and tracking milestones.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-milestone-stats'.GithubApi.GetOctocatAsciiArt
Retrieve the octocat as ASCII art. Use this tool to get the octocat character depicted in ASCII art from GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
speech_bubble_text | string | Optional | Text to display in Octocat's speech bubble. Provide a string with the desired message. |
Requirements
Output
json— Response from the API endpoint 'meta/get-octocat'.GithubApi.GetOidcCustomSubTemplateForOrg
Retrieves the OIDC subject claim customization template for an organization. Use this tool to get the customization template for an OpenID Connect (OIDC) subject claim for a specific organization. This requires authentication with a GitHub access token with `read:org` scope or a GitHub App with `organization_administration:write` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization for which you want to retrieve the OIDC customization template. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'oidc/get-oidc-custom-sub-template-for-org'.GithubApi.GetOidcSubjectClaimTemplate
Retrieve the OIDC subject claim customization template for a repository. Use this tool to get the customization template for an OpenID Connect (OIDC) subject claim for a specific GitHub repository. Requires authentication with a token having `repo` scope, or `organization_administration:read` permission for GitHub Apps.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/get-custom-oidc-sub-claim-for-repo'.GithubApi.GetOrganizationPublicKey
Retrieve the public key for GitHub organization secrets encryption. Use this tool to obtain the public key necessary for encrypting secrets before creation or update within a GitHub organization. This requires authentication with an access token that has the `admin:org` scope. Suitable for use when managing organization secrets securely.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name. This is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/get-org-public-key'.GithubApi.GetOrganizationVariable
Retrieve a specific variable from a GitHub organization. Use this tool to access a particular variable within a GitHub organization. Requires authentication with an access token with the 'admin:org' scope or a GitHub App with 'organization_actions_variables:read' permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name. This value is not case sensitive. |
variable_name | string | Required | The exact name of the specific variable to retrieve from the organization. |
Requirements
Output
json— Response from the API endpoint 'actions/get-org-variable'.GithubApi.GetOrgAnnouncementBanner
Retrieve the announcement banner for a specific organization. Fetches the current announcement banner set at the organization level. Does not include enterprise-level banners.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'announcement-banners/get-announcement-banner-for-org'.GithubApi.GetOrgAuditLog
Retrieve the audit log for a GitHub organization. This tool retrieves the audit log for a specified GitHub organization. It is used to monitor and review up to 30 events from the past three months by default. Organization owners or GitHub Apps with appropriate permissions can filter, paginate, and analyze audit events using this tool. Useful for tracking organization activities and security events.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
event_order | string | Optional | Specify the order of audit log events. Use 'desc' for newest first or 'asc' for oldest first. Default is 'desc'. |
event_types_to_include | string | Optional | Specify the event types to include: 'web' for web events, 'git' for Git events, or 'all' for both. Default is 'web'. |
results_page_number | integer | Optional | Specify the page number of results to fetch. Useful for navigating through paginated audit log entries. |
results_per_page | integer | Optional | Defines the number of audit log events returned per page, with a maximum of 100. |
search_events_after_cursor | string | Optional | Cursor for searching events after a specific point, as given in the Link header. |
search_events_before_cursor | string | Optional | A cursor to search for events before this point. Use to limit results to events occurring before a specific reference. |
search_phrase | string | Optional | A string to filter audit log events based on specific criteria. This can help in retrieving older events. Refer to the GitHub documentation for more details on searching the audit log. |
Requirements
Output
json— Response from the API endpoint 'orgs/get-audit-log'.GithubApi.GetOrgMembershipStatus
Retrieve the user's organization membership status. Use this tool to get the membership details of an authenticated user within a specified organization on GitHub. It is useful for checking the user's roles and permissions in the organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. It is not case sensitive and should be provided as a string. |
Requirements
Output
json— Response from the API endpoint 'orgs/get-membership-for-authenticated-user'.GithubApi.GetOrgPreReceiveHook
Retrieve a pre-receive hook for an organization. Fetches details of a specific pre-receive hook associated with a GitHub organization using the organization's name and the hook ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization; case insensitive. |
pre_receive_hook_unique_id | integer | Required | The unique identifier of the pre-receive hook. Must be an integer. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-pre-receive-hook-for-org'.GithubApi.GetOrgPublicKey
Retrieve the public key for encrypting GitHub Dependabot secrets. Use this tool to get your GitHub organization's public key, which is necessary for encrypting secrets before creating or updating them in Dependabot. Ensure authentication with an access token with the `admin:org` scope or GitHub App permissions for `dependabot_secrets`.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name, not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'dependabot/get-org-public-key'.GithubApi.GetOrgRunnerRemovalToken
Get a token to remove a self-hosted runner from an organization. Use this tool to obtain a token for removing a self-hosted runner from a GitHub organization. The token expires after one hour and requires an access token with the `admin:org` scope for authentication.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/create-remove-token-for-org'.GithubApi.GetOrgSecretInfo
Retrieve details of an organization's secret without revealing the encrypted value. This tool fetches a single organization secret's details from GitHub without disclosing the encrypted value. Use it when you need information about a secret within an organization. Authentication with an access token with `admin:org` scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
organization_secret_name | string | Required | The name of the secret for the organization. It is required to identify the specific secret without revealing its encrypted value. This name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'dependabot/get-org-secret'.GithubApi.GetOrgSelfHostedRunner
Get details of a self-hosted runner for an organization. Fetches information about a specific self-hosted runner configured in a GitHub organization. Authentication with an access token having the `admin:org` scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name (not case sensitive). |
runner_id | integer | Required | Unique integer identifier of the self-hosted runner within the organization. |
Requirements
Output
json— Response from the API endpoint 'actions/get-self-hosted-runner-for-org'.GithubApi.GetOrgWebhookConfiguration
Retrieve webhook configuration for a GitHub organization. Call this tool to get the webhook configuration for a specified organization on GitHub. Useful for checking the webhook's setup details. Requires appropriate access tokens or GitHub App permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The non-case-sensitive name of the GitHub organization. |
webhook_hook_id | integer | Required | The unique identifier of the organization's webhook, provided as an integer. |
Requirements
Output
json— Response from the API endpoint 'orgs/get-webhook-config-for-org'.GithubApi.GetOrgWebhookDetails
Retrieve details of a specific organization webhook. Use this tool to obtain detailed information about a webhook configured in a GitHub organization, including its properties and settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization, not case sensitive. |
webhook_id | integer | Required | The unique identifier for the organization's webhook. This is an integer value used to specify which webhook details to retrieve. |
Requirements
Output
json— Response from the API endpoint 'orgs/get-webhook'.GithubApi.GetPendingDeploymentsForRun
Retrieve pending deployments for a GitHub workflow run. Use this tool to obtain all deployment environments for a specific GitHub workflow run that are awaiting protection rules to pass. Accessible to users with read access to the repository; requires `repo` scope for private repos or `actions:read` permission for GitHub Apps.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
workflow_run_id | integer | Required | The unique identifier of the workflow run to fetch pending deployments for. |
Requirements
Output
json— Response from the API endpoint 'actions/get-pending-deployments-for-run'.GithubApi.GetPreReceiveEnvDownloadStatus
Retrieve the latest download status for a pre-receive environment. Use this tool to check the most recent download status for a pre-receive environment within GitHub Enterprise Administration. It's useful for monitoring or verifying the status separately from other environment data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pre_receive_environment_identifier | integer | Required | The unique identifier for the pre-receive environment to retrieve its download status. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-download-status-for-pre-receive-environment'.GithubApi.GetPreReceiveHook
Retrieve details of a specific pre-receive hook in GitHub Enterprise Admin. This tool is used to get information about a specific pre-receive hook by its ID in GitHub Enterprise. It is helpful for administrators managing repositories who need to view hook configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pre_receive_hook_id | integer | Required | The unique identifier of the pre-receive hook to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-pre-receive-hook'.GithubApi.GetPreReceiveHookForRepo
Retrieve a pre-receive hook for a specific repository. Use this tool to obtain the details of a specific pre-receive hook associated with a GitHub repository. Ideal for administrators managing repository hooks.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pre_receive_hook_id | integer | Required | The unique identifier of the pre-receive hook for the repository. |
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-pre-receive-hook-for-repo'.GithubApi.GetProjectCard
Retrieve details of a specific project card in GitHub. Use this tool to get information about a project card in a GitHub project by specifying the card ID. Useful for retrieving details such as card content, column association, and other metadata.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_card_id | integer | Required | The unique ID of the GitHub project card to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'projects/get-card'.GithubApi.GetPublicSshKeyDetails
Retrieve details for a specified public SSH key. This tool fetches extended details for a single public SSH key of the authenticated user. It requires authentication via Basic Auth or OAuth with 'read:public_key' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ssh_key_identifier | integer | Required | The unique identifier for the public SSH key to retrieve details. |
Requirements
Output
json— Response from the API endpoint 'users/get-public-ssh-key-for-authenticated-user'.GithubApi.GetPublicSshKeys
Retrieve verified public SSH keys for a specified GitHub user. Use this tool to access the verified public SSH keys associated with a GitHub user's account. This information is publicly accessible and can help in identifying trusted keys for secure connections.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub user's handle to retrieve their verified public SSH keys. |
results_page_number | integer | Optional | Specify the page number of results to retrieve for pagination purposes. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum allowed value of 100. |
Requirements
Output
json— Response from the API endpoint 'users/list-public-keys-for-user'.GithubApi.GetPullRequestDetails
Retrieve details of a specific GitHub pull request. Use this tool to obtain comprehensive information about a specified pull request in a GitHub repository, including its mergeability status and commit details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pull_request_number | integer | Required | The unique number identifying the pull request to retrieve details for. |
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | Specifies the account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'pulls/get'.GithubApi.GetPullRequestReviewProtection
Get pull request review protection details for a branch. Fetches details about the required pull request review protection for a specific branch in a GitHub repository. Useful for understanding branch protection rules in repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_name | string | Required | The name of the branch. Cannot contain wildcard characters. For wildcard usage, refer to the GraphQL API. |
repository_name | string | Required | The name of the repository to retrieve pull request review protection details for. This name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. It is not case sensitive and identifies who owns the repository. |
Requirements
Output
json— Response from the API endpoint 'repos/get-pull-request-review-protection'.GithubApi.GetPullRequestStatistics
Retrieve pull request statistics from GitHub Enterprise. Use this tool to obtain statistics related to pull requests from a GitHub Enterprise instance.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-pull-request-stats'.GithubApi.GetRandomGithubZen
Fetch a random Zen of GitHub sentence. Retrieves a random inspirational sentence from GitHub's Zen collection, useful for inspiration or fun.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'meta/get-zen'.GithubApi.GetRemoveTokenForEnterpriseRunner
Generates a token to remove a self-hosted runner from an enterprise. Use this tool to obtain a token for removing a self-hosted runner from an enterprise on GitHub. The token is valid for one hour and requires authentication with an access token having the 'manage_runners:enterprise' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug or ID of the enterprise. Use this to specify the enterprise for which you want to generate a removal token. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/create-remove-token-for-enterprise'.GithubApi.GetRepoAutolinks
Retrieve autolinks for a specific GitHub repository. Use this tool to obtain information about all autolinks configured in a specified GitHub repository. It is only accessible to repository administrators.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. It is case insensitive. |
repository_owner | string | Required | The account owner of the repository. This name is not case sensitive. |
results_page_number | integer | Optional | Specify the page number to retrieve results from when fetching autolinks for a repository. |
Requirements
Output
json— Response from the API endpoint 'repos/list-autolinks'.GithubApi.GetRepoCodeFrequency
Get weekly code frequency stats for a GitHub repository. Fetches a weekly summary of code additions and deletions for a specified GitHub repository, providing insights into development activity.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The GitHub username is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-code-frequency-stats'.GithubApi.GetRepoCommitParticipation
Retrieve weekly commit participation stats for a GitHub repo. This tool fetches the total commit counts for a repository's owner and overall contributors over the last 52 weeks. It helps in understanding the contribution patterns and can determine non-owner contributions by subtracting owner counts from total counts.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository, which is not case sensitive. |
repository_owner | string | Required | The repository account owner on GitHub. Case-insensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-participation-stats'.GithubApi.GetRepoLicense
Fetch the license file of a GitHub repository. This tool retrieves the contents of a repository's license file from GitHub if one is detected. It can handle both raw license content and rendered HTML. Use this tool to understand the licensing terms associated with any given repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'licenses/get-for-repo'.GithubApi.GetRepoNotifications
Retrieve notifications for the user in a specific repository. This tool lists all notifications for the authenticated user in a specified GitHub repository. Use it to keep track of issues, pull requests, and other updates relevant to the user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository, not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
include_read_notifications | boolean | Optional | If `true`, include notifications that have been marked as read. |
results_page_number | integer | Optional | Specify the page number of the results to fetch. Useful for paginating through notifications. |
results_per_page | integer | Optional | Number of notifications to display per page, with a maximum of 100. |
show_only_participation_notifications | boolean | Optional | If `true`, only show notifications where the user is directly participating or mentioned. |
updated_after_timestamp | string | Optional | Show notifications updated after this timestamp. Use ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. |
updated_before | string | Optional | Display notifications updated before this time in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). |
Requirements
Output
json— Response from the API endpoint 'activity/list-repo-notifications-for-authenticated-user'.GithubApi.GetRepoPublicKey
Retrieve the public key for encrypting repository secrets. Use this tool to get the public key necessary for encrypting secrets in a GitHub repository. This is a prerequisite step before creating or updating secrets. Ensure you have the necessary access rights: read access for public repositories, or an access token with the `repo` scope for private ones. GitHub Apps require `secrets` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This value is not case sensitive. Provide the repository name for which you want to retrieve the public key. |
repository_owner | string | Required | The account owner of the repository. Enter a case-insensitive string specifying the owner's account name. |
Requirements
Output
json— Response from the API endpoint 'actions/get-repo-public-key'.GithubApi.GetRepoSecretInfo
Retrieve metadata of a repository secret from GitHub. Fetches information about a specific repository secret using GitHub's Dependabot API. It provides metadata without revealing the secret's encrypted value. Requires an authenticated access token with proper permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository, case insensitive. |
secret_name | string | Required | The name of the secret to retrieve metadata for. Case insensitive. |
Requirements
Output
json— Response from the API endpoint 'dependabot/get-repo-secret'.GithubApi.GetRepositoryAutolink
Retrieve a specific GitHub repository autolink by ID. Use this tool to obtain details of a specific autolink reference configured in a GitHub repository. This is accessible only to repository administrators.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
autolink_id | integer | Required | The unique identifier of the autolink configured in the GitHub repository. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-autolink'.GithubApi.GetRepositoryReadme
Retrieve the preferred README for a GitHub repository. Use this tool to fetch the preferred README of a GitHub repository. It can retrieve the raw content or rendered HTML based on custom media types.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This is case insensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
commit_branch_tag_name | string | Optional | Specify the commit, branch, or tag name. Defaults to the repository's default branch if not provided. |
Requirements
Output
json— Response from the API endpoint 'repos/get-readme'.GithubApi.GetRepositorySecretInfo
Retrieve metadata for a specific GitHub repository secret. This tool retrieves the metadata of a specified secret from a GitHub repository without exposing its encrypted value. It requires authentication with an access token that has the `repo` scope, or GitHub Apps with `secrets` repository permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. Not case sensitive. |
secret_name | string | Required | The name of the secret to retrieve metadata for. |
Requirements
Output
json— Response from the API endpoint 'actions/get-repo-secret'.GithubApi.GetRepositoryStatistics
Retrieve statistics for GitHub repositories. This tool is used to get statistical information about repositories in a GitHub enterprise setting. It should be called when detailed repository stats are needed.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-repo-stats'.GithubApi.GetRepositoryTagProtectionStates
Fetch the tag protection states of a GitHub repository. Call this tool to retrieve the tag protection settings for a specific GitHub repository. This information is available only to repository administrators, providing insights into how tags are protected within the repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. The name is not case sensitive. |
repository_owner | string | Required | The GitHub username of the account owner for the repository. This value is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/list-tag-protection'.GithubApi.GetRepoSubscription
Retrieve subscription status for a GitHub repository. Use this tool to check if you are subscribed to a specific GitHub repository and receive notifications about its activity. It provides the subscription status and additional details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. The name is not case sensitive. |
repository_owner | string | Required | The GitHub username of the repository owner. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'activity/get-repo-subscription'.GithubApi.GetRepoTopics
Retrieve all topics for a specific GitHub repository. Call this tool to get a list of topics associated with a specific repository on GitHub. It can help understand the themes or categories the repository covers.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is not case sensitive. |
page_number | integer | Optional | The page number of results to fetch. Useful for paginating through large data sets. |
results_per_page | integer | Optional | The number of results to fetch per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/get-all-topics'.GithubApi.GetRepoWebhook
Retrieve the webhook configuration for a specific repository. This tool is used to get the details of a webhook configured in a specific GitHub repository. It can be called when you need information about a webhook associated with a given repository, such as its settings and properties.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This value is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
webhook_id | integer | Required | The unique identifier of the webhook to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'repos/get-webhook'.GithubApi.GetRepoWebhookConfig
Get the webhook configuration for a GitHub repository. Use this tool to retrieve the webhook configuration settings for a specific GitHub repository. It requires a valid access token with `read:repo_hook` or `repo` scope, or a GitHub App with `repository_hooks:read` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
hook_identifier | integer | Required | The unique identifier for the webhook. This is required to retrieve the specific webhook configuration for a repository. |
repository_name | string | Required | The name of the GitHub repository. Not case sensitive. |
repository_owner | string | Required | The account owner of the repository. Provide a non-case sensitive username. |
Requirements
Output
json— Response from the API endpoint 'repos/get-webhook-config-for-repo'.GithubApi.GetRequestedReviewersForPr
Retrieve users or teams requested for a pull request review. Use this tool to get the list of users or teams who have been requested to review a specific pull request in a GitHub repository. This is useful for checking pending review tasks.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pull_request_number | integer | Required | The unique identifier for the pull request in a GitHub repository. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'pulls/list-requested-reviewers'.GithubApi.GetRequiredWorkflow
Retrieve a required workflow for a GitHub organization. This tool retrieves information about a required workflow configured in a GitHub organization. It requires authentication with a token having the `read:org` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name. This name is not case sensitive. |
workflow_id | integer | Required | The unique identifier of the workflow to retrieve for the organization. |
Requirements
Output
json— Response from the API endpoint 'actions/get-required-workflow'.GithubApi.GetReviewComments
Retrieve comments for a specific pull request review. Use this tool to obtain comments associated with a specific pull request review in a GitHub repository. Ideal for tracking review discussions and understanding feedback provided by reviewers.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pull_request_number | integer | Required | The number that identifies the pull request to fetch comments from. |
repository_name | string | Required | The name of the GitHub repository. This name is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. It is not case sensitive. |
review_id | integer | Required | The unique identifier of the review for which comments are being fetched. |
result_page_number | integer | Optional | Specify the page number of the results to fetch. Used to navigate paginated results. |
results_per_page | integer | Optional | Specify the number of results per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'pulls/list-comments-for-review'.GithubApi.GetSarifAnalysisInfo
Retrieve SARIF upload status and analysis URL. Use this tool to get information about a SARIF upload, including its status and the URL for detailed analysis. Useful for tracking code scanning results in GitHub repositories. Requires appropriate access tokens or permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This input is case-insensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. This input is not case sensitive. |
sarif_id | string | Required | The SARIF ID obtained after uploading. It is used to retrieve analysis details. |
Requirements
Output
json— Response from the API endpoint 'code-scanning/get-sarif'.GithubApi.GetScimGroupInfo
Retrieve provisioning information for a SCIM group in an enterprise. Use this tool to get detailed provisioning information of a specific SCIM group within an enterprise account. This can be essential for managing and auditing group memberships and access within an organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
scim_group_identifier | string | Required | A unique identifier for the SCIM group to retrieve its provisioning information. |
exclude_attributes | string | Optional | Specify attributes to exclude from the response to speed up retrieval. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-provisioning-information-for-enterprise-group'.GithubApi.GetScimUserInfo
Fetch SCIM user provisioning information. Retrieves information about a SCIM user in an enterprise account. Suitable for obtaining detailed provisioning data of a user within the GitHub enterprise environment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
scim_user_identifier | string | Required | The unique identifier for the SCIM user in the GitHub enterprise environment. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-provisioning-information-for-enterprise-user'.GithubApi.GetSecurityAnalysisSettings
Get security analysis settings for an enterprise. Retrieve code security and analysis settings for a specified enterprise. Requires admin access to the enterprise and an access token with the `admin:enterprise` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug version or ID of the enterprise. Use the enterprise's slug name or its ID to specify it. |
Requirements
Output
json— Response from the API endpoint 'secret-scanning/get-security-analysis-settings-for-enterprise'.GithubApi.GetSelfHostedRunnerGroup
Retrieve a specific self-hosted runner group for an enterprise. Use this tool to get details of a particular self-hosted runner group within an enterprise. Authentication with an access token is required, including the `manage_runners:enterprise` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug of the enterprise name or substitute with the enterprise ID. |
runner_group_identifier | integer | Required | Unique identifier of the self-hosted runner group, required to retrieve specific group details within an enterprise. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-self-hosted-runner-group-for-enterprise'.GithubApi.GetSelfHostedRunnerGroupForOrg
Retrieve a specific self-hosted runner group for an organization. Use this tool to obtain details about a particular self-hosted runner group within an organization on GitHub. Requires authentication with an access token having 'admin:org' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The organization name on GitHub. It is not case sensitive. |
runner_group_identifier | integer | Required | Unique identifier for the self-hosted runner group. It should be an integer. |
Requirements
Output
json— Response from the API endpoint 'actions/get-self-hosted-runner-group-for-org'.GithubApi.GetSelfHostedRunnerInfo
Retrieve details of a self-hosted runner in an enterprise. Fetches information about a specific self-hosted runner configured within an enterprise on GitHub. Requires authentication with an access token having `manage_runners:enterprise` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug version of the enterprise name or the enterprise ID. |
runner_id | integer | Required | The unique identifier of the self-hosted runner to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/get-self-hosted-runner-for-enterprise'.GithubApi.GetSshSigningKeyDetails
Retrieve extended details for an SSH signing key. Use this tool to get detailed information of an SSH signing key for an authenticated GitHub user. Requires authentication with either Basic Authentication or OAuth with `read:ssh_signing_key` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ssh_signing_key_identifier | integer | Required | The unique identifier of the SSH signing key to retrieve details for the authenticated user. |
Requirements
Output
json— Response from the API endpoint 'users/get-ssh-signing-key-for-authenticated-user'.GithubApi.GetTeamBySlug
Retrieve team details using organization and team slug. Use this tool to get detailed information about a specific team in a GitHub organization by providing the organization's name and the team's slug. The slug is a modified version of the team's name, formatted by GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
team_slug | string | Required | The slug of the team name. This is a URL-friendly version, typically all lowercase with special characters and spaces replaced by hyphens. |
Requirements
Output
json— Response from the API endpoint 'teams/get-by-name'.GithubApi.GetTeamDiscussion
Retrieve a specific team discussion from GitHub. Call this tool to get details of a specific discussion on a GitHub team's page. This is useful when you need information about a particular topic discussed within a team. Ensure OAuth access tokens with `read:discussion` scope are used.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
discussion_identifier_number | integer | Required | The unique number identifying the discussion to retrieve. |
organization_name | string | Required | The name of the GitHub organization. This is not case sensitive. |
team_slug | string | Required | The slug of the GitHub team name, used to specify the team. |
Requirements
Output
json— Response from the API endpoint 'teams/get-discussion-in-org'.GithubApi.GetTeamDiscussionReactions
Retrieve reactions to a specific team discussion in a GitHub organization. Use this tool to obtain the reactions to a team discussion within a GitHub organization. It requires an OAuth token with the `read:discussion` scope. Useful for analyzing feedback or participation in team discussions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
discussion_identifier | integer | Required | The number identifying the team discussion to retrieve reactions for. |
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
team_slug | string | Required | The slug of the team's name in the specified GitHub organization. It identifies the team for which reactions are being retrieved. |
reaction_type | string | Optional | Specify the type of reaction to retrieve (e.g., '+1', '-1', 'laugh'). Omit to retrieve all reactions. |
results_page_number | integer | Optional | The page number of the results to fetch. Use to navigate through paginated responses. |
results_per_page | integer | Optional | Specify the number of results per page, maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'reactions/list-for-team-discussion-in-org'.GithubApi.GetTeamsWithPushAccessToBranch
Retrieve teams with push access to a protected branch. Call this tool to get a list of teams that have push access to a specified protected branch in a GitHub repository. Useful for managing and reviewing team permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
branch_name | string | Required | The name of the branch to retrieve teams with push access. Wildcard characters are not allowed. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The GitHub username or organization name that owns the repository. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/get-teams-with-access-to-protected-branch'.GithubApi.GetUserGists
Retrieve a user's public gists from GitHub. This tool is used to list all public gists for a specified GitHub user. It should be called when you want to retrieve code snippets or files shared publicly by the user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub username whose public gists you want to retrieve. |
page_number | integer | Optional | Page number of the gist results to fetch. Used for paginating results. |
results_per_page | integer | Optional | The number of gists to display per page, with a maximum limit of 100. |
updated_after_timestamp | string | Optional | Show notifications updated after the specified timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. |
Requirements
Output
json— Response from the API endpoint 'gists/list-for-user'.GithubApi.GetUserGpgKeyDetails
Retrieve extended details for a user's GPG key. Use this tool to fetch detailed information about a specific GPG key for an authenticated user. Requires authentication via Basic Auth or OAuth with 'read:gpg_key' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gpg_key_identifier | integer | Required | The unique identifier of the GPG key to retrieve details for. |
Requirements
Output
json— Response from the API endpoint 'users/get-gpg-key-for-authenticated-user'.GithubApi.GetUserOrgEvents
Retrieve organization events for an authenticated GitHub user. Use this tool to get the events related to a user's organization activities on GitHub. It requires authentication as the user to access the details of the organization dashboard.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_username | string | Required | The GitHub handle of the user account for whom events are being retrieved. Authentication is required to access user-specific details. |
organization_name | string | Required | The name of the GitHub organization. This parameter is not case sensitive. |
results_page_number | integer | Optional | The specific page of results to retrieve. Provides pagination for fetching events. |
results_per_page | integer | Optional | Specify the number of results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'activity/list-org-events-for-authenticated-user'.GithubApi.GetUserOrgMembershipStatus
Get a user's membership status in an organization. Call this tool to retrieve the membership status of a user within a specified GitHub organization. Requires the authenticated user to be an organization member.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The handle for the GitHub user account to check membership status. |
organization_name | string | Required | The GitHub organization name. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'orgs/get-membership-for-user'.GithubApi.GetUserProjectPermission
Retrieve a user's permission level for an organization project. Use this tool to find out what level of access a specific user has to an organization project on GitHub. This is useful for organization owners or project admins to verify permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub username of the user whose project permission level is being queried. |
project_id | integer | Required | The unique identifier of the GitHub project for which to fetch the user's permission. |
Requirements
Output
json— Response from the API endpoint 'projects/get-permission-for-user'.GithubApi.GetUserReceivedGithubEvents
Retrieve events received by a GitHub user. Fetches events that a specified user has received on GitHub by watching repositories and following users. Access includes private events if authenticated as the user, or public events otherwise.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The handle of the GitHub user account for which to retrieve events. |
result_page_number | integer | Optional | Specifies the page number of results to retrieve from the GitHub events list. |
results_per_page | integer | Optional | Specify the number of results per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'activity/list-received-events-for-user'.GithubApi.GetUserRepos
Retrieve public repositories of a GitHub user. This tool retrieves a list of public repositories for a specified GitHub user. It can also list internal repositories for GitHub AE. Use this tool to explore the projects a user has made publicly available on GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The handle for the GitHub user whose repositories you want to retrieve. |
page_number | integer | Optional | The page number of results to fetch, starting from 1. |
repository_type | string | Optional | Limit results to repositories of the specified type: 'all', 'owner', or 'member'. |
results_per_page | integer | Optional | Specify the number of repository results to be returned per page, up to a maximum of 100. |
sort_order | string | Optional | Specifies the order to sort the repositories. Use 'asc' for ascending and 'desc' for descending order. |
sort_results_by | string | Optional | Specify the property to sort the repository results by. Options: 'created', 'updated', 'pushed', or 'full_name'. |
Requirements
Output
json— Response from the API endpoint 'repos/list-for-user'.GithubApi.GetUserTeamMembershipInOrg
Retrieve a user's team membership status in an organization. Fetches the membership state and role of a specified user within a specific team in an organization on GitHub. Useful for determining if a user is a member of a team, including the role they hold.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_username | string | Required | The GitHub username of the account whose team membership status is being retrieved. This username is not case sensitive. |
organization_name | string | Required | The case-insensitive name of the GitHub organization. |
team_slug | string | Required | The slug of the team name. It uniquely identifies the team within the organization. Case insensitive. |
Requirements
Output
json— Response from the API endpoint 'teams/get-membership-for-user-in-org'.GithubApi.GetWebhookDelivery
Retrieve a specific webhook delivery from a repository. This tool retrieves details of a webhook delivery for a specified repository. Use it when you need to examine the delivery status or contents of a webhook event.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
hook_identifier | integer | Required | The unique identifier of the webhook within a repository. It is an integer value required to specify which webhook's delivery information to retrieve. |
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository, not case sensitive. |
webhook_delivery_id | integer | Required | The unique identifier of the specific webhook delivery to retrieve details for. This is an integer value. |
Requirements
Output
json— Response from the API endpoint 'repos/get-webhook-delivery'.GithubApi.GetWebhookEventDeliveries
Retrieve webhook deliveries for an organization. Call this tool to get a list of webhook deliveries for a specific webhook configured in a GitHub organization. It is useful for monitoring and debugging webhook events.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
webhook_hook_id | integer | Required | The unique identifier of the webhook in the organization. |
include_redeliveries | boolean | Optional | Indicate whether to include repeated webhook deliveries in the results. Set to true to include. |
pagination_start_cursor | string | Optional | A cursor to indicate the starting delivery for fetching the page of deliveries. Useful for pagination purposes. |
results_per_page | integer | Optional | Specifies the number of webhook deliveries to be returned per page (maximum 100). |
Requirements
Output
json— Response from the API endpoint 'orgs/list-webhook-deliveries'.GithubApi.GetWorkflowAccessLevel
Determine external workflow access level for a repository. Utilize this tool to find out what level of access workflows outside of a specified internal or private repository have to its actions and reusable workflows. This tool is applicable only to internal and private repositories and requires appropriate authentication.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository (case insensitive). |
repository_owner | string | Required | The account owner of the repository. This is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/get-workflow-access-to-repository'.GithubApi.GetWorkflowArtifact
Retrieve a specific artifact from a GitHub workflow run. Use this tool to access a specific artifact from a GitHub repository's workflow run. Requires appropriate permissions and access token for private repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
artifact_identifier | integer | Required | The unique identifier for the artifact to retrieve from a workflow run. |
repository_name | string | Required | The name of the repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. Not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/get-artifact'.GithubApi.GetWorkflowRunAttemptLogsUrl
Retrieve a URL to download workflow run attempt logs. Returns a redirect URL to download log files for a specific workflow run attempt. This URL expires in 1 minute and requires appropriate repository access permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. It is not case sensitive and identifies the repository for which to retrieve logs. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
workflow_attempt_number | integer | Required | The specific attempt number of the workflow run to fetch logs for. |
workflow_run_id | integer | Required | The unique identifier of the workflow run. Used to specify which workflow's logs to download. |
Requirements
Output
json— Response from the API endpoint 'actions/download-workflow-run-attempt-logs'.GithubApi.GithubCreateIssueComment
Create a comment on a GitHub issue. Use this tool to add a comment to a specific issue in a GitHub repository. Ensure you manage content creation speed to avoid secondary rate limiting.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_content | string | Required | The text content of the comment to be added to the issue. |
issue_identifier | integer | Required | The unique number identifying the GitHub issue. |
repository_name | string | Required | The name of the repository where the issue is located. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. Not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'issues/create-comment'.GithubApi.GithubManageEnvironment
Create or update a GitHub environment with protection rules. Use this tool to create or update a GitHub environment, applying protection rules like required reviewers. Ensure you authenticate with an access token with the `repo` scope. GitHub Apps need `administration:write` permission for the repository. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The account owner of the repository. The name is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the GitHub repository. This value is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
environment_name | string | Optional | The name of the GitHub environment to create or update. This should be a string that accurately identifies the environment within the repository. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'repos/create-or-update-environment'.GithubApi.GithubRerunWorkflowJob
Re-run a job in a GitHub workflow. This tool re-runs a specific job and its dependent jobs within a GitHub workflow run. Use it when you need to restart a job that has failed or requires re-execution. Requires authentication with an access token having `repo` scope or `actions:write` permission for GitHub Apps.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
job_identifier | integer | Required | The unique integer identifier of the job to be re-run. This is required to specify which job in the workflow needs to be restarted. |
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
enable_debug_logging | boolean | Optional | Set to true to enable debug logging for the re-run. |
Requirements
Output
json— Response from the API endpoint 'actions/re-run-job-for-workflow-run'.GithubApi.GithubSearchUsers
Search for GitHub users based on specific criteria. This tool allows you to find GitHub users by using various search parameters like login, email, name, repositories, and followers count. It can return up to 100 users per page and includes options for retrieving text match metadata for highlighted results.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
search_query | string | Required | Contains search keywords and qualifiers to find GitHub users. Supports multiple qualifiers to narrow the search. See GitHub's query format documentation for details. |
page_number | integer | Optional | Page number to fetch results, used for accessing subsequent pages of search results. Maximum supported is 100. |
results_per_page | integer | Optional | The number of GitHub user results returned per page, up to a maximum of 100. |
sort_by_criterion | string | Optional | Sort the search results by 'followers', 'repositories', or 'joined'. Defaults to best match if not specified. |
sort_order | string | Optional | Specifies the order of search results: 'desc' for highest matches or 'asc' for lowest. Requires 'sort'. |
Requirements
Output
json— Response from the API endpoint 'search/users'.GithubApi.GrantPushAccessGithubBranch
Grant push access to specified users for a GitHub branch. This tool is used to grant push access to specific users for a protected branch in a GitHub repository. It is applicable in scenarios involving public repositories with GitHub Free and GitHub Free for organizations, as well as public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
repository_owner | string | Optional | The account owner of the repository. The name is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
repository_name | string | Optional | The name of the repository. It is not case sensitive. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
branch_name | string | Optional | The name of the branch to grant push access. Cannot contain wildcard characters. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'repos/add-user-access-restrictions'.GithubApi.InitiateUserMigration
Begin the creation of a user migration archive. This tool is used to initiate the generation of a migration archive for an authenticated GitHub user. Call this when you want to start the process of exporting your data for transfer or backup purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_list | array<string> | Required | A list of repository names to be included in the migration. Expect an array of strings representing repository names. |
exclude_attachments | boolean | Optional | Set to true to exclude attachments from the migration. |
exclude_attributes | array<string> | Optional | List of attributes to exclude from the API response for better performance. |
exclude_metadata | boolean | Optional | Set to true to exclude metadata and include only git source in the migration. |
exclude_owner_projects | boolean | Optional | Set to true to exclude projects owned by the organization or users from the migration process. |
exclude_releases | boolean | Optional | Set to true to exclude releases from the migration process. |
exclude_repository_git_data | boolean | Optional | Set to true to exclude repository git data from the migration. |
lock_repositories | boolean | Optional | Set to true to lock the repositories at the start of the migration. |
org_metadata_only | boolean | Optional | Set to true to include only organization metadata. Repositories array will be empty and other flags are ignored. |
Requirements
Output
json— Response from the API endpoint 'migrations/start-for-authenticated-user'.GithubApi.LabelRunnerForRepo
Add custom labels to a repository's self-hosted runner. Use this tool to add custom labels to a self-hosted runner in a specified GitHub repository. Authentication with an access token with the `repo` scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
custom_labels_to_add | array<string> | Required | The names of the custom labels to add to the self-hosted runner. Provide as an array of strings. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. Case insensitive. |
runner_id | integer | Required | Unique identifier for the self-hosted runner in the repository. |
Requirements
Output
json— Response from the API endpoint 'actions/add-custom-labels-to-self-hosted-runner-for-repo'.GithubApi.LinkExternalGroupToTeam
Link an external IDP group to a GitHub team. Creates a connection between a GitHub team and an external identity provider group. Use this tool when you need to manage team membership through your identity provider using GitHub Enterprise Managed Users.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
external_group_id | integer | Required | The ID of the external group to be linked with the GitHub team. |
organization_name | string | Required | The GitHub organization name. This value is not case sensitive. |
team_slug | string | Required | The slug of the team name to connect with an external group. It is case insensitive. |
Requirements
Output
json— Response from the API endpoint 'teams/link-external-idp-group-to-team-for-org'.GithubApi.ListActionsEnabledOrgsEnterprise
List organizations with GitHub Actions enabled in an enterprise. This tool lists organizations selected to have GitHub Actions enabled within a specified enterprise. It requires the enterprise permission policy for `enabled_organizations` to be set to `selected`. Authentication with an access token with the `admin:enterprise` scope is necessary.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug or ID of the enterprise to identify it for listing organizations with GitHub Actions enabled. |
results_page_number | integer | Optional | Specifies which page of results to retrieve, helpful for navigating through multiple pages. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise'.GithubApi.ListActionsEnabledRepos
Retrieve repositories enabled for GitHub Actions in an organization. Use this tool to list all repositories where GitHub Actions are enabled within a specific organization. Ensure the organization permission policy for `enabled_repositories` is set to `selected`. Authentication with a token having `admin:org` scope or a GitHub App with `administration` permission is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization for which to list GitHub Actions-enabled repositories. This field is not case sensitive. |
result_page_number | integer | Optional | Page number of the results to fetch. Use for paginating through results. |
results_per_page | integer | Optional | The maximum number of repositories to return per page (max 100). |
Requirements
Output
json— Response from the API endpoint 'actions/list-selected-repositories-enabled-github-actions-organization'.GithubApi.ListBranchesForCommit
Retrieve branches for a specific commit in a GitHub repository. Call this tool to find all branches where the given commit SHA is the HEAD or the latest commit for the branch in a GitHub repository. Useful for tracking branch status in different GitHub plans.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
commit_sha | string | Required | The SHA hash of the commit used to identify specific branches where this commit is the HEAD in a GitHub repository. |
repository_name | string | Required | The name of the GitHub repository. Not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository, not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/list-branches-for-head-commit'.GithubApi.ListCheckRunAnnotations
Retrieve annotations for a GitHub check run. Use this tool to fetch a list of annotations associated with a specific check run in a GitHub repository. Requires appropriate permissions on private repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
check_run_identifier | integer | Required | The ID of the check run to retrieve annotations for. |
repository_name | string | Required | The name of the GitHub repository (case insensitive). |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
results_page_number | integer | Optional | Specify the page number to fetch annotations from. Used for paginating results. |
results_per_page | integer | Optional | The number of results per page to return, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'checks/list-annotations'.GithubApi.ListCheckRunsForCommitRef
Lists check runs for a given commit reference. Fetches check runs associated with a specific commit reference (SHA, branch, or tag) in a repository. Requires appropriate permissions: 'checks:read' for private repositories and 'repo' scope for OAuth Apps on private repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
commit_reference | string | Required | The commit reference, which can be a SHA, branch name, or tag name, to list check runs for. |
repository_name | string | Required | The name of the repository. Input is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is not case sensitive and refers to the GitHub username or organization name. |
application_id | integer | Optional | Optional integer identifier for a GitHub App to filter check runs created by that app. |
check_run_name | string | Optional | Specify a name to filter check runs by their name. |
check_run_status | string | Optional | Filter check runs by specifying the status ('queued', 'in_progress', 'completed'). |
filter_by_completion_timestamp | string | Optional | Specify 'latest' to return the most recent check runs or 'all' to include all completed check runs. |
results_page_number | integer | Optional | The specific page number of results to retrieve, used for pagination. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'checks/list-for-ref'.GithubApi.ListCheckSuitesForRef
List check suites for a specific commit reference. Retrieve a list of check suites for a given commit reference (SHA, branch, or tag name). Ensure the appropriate permissions are in place for accessing private or public repositories. This tool is useful for checking the status of checks related to a specific commit.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
commit_reference | string | Required | The commit ref, which can be a SHA, branch name, or tag name. Used to list check suites. |
repository_name | string | Required | The name of the repository to query. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository, case insensitive. |
github_app_id_filter | integer | Optional | Filter check suites by the GitHub App ID to narrow results to relevant checks associated with a specific application. |
results_page_number | integer | Optional | Specifies which page of results to fetch. Useful for paginating through a list of check suites. |
results_per_page | integer | Optional | Specify the number of results to return per page. The maximum is 100. |
specific_check_name | string | Optional | Specify the name of the check run to filter the results. |
Requirements
Output
json— Response from the API endpoint 'checks/list-suites-for-ref'.GithubApi.ListChildTeams
Retrieves child teams of a specified team in an organization. Use this tool to get a list of child teams under a specific team within an organization on GitHub. It requires specifying the team by its slug and the organization name.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The organization's name. It's case insensitive and used to specify which organization's team structure to query. |
team_identifier_slug | string | Required | The slug of the team name for which to list child teams. This is used to uniquely identify the team within the organization. |
page_number | integer | Optional | The page number to retrieve in the list of child teams. Use to paginate the results. |
results_per_page | integer | Optional | Specify the number of results to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'teams/list-child-in-org'.GithubApi.ListCodeownersErrors
Identify syntax errors in a repository's CODEOWNERS file. This tool checks a repository's CODEOWNERS file for any syntax errors. It's useful for ensuring that the file is correctly formatted and functioning as intended. Use this tool to diagnose issues with the CODEOWNERS file when configuring repository access controls.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. It is not case sensitive. |
version_reference | string | Optional | Specify the branch, tag, or commit name to select the CODEOWNERS file version. Defaults to the repository's default branch if not provided. |
Requirements
Output
json— Response from the API endpoint 'repos/codeowners-errors'.GithubApi.ListCodeScanningAlertInstances
Retrieve instances of a specific code scanning alert. Use this tool to list all instances of a given code scanning alert in a GitHub repository. This is useful for monitoring or analyzing alert occurrences. Requires appropriate access tokens with `security_events` or `public_repo` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
alert_identifier | integer | Required | The unique number identifying the code scanning alert. Find this number at the end of the alert URL in GitHub or in the `GET /repos/{owner}/{repo}/code-scanning/alerts` response. |
repository_name | string | Required | The name of the repository, not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
git_reference | string | Optional | The Git reference for the results you want to list. Format as `refs/heads/<branch_name>` or `<branch_name>` for branches, and `refs/pull/<number>/merge` for pull requests. |
page_number | integer | Optional | Page number of the results to fetch. Use for navigating large sets of alert instances. |
results_per_page | integer | Optional | Specify the number of results to return per page (maximum 100). |
Requirements
Output
json— Response from the API endpoint 'code-scanning/list-alert-instances'.GithubApi.ListCodeScanningAlerts
Retrieve code scanning alerts for a repository. Retrieve a list of code scanning alerts for a specific GitHub repository, using an access token with the necessary permissions. Useful for monitoring code security issues in a repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository for which to list code scanning alerts. This name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
alert_state_filter | string | Optional | Filter code scanning alerts by state. Valid options are 'open', 'closed', 'dismissed', and 'fixed'. |
code_scanning_tool_guid | string | Optional | The GUID of a code scanning tool to filter alerts by this tool only. This can't be used with 'tool_name'. |
code_scanning_tool_name | string | Optional | Specify the name of the code scanning tool to filter alerts by this tool only. Use either `tool_name` or `tool_guid`, but not both. |
filter_by_severity | string | Optional | Specify the severity of code scanning alerts to filter, using values like 'critical', 'high', 'medium', 'low', 'warning', 'note', or 'error'. |
git_reference_for_scan_results | string | Optional | The Git reference for listing results. Use `refs/heads/<branch>` or `<branch>` for branches, `refs/pull/<number>/merge` for pull requests. |
results_page_number | integer | Optional | Page number to fetch results from. Use this to navigate through paginated results. |
results_per_page | integer | Optional | The number of results per page, up to a maximum of 100. |
sort_by_property | string | Optional | Property to sort the results by, either 'created' or 'updated'. |
sort_direction | string | Optional | The direction to sort the results. Choose 'asc' for ascending or 'desc' for descending order. |
Requirements
Output
json— Response from the API endpoint 'code-scanning/list-alerts-for-repo'.GithubApi.ListCommitCommentReactions
Retrieve reactions for a GitHub commit comment. This tool fetches the list of reactions associated with a specific commit comment on GitHub. It should be called when you need to view reactions to a particular commit comment within a repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_id | integer | Required | The unique identifier for the commit comment you want to retrieve reactions for. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive and identifies the repository within the specified owner's account. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
reaction_type | string | Optional | Filter results to show only a specific reaction type. Omit to list all reactions. |
results_page_number | integer | Optional | Page number of the results to fetch, used for pagination. |
results_per_page | integer | Optional | Specifies the number of results to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'reactions/list-for-commit-comment'.GithubApi.ListCommitComments
Retrieve comments for a specific commit in a GitHub repo. This tool fetches all comments associated with a specific commit in a given GitHub repository. It should be called when you need to view discussions or feedback on a specific code change identified by its commit SHA.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
commit_sha | string | Required | The SHA string representing the specific commit to retrieve comments for. |
repository_name | string | Required | The case-insensitive name of the GitHub repository. |
repository_owner | string | Required | The account owner of the repository. This is not case sensitive and identifies the GitHub user or organization that owns the repository. |
results_page_number | integer | Optional | The page number of results to fetch for commit comments. Useful for paginating through large sets of comments. |
results_per_page | integer | Optional | The number of comments to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-comments-for-commit'.GithubApi.ListDependabotAlertsForOrganization
Lists Dependabot alerts for an organization. This tool lists Dependabot alerts for a specified organization. It requires you to be an organization owner or security manager with an appropriate access token. GitHub Apps need **Dependabot alerts** read permission. Use for monitoring security alerts related to dependencies.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The organization name for which to list Dependabot alerts. This name is not case sensitive. |
alert_severity_filter | string | Optional | Comma-separated severities to filter alerts. Options: `low`, `medium`, `high`, `critical`. |
alert_states | string | Optional | Comma-separated list of alert states to filter by. Options: `dismissed`, `fixed`, `open`. |
deprecated_first_results_page_size | integer | Optional | **Deprecated**. Use `per_page` with `after` instead. Specifies the number of results per page, up to 100, starting from the first matching result. Avoid using with `last`. |
deprecated_last_results_per_page | integer | Optional | **Deprecated**. Use this to specify the number of results per page (max 100) from the last matching result. Cannot be used with 'first'. |
ecosystem_list | string | Optional | Comma-separated ecosystems to filter alerts. Options: composer, go, maven, npm, nuget, pip, pub, rubygems, rust. |
package_names | string | Optional | A comma-separated list of package names. Only alerts for these specified packages will be returned. |
paginate_after_cursor | string | Optional | A cursor indicating the point to continue the listing from, based on the Link header. |
results_before_cursor | string | Optional | A cursor indicating to search for Dependabot alerts before this position. |
results_per_page | integer | Optional | Specifies the number of Dependabot alerts to return per page, with a maximum of 100. |
sort_by_property | string | Optional | Sort results by `created` (alert creation) or `updated` (state change). |
sort_direction | string | Optional | The order to sort the results, either ascending ('asc') or descending ('desc'). |
vulnerable_dependency_scope | string | Optional | Specify the scope of the vulnerable dependency as either 'development' or 'runtime'. Only alerts with this scope will be returned. |
Requirements
Output
json— Response from the API endpoint 'dependabot/list-alerts-for-org'.GithubApi.ListDependabotAlertsForRepo
Retrieve Dependabot alerts for a specific repository. Use this tool to get a list of Dependabot alerts for a given GitHub repository. It requires an access token with `security_events` scope for private repositories or `public_repo` scope for public repositories. Ideal for monitoring security vulnerabilities in repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. This is case insensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. This name is not case sensitive. |
alert_states_filter | string | Optional | A comma-separated list of alert states to filter results by. Options: `dismissed`, `fixed`, `open`. |
before_cursor | string | Optional | Cursor indicating the position to fetch results before this point. |
cursor_after | string | Optional | A cursor to fetch results after a specified point. Helps in pagination by retrieving alerts following the given cursor position. |
deprecated_page_number | integer | Optional | **Deprecated**. Use to specify the page number of results to fetch. Prefer using `before` or `after` cursors. |
ecosystem_filter | string | Optional | Comma-separated list of ecosystems to filter alerts by: composer, go, maven, npm, nuget, pip, pub, rubygems, rust. |
fetch_deprecated_first_page_results | integer | Optional | **Deprecated**. Number of results per page (max 100), starting from the first result. Avoid using with `last`. Use `per_page` and `after` instead. |
fetch_last_page_results | integer | Optional | **Deprecated**: Use `per_page` with `before` instead. Fetch results per page from the last result (max 100). |
manifest_paths | string | Optional | Comma-separated list of full manifest paths to filter alerts by those manifests. |
package_names | string | Optional | A comma-separated list of package names. Only alerts for these packages will be returned. |
results_per_page | integer | Optional | Specifies the number of results to be returned per page, with a maximum limit of 100. |
severity_filter | string | Optional | Provide a comma-separated list of severities: `low`, `medium`, `high`, `critical`. Filters alerts by these severities. |
sort_by | string | Optional | Sort alerts by `created` or `updated` date. `Created` means when the alert was created, `updated` means when the alert's state last changed. |
sort_results_direction | string | Optional | Specify the order to sort the results: `asc` for ascending or `desc` for descending. |
vulnerable_dependency_scope | string | Optional | Specifies the scope of the vulnerable dependency to filter alerts. Options: 'development' or 'runtime'. |
Requirements
Output
json— Response from the API endpoint 'dependabot/list-alerts-for-repo'.GithubApi.ListDeploymentBranchPolicies
Lists deployment branch policies for a GitHub environment. Use this tool to retrieve the branch policies associated with a specific environment in a GitHub repository. Accessible with read access; requires 'repo' scope for private repos.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
environment_name | string | Required | The name of the environment for which to list branch policies. This should match an existing environment in the repository. |
repository_name | string | Required | The name of the repository, not case sensitive. |
repository_owner | string | Required | The account owner of the repository. Input is not case sensitive. |
result_page_number | integer | Optional | The page number of the results to retrieve. Use this to navigate through paginated results. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-deployment-branch-policies'.GithubApi.ListEnterpriseCodeScanningAlerts
Retrieve code scanning alerts for enterprise repositories. This tool is used to list code scanning alerts for the default branch of all eligible repositories within an enterprise. It requires the user to be a member of the enterprise and have an access token with the necessary scopes (`repo` or `security_events`). Use this tool to monitor security alerts across repositories owned by organizations you manage as a security manager.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug version or ID of the enterprise. Used to specify which enterprise's alerts to list. |
alert_state_filter | string | Optional | Filter code scanning alerts by their state. Valid values are 'open', 'closed', 'dismissed', 'fixed'. |
code_scanning_tool_guid | string | Optional | The GUID of a code scanning tool to filter alerts. Use either `code_scanning_tool_guid` or `code_scanning_tool_name`, but not both. |
code_scanning_tool_name | string | Optional | The name of a code scanning tool to filter results. Use either this or `tool_guid`, but not both. |
query_results_before_cursor | string | Optional | The cursor from the Link header to search for alerts before this point. |
results_page_number | integer | Optional | Specify the page number to fetch results from. Used for pagination of code scanning alerts. |
results_per_page | integer | Optional | The number of alerts to return per page, with a maximum of 100. |
sort_direction | string | Optional | Specifies the sorting order of the results, either ascending ('asc') or descending ('desc'). |
sort_property | string | Optional | Specify the property to sort the results by. Valid values are 'created' or 'updated'. |
start_after_cursor | string | Optional | Specifies the cursor to return results after this point. Utilize the cursor from the Link header. |
Requirements
Output
json— Response from the API endpoint 'code-scanning/list-alerts-for-enterprise'.GithubApi.ListEnterpriseDependabotAlerts
Get Dependabot alerts for enterprise-owned repositories. This tool retrieves a list of Dependabot alerts for repositories owned by a specified enterprise on GitHub. It is used by members of the enterprise with appropriate access tokens. Alerts are restricted to organizations where the user is an owner or security manager.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug or ID of the enterprise. This identifies the enterprise for which alerts are listed. |
alert_severities | string | Optional | A comma-separated list of alert severities to filter results. Options: `low`, `medium`, `high`, `critical`. |
alert_state_filter | string | Optional | Comma-separated list of alert states to filter by: `dismissed`, `fixed`, `open`. Only alerts with these states will be returned. |
before_cursor | string | Optional | Specify a cursor to fetch results before this point. Use the format provided in the Link header. |
cursor_after | string | Optional | A cursor to return results after a specific point. Use as given in the Link header for pagination. |
ecosystem_list | string | Optional | A comma-separated list of ecosystems to filter alerts. Options include: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`. |
number_of_results_per_page_starting_first | integer | Optional | **Deprecated**. Specifies the number of results per page (maximum 100), beginning with the first matching result. Avoid using with `number_of_results_per_page_starting_last`. Use `results_per_page` with `paging_after_cursor` instead. |
package_filter | string | Optional | A comma-separated list of package names. Specify to filter alerts by these packages. |
results_per_page | integer | Optional | The number of results to return per page, with a maximum of 100. |
results_per_page_starting_from_last | integer | Optional | **Deprecated**. Number of results per page (max 100), starting from the last matching result. Avoid using with 'results_per_page_starting_from_first'. |
sort_direction | string | Optional | Specifies the sorting order of the results, either ascending ('asc') or descending ('desc'). |
sort_property_for_alerts | string | Optional | Specifies the property to sort Dependabot alerts by. Options are 'created' (when the alert was created) or 'updated' (when the alert's state last changed). |
vulnerable_dependency_scope | string | Optional | The scope of the vulnerable dependency to filter alerts by. Options: 'development', 'runtime'. |
Requirements
Output
json— Response from the API endpoint 'dependabot/list-alerts-for-enterprise'.GithubApi.ListExternalGroupsForOrg
Retrieve external groups available in a GitHub organization. Fetches a list of external groups for a specified organization. Use the `display_name` parameter to filter groups by name, and `per_page` for pagination.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
group_name_filter | string | Optional | Filter results to include only groups with names containing this text. |
pagination_token | integer | Optional | Token to specify the starting point for the next set of results. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum value of 100. |
Requirements
Output
json— Response from the API endpoint 'teams/list-external-idp-groups-for-org'.GithubApi.ListFollowedUsers
Lists the people the authenticated user follows.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
results_page_number | integer | Optional | Specify the page number of the results you want to fetch. |
results_per_page | integer | Optional | The number of results to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'users/list-followed-by-authenticated-user'.GithubApi.ListFollowers
Retrieve followers of the authenticated user on GitHub. This tool retrieves a list of people who are following the authenticated GitHub user. Use it to access follower information for engagement or insights.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
results_page_number | integer | Optional | Specifies which page of followers to fetch. Used for pagination. |
results_per_page | integer | Optional | Specify the number of followers to list per page (maximum 100). |
Requirements
Output
json— Response from the API endpoint 'users/list-followers-for-authenticated-user'.GithubApi.ListGistComments
Retrieve comments for a specific GitHub gist. This tool is used to fetch comments associated with a specified GitHub gist, identified by its gist ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gist_identifier | string | Required | Provide the unique identifier of the gist for which comments are to be listed. |
result_page_number | integer | Optional | Specifies the page number to fetch from the list of gist comments. |
results_per_page | integer | Optional | The number of comments to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'gists/list-comments'.GithubApi.ListGistCommits
Retrieve the commit history of a specified GitHub gist. Use this tool to obtain a list of all commits associated with a specific gist on GitHub. Ideal for tracking changes and updates made to the gist content over time.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gist_identifier | string | Required | The unique identifier of the gist for which to list commits. |
results_page_number | integer | Optional | Specify the page number of results to fetch for pagination. Useful for accessing more than the default result set. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'gists/list-commits'.GithubApi.ListGistForks
Retrieve a list of forks for a specific gist. Use this tool to get information about the forks of a specific gist on GitHub by providing the gist ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
gist_unique_identifier | string | Required | The unique identifier of the gist to retrieve forks information from. |
results_page_number | integer | Optional | Specify the page number of the results you want to fetch. Used for pagination. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum of 100 allowed. |
Requirements
Output
json— Response from the API endpoint 'gists/list-forks'.GithubApi.ListGithubActionsCaches
Retrieve the list of GitHub Actions caches for a repository. This tool fetches the list of GitHub Actions caches for a specified repository. It requires authentication with an access token having the 'repo' scope, or GitHub Apps must have the 'actions:read' permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This value is not case sensitive. |
cache_key_or_prefix | string | Optional | Explicit key or prefix to identify the cache. Use this to filter caches by specific keys or prefixes. |
git_reference | string | Optional | Specify the Git reference for the results to list. Use `refs/heads/<branch>` for branches or `refs/pull/<number>/merge` for pull requests. |
results_page_number | integer | Optional | The page number of the results to fetch, used for pagination. |
results_per_page | integer | Optional | Specify the number of results to return per page, with a maximum of 100. |
sort_by_property | string | Optional | The property to sort results by. Options are 'created_at', 'last_accessed_at', or 'size_in_bytes'. |
sort_direction | string | Optional | Specify 'asc' for ascending or 'desc' for descending order of results. |
Requirements
Output
json— Response from the API endpoint 'actions/get-actions-cache-list'.GithubApi.ListGithubAppAccessibleRepos
List repositories accessible to a GitHub app installation. Use this tool to retrieve a list of repositories that a GitHub app installation can access. Requires an installation access token for authentication.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
results_page_number | integer | Optional | Page number of the results to fetch. |
results_per_page | integer | Optional | The number of repositories to include on each page of results. Maximum is 100. |
Requirements
Output
json— Response from the API endpoint 'apps/list-repos-accessible-to-installation'.GithubApi.ListGithubAppInstallations
Retrieve installations of a GitHub app using a JWT. Use this tool to get a list of all installations for a GitHub app. The response includes details about the permissions granted to each installation. This is useful for managing and auditing app installations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_outdated | string | Optional | Include or exclude outdated installations in the results. Pass 'true' to include them. |
notifications_updated_since | string | Optional | Specify a timestamp in ISO 8601 format to filter installations updated after this time. Format: `YYYY-MM-DDTHH:MM:SSZ`. |
results_page_number | integer | Optional | Specify the page number of the results you want to retrieve, allowing pagination through the results. Useful for fetching specific subsets of data. |
results_per_page | integer | Optional | Specify the number of results to return per page. Maximum is 100. |
Requirements
Output
json— Response from the API endpoint 'apps/list-installations'.GithubApi.ListGithubCheckRunsForSuite
List check runs for a GitHub check suite using its ID. This tool retrieves a list of check runs for a specified check suite in a GitHub repository. It requires appropriate permissions or scopes depending on the repository type.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
check_suite_identifier | integer | Required | The unique identifier of the check suite to list its check runs. |
repository_name | string | Required | The name of the GitHub repository to query. It is not case sensitive. |
repository_owner | string | Required | The account owner's username of the repository. Case insensitive. |
check_run_name | string | Optional | Returns check runs with the specified name. |
check_run_status | string | Optional | Specify the status of the check runs to be returned. Options: 'queued', 'in_progress', 'completed'. |
filter_by_completion_time | string | Optional | Filters check runs by their `completed_at` timestamp. Use 'latest' for the most recent runs or 'all' for all runs. |
result_page_number | integer | Optional | Specifies which page of the results to fetch, for paginated data. |
results_per_page | integer | Optional | Sets the number of results to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'checks/list-for-suite'.GithubApi.ListGithubCustomRoles
Retrieve custom repository roles for a GitHub organization. Retrieve a list of available custom repository roles in a GitHub organization if authenticated as an organization owner or administrator with the appropriate permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id | string | Required | The unique identifier of the GitHub organization to list custom roles for. |
Requirements
Output
json— Response from the API endpoint 'orgs/list-custom-roles'.GithubApi.ListGithubDeployKeys
Retrieve deploy keys for a specific GitHub repository. This tool is used to retrieve the list of deploy keys associated with a specified GitHub repository, identified by its owner and repository name. It's useful for managing access controls and integrations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive and identifies which repository's deploy keys are listed. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
result_page_number | integer | Optional | Specify the page number of the deploy keys results to fetch. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-deploy-keys'.GithubApi.ListGithubDeployments
Retrieve deployments from a GitHub repository. Use this tool to retrieve a list of deployments for a specific GitHub repository, with filtering options available through query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
commit_sha | string | Optional | The commit SHA recorded at deployment creation time for filtering deployments. |
deployment_environment | string | Optional | Specify the environment that was deployed to, such as 'staging' or 'production'. |
deployment_task_name | string | Optional | The specific task name for the deployment, like `deploy` or `deploy:migrations`. |
repository_ref | string | Optional | The name of the ref. This can be a branch, tag, or SHA to filter deployments by. |
results_page_number | integer | Optional | Specifies which page of deployment results to fetch. Used for pagination to navigate through multiple pages of results. |
results_per_page | integer | Optional | The number of results to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-deployments'.GithubApi.ListGithubDeploymentStatuses
Retrieve deployment statuses for a specified GitHub deployment. This tool is used to access and list the deployment statuses for a specific deployment on GitHub. It should be called when there is a need to review the status updates related to a deployment, and is accessible to users with pull access on the repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
deployment_id | integer | Required | The unique identifier of the deployment to retrieve statuses for. Must be an integer. |
repository_name | string | Required | The case-insensitive name of the GitHub repository. |
repository_owner | string | Required | The GitHub username or organization that owns the repository. This is not case sensitive. |
results_page_number | integer | Optional | The specific page number of deployment statuses to fetch. Used for pagination. |
results_per_page | integer | Optional | The number of results to return per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-deployment-statuses'.GithubApi.ListGithubEmojis
Lists all available GitHub emojis. Use this tool to retrieve a list of all emojis that can be used on GitHub Enterprise Server.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'emojis/get'.GithubApi.ListGithubEnvironmentSecrets
Retrieve secrets for a GitHub environment. Use this tool to list all secrets in a specific GitHub environment without revealing their encrypted values. Authentication with a token having `repo` scope is required. Best used for managing or auditing environment secrets.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
environment_name | string | Required | The name of the environment whose secrets are to be listed. This is necessary to identify the specific environment in the repository. |
repository_unique_identifier | integer | Required | The unique identifier of the repository. Required to fetch the environment secrets. |
results_page_number | integer | Optional | Page number of the results to fetch. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum allowable value of 100. |
Requirements
Output
json— Response from the API endpoint 'actions/list-environment-secrets'.GithubApi.ListGithubEnvironmentVariables
Retrieve environment variables from a GitHub repository's environment. Use this tool to list all environment variables for a specific environment within a GitHub repository. Requires authentication with a token having 'repo' scope or as a GitHub App with 'environments:read' permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
environment_name | string | Required | Specify the environment name to retrieve its variables within a GitHub repository. |
repository_id | integer | Required | The unique identifier of the GitHub repository to retrieve environment variables from. |
results_page_number | integer | Optional | Specify the page number to retrieve results from. Use for paginated results. |
results_per_page | integer | Optional | Specifies the number of environment variables to return per page, with a maximum allowed value of 30. |
Requirements
Output
json— Response from the API endpoint 'actions/list-environment-variables'.GithubApi.ListGithubIssueAssignees
Retrieve available assignees for GitHub issues. This tool is used to list the available assignees for issues in a specified GitHub repository. Call this tool when you need to know who can be assigned to issues in a repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository, case insensitive. |
repository_owner | string | Required | The owner of the repository. Input is not case sensitive. |
results_page_number | integer | Optional | Page number of the results to fetch. Use to paginate through results. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum limit of 100. |
Requirements
Output
json— Response from the API endpoint 'issues/list-assignees'.GithubApi.ListGithubIssueComments
Retrieve comments for a specific GitHub issue. Use this tool to get all comments for a specific issue in a GitHub repository. It’s useful when you need to review discussions or updates on a particular issue.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issue_number | integer | Required | The unique number identifying the GitHub issue to retrieve comments for. |
repository_name | string | Required | The name of the GitHub repository (case insensitive). |
repository_owner | string | Required | The account owner of the repository. Provide the username as a case-insensitive string. |
page_number | integer | Optional | Specify the page number of results to fetch when listing comments for pagination purposes. |
results_per_page | integer | Optional | The number of comments to retrieve per page, maximum 100. |
since_timestamp | string | Optional | Show notifications updated after this time in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`). |
Requirements
Output
json— Response from the API endpoint 'issues/list-comments'.GithubApi.ListGithubIssueEvents
Retrieve events for a specific GitHub issue. This tool fetches a list of events related to a particular issue in a specified GitHub repository. It is useful for tracking changes, updates, and interactions associated with an issue.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issue_number | integer | Required | The number that identifies the issue within the repository. This is required to fetch the related events. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. This input is case insensitive. |
results_page_number | integer | Optional | The page number to fetch results from when listing issue events. |
results_per_page | integer | Optional | The number of issue events to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'issues/list-events'.GithubApi.ListGithubIssues
Get issues assigned to you across all GitHub repositories. This tool retrieves a list of issues that are assigned to the authenticated user from all visible repositories on GitHub, including owned, member, and organization repositories. It can be used to monitor workload and track tasks across projects. Note that the results may include pull requests as well, identified by a `pull_request` key.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
include_collaborative_repositories | boolean | Optional | Include issues from collaborative repositories. Set to true to filter issues where you have collaborative access. |
include_owned_repositories | boolean | Optional | Set to true to include issues from repositories owned by the authenticated user. |
include_pull_requests | boolean | Optional | Set to true to include pull requests in the issues list. |
issue_filter_type | string | Optional | Specifies the type of issues to return: assigned, created, mentioned, subscribed, repos, or all. |
issue_labels | string | Optional | Comma-separated list of label names to filter issues. Example: 'bug,ui,@high'. |
issue_state | string | Optional | Specifies the state of issues to retrieve: `open`, `closed`, or `all`. |
organization_repositories | boolean | Optional | Include issues from organization repositories when set to true. If false, include issues from all repositories. |
page_number | integer | Optional | The specific page of results to fetch. Use this for pagination to navigate through large list of issues. |
results_per_page | integer | Optional | The number of results per page, maximum is 100. |
sort_direction | string | Optional | Specifies the order of sorting for the results. Use 'asc' for ascending and 'desc' for descending. |
sort_issues_by | string | Optional | Specify the criteria to sort issues by: 'created', 'updated', or 'comments'. |
updated_since_timestamp | string | Optional | Show issues updated after this timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. |
Requirements
Output
json— Response from the API endpoint 'issues/list'.GithubApi.ListGithubIssuesForRepo
Retrieve open issues from a GitHub repository. This tool lists open issues and pull requests in a specified GitHub repository. It is useful for tracking unresolved issues and ongoing work. The response includes both issues and pull requests.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository to fetch issues from. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
assignee_filter | string | Optional | Filter issues by assignee. Use a username, `none` for unassigned, or `*` for any assignee. |
issue_creator | string | Optional | The GitHub username of the person who created the issue. |
issue_labels | string | Optional | Comma separated list of label names to filter issues, e.g., 'bug,ui,@high'. |
issue_state | string | Optional | Indicates the state of issues to retrieve: 'open', 'closed', or 'all'. |
mentioned_user | string | Optional | A GitHub username to filter issues where this user is mentioned. |
milestone_identifier | string | Optional | Filter issues by milestone. Use an integer for a specific milestone, "*" for any milestone, or "none" for no milestones. |
results_page_number | integer | Optional | Specifies which page of results to fetch. Use an integer value to navigate through paginated results. |
results_per_page | integer | Optional | Number of results per page, up to a maximum of 100. |
sort_direction | string | Optional | The direction to sort the results by. Use 'asc' for ascending and 'desc' for descending. |
sort_issues_by | string | Optional | Specify sorting criteria for issues: 'created', 'updated', or 'comments'. |
updated_since_timestamp | string | Optional | Only show issues or pull requests updated after this timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. |
Requirements
Output
json— Response from the API endpoint 'issues/list-for-repo'.GithubApi.ListGithubMilestones
Retrieve milestones from a GitHub repository. Use this tool to list all milestones for a specified GitHub repository. Ideal for managing project timelines and tracking progress.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. The name is not case sensitive. |
milestone_state | string | Optional | Denotes the state of milestones to fetch: 'open', 'closed', or 'all'. |
results_page_number | integer | Optional | The page number of milestones results to fetch. |
results_per_page | integer | Optional | The number of results to display per page (maximum 100). |
sort_direction | string | Optional | The direction for sorting milestones: 'asc' for ascending or 'desc' for descending order. |
sort_milestones | string | Optional | Criteria to sort milestones by. Options include `due_on` for due date or `completeness` for progress. |
Requirements
Output
json— Response from the API endpoint 'issues/list-milestones'.GithubApi.ListGithubOrganizations
Retrieve a list of GitHub organizations. Fetches all organizations from GitHub Enterprise Server in the order they were created. Supports pagination using the 'since' parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_id_since | integer | Optional | Only return organizations with an ID greater than this value to paginate results. |
results_per_page | integer | Optional | Specifies the number of results to return per page, with a maximum value of 100. |
Requirements
Output
json— Response from the API endpoint 'orgs/list'.GithubApi.ListGithubOrgSecrets
Retrieve Dependabot organization secrets from GitHub. Use this tool to list all Dependabot secrets of a GitHub organization without revealing their encrypted values. Requires authentication with an `admin:org` scope token or a GitHub App with `dependabot_secrets` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name. It is not case sensitive. |
results_page_number | integer | Optional | Page number to fetch results from in the paginated list of organization secrets. |
results_per_page | integer | Optional | The number of secrets to list per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'dependabot/list-org-secrets'.GithubApi.ListGithubPagesBuilds
Retrieve GitHub Pages build statuses for a repository. Call this tool to get a list of GitHub Pages build statuses for a specific repository on GitHub Enterprise Server. Useful for tracking build history and status.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository to fetch the Pages build statuses for. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository, case-insensitive. |
results_page_number | integer | Optional | The page number of the results to fetch. Use this to navigate through paginated results. |
results_per_page | integer | Optional | The number of results per page, with a maximum of 100 allowed. |
Requirements
Output
json— Response from the API endpoint 'repos/list-pages-builds'.GithubApi.ListGithubProjectColumns
Retrieve columns of a specific GitHub project. Use this tool to get a list of columns for a specified GitHub project. It's useful when you need to know the structure or organization of a GitHub project board.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_identifier | integer | Required | The unique identifier of the GitHub project to list columns for. |
page_number | integer | Optional | The specific page number of the results to fetch from the GitHub project columns list. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'projects/list-columns'.GithubApi.ListGithubPublicEmails
Retrieve publicly visible GitHub emails for the authenticated user. This tool retrieves the publicly visible email addresses for the authenticated GitHub user. It's useful for applications needing to display or verify public contact details. Requires the `user:email` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
results_page_number | integer | Optional | The page number of email results to retrieve. Use this to navigate through paginated email results. |
results_per_page | integer | Optional | The number of email results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'users/list-public-emails-for-authenticated-user'.GithubApi.ListGithubPublicKeys
Retrieve GitHub Enterprise Admin public keys. Use this tool to obtain a list of public keys available for GitHub Enterprise Admin. Ideal for administrators needing to access or audit public keys.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_keys_accessed_since | string | Optional | Specify a timestamp to only list public keys accessed after this time. Use ISO 8601 format. |
page_number_to_fetch | integer | Optional | The specific page number of results to retrieve. |
results_per_page | integer | Optional | The number of results to display per page. Maximum allowed is 100. Use to limit the amount of data retrieved per call. |
sort_direction | string | Optional | The direction to sort the results: 'asc' for ascending or 'desc' for descending. |
sort_order | string | Optional | Criteria for sorting results. Options: 'created', 'updated', 'accessed'. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-public-keys'.GithubApi.ListGithubPullRequestFiles
Retrieve files changed in a GitHub pull request. Use this tool to list up to 3000 files altered in a specific pull request on GitHub. Useful for reviewing code changes or analyzing file modifications in a repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pull_request_number | integer | Required | The unique number identifying the pull request. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The GitHub username of the repository owner. This is not case sensitive. |
results_page_number | integer | Optional | The page number of the results to fetch, used for pagination. |
results_per_page | integer | Optional | The number of files to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'pulls/list-files'.GithubApi.ListGithubPullRequestReviews
Retrieve reviews for a specific GitHub pull request. Use this tool to fetch a chronological list of reviews for a specified pull request within a GitHub repository. This can help in understanding the review history and comments made on the pull request.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pull_request_number | integer | Required | The unique identifier for the specific pull request to retrieve reviews for. |
repository_name | string | Required | The name of the GitHub repository, not case sensitive. |
repository_owner | string | Required | The GitHub username or organization name of the repository owner. Not case sensitive. |
results_page_number | integer | Optional | The page number of the pull request reviews to fetch. Used for pagination. |
results_per_page | integer | Optional | The number of reviews per page (maximum 100). Specify an integer value. |
Requirements
Output
json— Response from the API endpoint 'pulls/list-reviews'.GithubApi.ListGithubReleaseAssets
Retrieve a list of assets for a GitHub release. This tool fetches and returns a list of assets associated with a specific release in a GitHub repository. It should be called when you need to access the files or resources attached to a particular release of a GitHub project.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
release_identifier | integer | Required | The unique identifier for the GitHub release to fetch assets from. |
repository_name | string | Required | The name of the GitHub repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. This is not case sensitive. |
page_number | integer | Optional | The specific page number to fetch from the list of release assets. Useful for navigation in paginated results. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum value of 100. This controls pagination. |
Requirements
Output
json— Response from the API endpoint 'repos/list-release-assets'.GithubApi.ListGithubReleaseReactions
Retrieve reactions for a GitHub release. Call this tool to get a list of all reactions to a specific release on GitHub. Useful for analyzing user feedback or engagement with a particular release.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
release_identifier | integer | Required | The unique integer identifier of the GitHub release. |
repository_name | string | Required | The name of the GitHub repository. Case sensitivity is not required. |
repository_owner | string | Required | The account owner of the GitHub repository. This name is not case sensitive. |
reaction_type_filter | string | Optional | Specify a reaction type to filter results. Options are '+1', 'laugh', 'heart', 'hooray', 'rocket', 'eyes'. Leave empty to get all reactions. |
results_page_number | integer | Optional | Page number of the results to fetch for paginated reactions. |
results_per_page | integer | Optional | The number of results to display per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'reactions/list-for-release'.GithubApi.ListGithubRepoArtifacts
Retrieve all artifacts for a GitHub repository. Use this tool to get a list of all artifacts for a specific GitHub repository. It requires read access to the repository, and if private, an access token with the `repo` scope is needed. GitHub Apps require `actions:read` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository to retrieve artifacts from. This input is not case sensitive. |
repository_owner | string | Required | The username or organization name of the repository owner. This is not case sensitive. |
filter_artifacts_by_name | string | Optional | Filters artifacts by providing an exact match for the artifact name. Use a string to specify the artifact name. |
result_page_number | integer | Optional | Specify the page number of results to fetch for paginated artifact listings. |
results_per_page | integer | Optional | Specify the number of artifacts to return per page, with a maximum limit of 100. |
Requirements
Output
json— Response from the API endpoint 'actions/list-artifacts-for-repo'.GithubApi.ListGithubRepoBranches
Retrieve branches from a specific GitHub repository. Use this tool to get a list of all branches in a specified GitHub repository. It requires specifying the repository owner and name.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is not case-sensitive. |
results_page_number | integer | Optional | Page number of the results to fetch from the list of branches. |
results_per_page | integer | Optional | Specify the number of branch results per page (maximum 100). |
return_only_protected_branches | boolean | Optional | Set to `true` to return only protected branches, `false` for only unprotected, or omit to return all branches. |
Requirements
Output
json— Response from the API endpoint 'repos/list-branches'.GithubApi.ListGithubRepoCollaborators
Retrieve collaborators of a GitHub repository. Use this tool to get the list of collaborators for a GitHub repository, including organization members and outside collaborators. Useful for understanding who has access and their roles. Requires specific authentication permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. This name is not case sensitive. |
filter_by_affiliation | string | Optional | Filter collaborators by affiliation: 'outside', 'direct', or 'all'. |
filter_by_permission | string | Optional | Specify the permission level ('pull', 'triage', 'push', 'maintain', 'admin') to filter the repository collaborators. Returns all collaborators if not specified. |
results_page_number | integer | Optional | The page number of results to retrieve when querying the list of collaborators. |
results_per_page | integer | Optional | The number of results per page to return, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-collaborators'.GithubApi.ListGithubRepoContributors
Retrieve contributors for a specific GitHub repository. This tool lists contributors to a specified GitHub repository, sorted by the number of commits in descending order. It captures contributions by GitHub user, including associated email addresses, but may include anonymous contributors without GitHub user details due to performance optimization limits.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. This value is not case sensitive. |
include_anonymous_contributors | string | Optional | Set to `1` or `true` to include anonymous contributors in the results. |
results_page_number | integer | Optional | Specifies the page number of contributors to fetch. Use this to navigate through paginated results. Each page contains a subset of contributors, with 'per_page' controlling the number of contributors per page. |
results_per_page | integer | Optional | The number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-contributors'.GithubApi.ListGithubRepoEvents
Retrieve GitHub repository events. Use this tool to list events from a specific GitHub repository. It helps track recent activities such as pushes, issues, and other event types.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. The name is not case sensitive. |
repository_owner_name | string | Required | The username of the account owner of the repository, case insensitive. |
results_page_number | integer | Optional | Specify the page number of the repository events to fetch. Useful for paginating results. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum limit of 100. |
Requirements
Output
json— Response from the API endpoint 'activity/list-repo-events'.GithubApi.ListGithubRepoForks
Fetches the list of forks for a specified GitHub repository. This tool retrieves a list of forks for a given GitHub repository, identified by its owner and name. It should be called when you need to obtain information about the forks of a particular repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is not case sensitive and specifies whose repository to list forks from. |
results_page_number | integer | Optional | Specifies the page number for paginated results when listing forks. |
results_per_page | integer | Optional | The number of results to return per page, with a maximum of 100. |
sort_order | string | Optional | The order to sort the forks. Options: 'newest', 'oldest', 'stargazers', or 'watchers'. |
Requirements
Output
json— Response from the API endpoint 'repos/list-forks'.GithubApi.ListGithubRepoIssueEvents
Retrieve events for issues in a GitHub repository. Use this tool to get a list of events related to issues for a specific GitHub repository. It's useful for tracking changes and actions performed on issues.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | Specify the account owner of the GitHub repository. The name is not case sensitive. |
results_page_number | integer | Optional | Specifies the page number of the issue events results to fetch from the repository. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'issues/list-events-for-repo'.GithubApi.ListGithubRepoSecretAlerts
Retrieve secret scanning alerts for a GitHub repository. Call this tool to get a list of secret scanning alerts for a specified GitHub repository. It requires administrator access and a personal access token with proper scopes (repo or security_events). Suitable for monitoring sensitive data exposure in repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. The name is not case sensitive. |
alerts_state_filter | string | Optional | Filter alerts by their state: `open` or `resolved`. Specify to list only alerts in a specific state. |
cursor_before_event | string | Optional | Search for events only before this cursor. Leave empty to get the initial cursor. |
events_after_cursor | string | Optional | A cursor for paginated results to fetch events occurring after this point. Use an empty value to receive the initial cursor. |
filter_by_secret_type | string | Optional | Comma-separated list of secret types to return. By default, all secret types are included. |
results_page_number | integer | Optional | Specifies the page number of the secret scanning alerts to retrieve. Use this to paginate results. |
results_per_page | integer | Optional | Specifies the number of secret scanning alerts to return per page, with a maximum of 100 items. |
secret_alert_resolutions_filter | string | Optional | Comma-separated resolutions to filter alerts. Valid values: `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted`, `used_in_tests`. |
sort_direction | string | Optional | Specifies the direction to sort the results ('asc' for ascending, 'desc' for descending). |
sort_results_by_property | string | Optional | Specifies the property to sort alerts: use 'created' for creation date, or 'updated' for last update or resolution date. |
Requirements
Output
json— Response from the API endpoint 'secret-scanning/list-alerts-for-repo'.GithubApi.ListGithubRepoTags
Retrieve tags for a specified GitHub repository. Use this tool to get a list of all tags for a particular GitHub repository. It's helpful when you need to see available versions or releases in the repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository to retrieve tags from. This is not case sensitive. |
repository_owner | string | Required | The GitHub username or organization that owns the repository. Case insensitive. |
page_number | integer | Optional | The page number to fetch the results from for the list of repository tags. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-tags'.GithubApi.ListGithubRepoVariables
Retrieve all variables for a specified GitHub repository. Use this tool to list all variables associated with a specific GitHub repository. Requires authentication with an access token having the 'repo' scope or a GitHub App with 'actions_variables:read' permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository, case insensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
page_number | integer | Optional | Page number to fetch in the list of repository variables. Use for paginating results. |
results_per_page | integer | Optional | Specify the number of results to return per page, with a maximum of 30. |
Requirements
Output
json— Response from the API endpoint 'actions/list-repo-variables'.GithubApi.ListGithubRepoWorkflows
Retrieve GitHub workflows in a repository. This tool retrieves the list of workflows for a specified GitHub repository. It requires read access to the repository. For private repositories, an access token with the `repo` scope is needed, and GitHub Apps must have `actions:read` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This field is not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. Case insensitive. |
results_page_number | integer | Optional | The page number for pagination, used to fetch specific sets of results. |
results_per_page | integer | Optional | The number of workflow results to display per page, with a maximum limit of 100. |
Requirements
Output
json— Response from the API endpoint 'actions/list-repo-workflows'.GithubApi.ListGithubRunnerBinariesForOrg
Retrieve downloadable binaries for GitHub runner application. This tool lists the binaries for the GitHub runner application that can be downloaded and run for a specified organization. Authentication with an access token having the `admin:org` scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. The organization name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/list-runner-applications-for-org'.GithubApi.ListGithubUserPublicEvents
Retrieve a GitHub user's public events. This tool retrieves the list of public events for a specified GitHub user. Use it to check user activity on GitHub, such as recent contributions and interactions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub user's handle to retrieve public events for. |
page_number | integer | Optional | The page number of the results to retrieve. Use to navigate through paginated results. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'activity/list-public-events-for-user'.GithubApi.ListGithubUsers
Retrieve a list of all GitHub users by signup order. This tool retrieves a list of all users from GitHub Enterprise Server, including both personal and organization accounts, sorted by their signup date. Pagination is controlled using the 'since' parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
results_per_page | integer | Optional | The number of results to return per page, with a maximum of 100 allowed. |
user_id_threshold | integer | Optional | A user ID. Only return users with an ID greater than this number. |
Requirements
Output
json— Response from the API endpoint 'users/list'.GithubApi.ListGithubWebhookDeliveries
Fetch webhook delivery events for a specific GitHub repository. Use this tool to retrieve a list of webhook deliveries for a specific webhook configured in a GitHub repository. It is useful for monitoring and debugging webhook events.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository (case insensitive). |
repository_owner | string | Required | The account owner of the repository. Not case sensitive. |
webhook_hook_id | integer | Required | The unique identifier of the webhook. This is necessary to fetch the specific webhook deliveries for the repository. |
include_redelivered_events | boolean | Optional | Include redelivered webhook events in the results if set to true. |
pagination_start_cursor | string | Optional | The starting point for fetching the page of deliveries. Use the `link` header for next/previous page cursors. |
results_per_page | integer | Optional | The maximum number of webhook delivery results to fetch per page, up to 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-webhook-deliveries'.GithubApi.ListGithubWorkflowJobs
Fetches jobs for a specific GitHub workflow run. Use this tool to retrieve jobs associated with a GitHub workflow run. Requires read access to the repository. For private repositories, an access token with the `repo` scope is needed. GitHub Apps must have the `actions:read` permission. Parameters can be used to filter results.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. It is not case sensitive and identifies whose account owns the repository. |
workflow_run_id | integer | Required | The unique identifier of the GitHub workflow run to fetch jobs for. |
job_filter_by_completion_time | string | Optional | Filter jobs by their `completed_at` timestamp. Use 'latest' for the most recent execution or 'all' for all executions. |
results_page_number | integer | Optional | Page number for paginated results to fetch from the workflow jobs list. |
results_per_page | integer | Optional | Specify the number of job results to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'actions/list-jobs-for-workflow-run'.GithubApi.ListGithubWorkflowRuns
Retrieve all workflow runs for a GitHub repository. This tool retrieves a list of all workflow runs for a specified GitHub repository. It can be used to track the status and history of workflows in the repository. Works with repositories you have read access to. For private repositories, an access token with the 'repo' scope is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository (case insensitive). |
repository_owner | string | Required | The GitHub username or organization name that owns the repository. It is case-insensitive. |
actor_username | string | Optional | Specify the username of the user whose workflow runs you want to retrieve. Use the login of the user who initiated the run. |
branch_name | string | Optional | Specify the branch name to filter workflow runs associated with that branch. |
check_suite_id | integer | Optional | Returns workflow runs with the specified check suite ID. |
filter_by_head_sha | string | Optional | Only returns workflow runs associated with the specified commit SHA (head_sha). |
omit_pull_requests | boolean | Optional | If true, pull requests are excluded from the workflow runs response. |
results_page_number | integer | Optional | Page number of the results to fetch, used for paginating results. |
results_per_page | integer | Optional | The number of results to return per page, with a maximum limit of 100. |
triggering_event | string | Optional | Specify the event that triggers the workflow run, such as 'push', 'pull_request', or 'issue'. |
workflow_created_date_range | string | Optional | Specify a date-time range to filter workflow runs by creation date. Use GitHub's specific date syntax for format. |
workflow_run_status | string | Optional | Specifies the desired status or conclusion of the workflow runs to retrieve, such as 'success', 'in_progress', etc. |
Requirements
Output
json— Response from the API endpoint 'actions/list-workflow-runs-for-repo'.GithubApi.ListGitignoreTemplates
Retrieve all available .gitignore templates from GitHub. Use this tool to obtain a list of all .gitignore templates that can be used when creating a new repository on GitHub. This can help in setting up repositories with the appropriate exclusions.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'gitignore/get-all-templates'.GithubApi.ListGitMatchingRefs
Retrieve Git references matching a specific name pattern. This tool returns an array of Git references from a repository that match a specified name. It supports branches and tags, and can return refs that start with the given pattern if no exact match is found. It includes all references, such as notes and stashes, when no specific ref is provided.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
reference_pattern | string | Required | The pattern to match against Git references (e.g., heads/branch or tags/tag). Leave empty to retrieve all references. |
repository_name | string | Required | The name of the repository to search for references. This name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. Specify the username or organization name that owns the repository. |
Requirements
Output
json— Response from the API endpoint 'git/list-matching-refs'.GithubApi.ListGitRepoSecrets
Retrieve a list of secrets in a GitHub repository. This tool lists all secrets available in a specified GitHub repository without revealing their encrypted values. It requires authentication with an access token with the 'repo' scope or GitHub Apps permission 'dependabot_secrets'.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
results_page_number | integer | Optional | Specifies the page number of results to retrieve from the repository secrets list. |
results_per_page | integer | Optional | The number of secret results to display per page, maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'dependabot/list-repo-secrets'.GithubApi.ListGlobalWebhooks
Retrieve a list of global webhooks from GitHub Enterprise. Use this tool to obtain a list of all global webhooks configured in a GitHub Enterprise environment. Ideal for administrators managing hooks across the entire enterprise.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
page_number | integer | Optional | Specify the page number of the results to fetch. This is used to navigate through paginated results. |
results_per_page | integer | Optional | The number of results to include in each page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-global-webhooks'.GithubApi.ListGpgKeysForUser
Retrieve public GPG keys for a GitHub user. Use this tool to list the public GPG keys associated with a GitHub user. This information is publicly accessible and can be used to verify the integrity of a user's signed content.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub username of the account to retrieve GPG keys for. |
page_number | integer | Optional | Page number of the results to fetch. Used for pagination. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'users/list-gpg-keys-for-user'.GithubApi.ListIssueCommentReactions
Retrieve reactions for a GitHub issue comment. This tool retrieves the list of reactions for a specific comment on an issue in a GitHub repository. It should be called when you need to know how users have reacted to a particular issue comment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_id | integer | Required | The unique identifier for the specific issue comment whose reactions are to be listed. |
repository_name | string | Required | The name of the repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This value is not case sensitive. |
reaction_type | string | Optional | Specify a single reaction type to filter results. Use values like '+1', '-1', 'laugh', etc. Omit to list all reactions. |
results_page_number | integer | Optional | Page number of results to fetch from the reactions list. |
results_per_page | integer | Optional | The number of reactions to retrieve per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'reactions/list-for-issue-comment'.GithubApi.ListIssueComments
Fetch comments for all issues in a repository. Use this tool to retrieve all comments from issues in a specified GitHub repository. Comments are ordered by ascending ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository, not case sensitive. |
results_page_number | integer | Optional | The page number of results to fetch for issue comments in a repository. |
results_per_page | integer | Optional | Specify the number of results to display per page, up to a maximum of 100. |
sort_direction | string | Optional | Sets the sorting order, `asc` for ascending or `desc` for descending, used with `sort`. |
sort_property | string | Optional | The property to sort the issue comments by. Use 'created' for when the repo was starred or 'updated' for last push. |
updated_after_timestamp | string | Optional | Filter comments updated after this timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. |
Requirements
Output
json— Response from the API endpoint 'issues/list-comments-for-repo'.GithubApi.ListIssueReactions
Retrieve reactions from a GitHub issue. This tool retrieves the list of reactions for a specified issue in a GitHub repository. It should be called when you need to understand the community's reactions to a particular issue.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issue_number | integer | Required | The number that identifies the issue in the GitHub repository. |
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
reaction_type_to_filter | string | Optional | Filter reactions by a specific type (e.g., '+1', 'heart'). Omit to list all reactions. |
results_page_number | integer | Optional | Specify the page number of results to fetch. Useful for pagination through large result sets. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'reactions/list-for-issue'.GithubApi.ListLabelsForMilestone
Retrieve labels for issues in a specific milestone on GitHub. Use this tool to get a list of labels applied to issues within a specific milestone in a GitHub repository. Ideal for tracking or categorizing issues based on milestone labels.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
milestone_number | integer | Required | The number that uniquely identifies the milestone in the repository. |
repository_name | string | Required | The name of the repository for which to list milestone labels. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
results_page_number | integer | Optional | Specify the page number of results to fetch for listing milestone labels. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum limit of 100. |
Requirements
Output
json— Response from the API endpoint 'issues/list-labels-for-milestone'.GithubApi.ListLabelsForRunner
Retrieve all labels for a self-hosted runner in an enterprise. Use this tool to get a list of all labels associated with a specific self-hosted runner within an enterprise on GitHub. Authentication with an access token having `manage_runners:enterprise` scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_slug_or_id | string | Required | The slug or ID of the enterprise for identifying self-hosted runner. |
runner_id | integer | Required | Unique identifier of the self-hosted runner for which to list labels. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise'.GithubApi.ListLabelsOnGithubIssue
Retrieve all labels associated with a GitHub issue. Use this tool to get all labels on a specific GitHub issue by providing the repository owner, repository name, and issue number.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
issue_number | integer | Required | The unique identifier for the GitHub issue you wish to retrieve labels for. |
repository_name | string | Required | The name of the repository. It is not case sensitive and identifies where the issue is located. |
repository_owner | string | Required | The account owner of the repository. Provide a non-case-sensitive string. |
results_page_number | integer | Optional | The page number of results to fetch from the GitHub API for an issue's labels. |
results_per_page | integer | Optional | Number of labels to retrieve per page, maximum is 100. |
Requirements
Output
json— Response from the API endpoint 'issues/list-labels-on-issue'.GithubApi.ListLinkedExternalGroups
Retrieve connections between a GitHub team and external groups. Use this tool to list connections between a specific GitHub team and external identity provider groups within an organization. Ideal for managing team membership using Enterprise Managed Users for GitHub Enterprise Cloud.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
team_slug | string | Required | Slug of the team name to identify the specific GitHub team. |
Requirements
Output
json— Response from the API endpoint 'teams/list-linked-external-idp-groups-to-team-for-org'.GithubApi.ListOrgAccessRunnerGroup
List organizations with access to a self-hosted runner group. Retrieves a list of organizations that have access to a specific self-hosted runner group in an enterprise. Requires authentication with a token that has 'manage_runners:enterprise' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_slug_or_id | string | Required | The slug or ID of the enterprise. Used to identify the specific enterprise context for the runner group. |
runner_group_id | integer | Required | Unique identifier for the self-hosted runner group. |
page_number | integer | Optional | Specify the page number of results to fetch. Useful for pagination in large datasets. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise'.GithubApi.ListOrganizationIssuesForUser
Retrieve issues and pull requests for a user in an organization. Call this tool to list all issues and pull requests assigned to the authenticated user within a specific organization on GitHub. This tool returns both issues and pull requests, identifiable by the `pull_request` key. It is useful for tracking user-specific tasks within an organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
issue_filter | string | Optional | Specifies the type of issues to return: 'assigned', 'created', 'mentioned', 'subscribed', 'all', or 'repos'. |
issue_labels | string | Optional | Comma-separated list of label names to filter issues. Example: `bug,ui,@high`. |
issues_state | string | Optional | Specify the state of issues to return: 'open', 'closed', or 'all'. |
result_page_number | integer | Optional | Page number of results to fetch, used for pagination. Starts from 1. |
results_per_page | integer | Optional | The number of results to display per page (maximum 100). |
sort_criteria | string | Optional | Defines the attribute to sort the issues by. Options are 'created', 'updated', or 'comments'. |
sort_direction | string | Optional | The direction to sort the results by. Accepted values are 'asc' for ascending and 'desc' for descending. |
updated_since | string | Optional | Filter to show notifications updated after this timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. |
Requirements
Output
json— Response from the API endpoint 'issues/list-for-org'.GithubApi.ListOrganizationMemberships
Retrieve organization memberships for the authenticated user. This tool retrieves a list of organization memberships for the authenticated user on GitHub, detailing their involvement in various organizations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
membership_state | string | Optional | Filter memberships by state: 'active' or 'pending'. Returns both if unspecified. |
results_page_number | integer | Optional | Specify the page number of results to fetch, for pagination. |
results_per_page | integer | Optional | Number of results per page. Maximum allowed is 100. |
Requirements
Output
json— Response from the API endpoint 'orgs/list-memberships-for-authenticated-user'.GithubApi.ListOrganizationProjects
Retrieve a list of projects for a given organization on GitHub. Use this tool to obtain a list of projects within a specified GitHub organization. It returns an error if projects are disabled or if access is unauthorized.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The case-insensitive name of the GitHub organization for which to list projects. |
project_state | string | Optional | Specifies the state of projects to return: 'open', 'closed', or 'all'. |
results_page_number | integer | Optional | Specifies the page number of the results to fetch for organization projects. |
results_per_page | integer | Optional | The number of project results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'projects/list-for-org'.GithubApi.ListOrganizationRepositories
Retrieve repositories for a specific organization on GitHub. Fetches a list of repositories belonging to a specified organization on GitHub. Admin permissions or ownership may be required to access certain repository details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
page_number | integer | Optional | Page number of the results to fetch, used for pagination. |
repository_type | string | Optional | Specify the type of repositories to return, such as 'all', 'public', 'private', etc. Note: 'internal' is unsupported with an installation access token. |
results_per_page | integer | Optional | The number of repository results to display per page, with a maximum limit of 100. |
sort_order | string | Optional | Specifies the sorting order of the results. Use 'asc' for ascending or 'desc' for descending. |
sort_property | string | Optional | Specifies the property to sort the repository results by, such as created, updated, pushed, or full_name. |
Requirements
Output
json— Response from the API endpoint 'repos/list-for-org'.GithubApi.ListOrganizationSecrets
Retrieve all organization secrets without values. This tool fetches a list of all secrets available in a GitHub organization without revealing their encrypted values. It requires authentication with an access token possessing the `admin:org` scope. Ideal for managing and reviewing organization secrets.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name to list secrets for. This name is not case-sensitive. |
page_number | integer | Optional | Page number of the results to fetch for pagination purposes. |
results_per_page | integer | Optional | Specify the number of secrets to list per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'actions/list-org-secrets'.GithubApi.ListOrganizationTeams
Retrieve teams visible to the user in a GitHub organization. Use this tool to list all teams within a specified GitHub organization that the authenticated user can see.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name. It is not case sensitive. |
results_page_number | integer | Optional | Page number of the results to fetch from the list of teams. |
results_per_page | integer | Optional | Specify the number of results per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'teams/list'.GithubApi.ListOrganizationWebhooks
Retrieve the webhooks for a specific organization on GitHub. Call this tool to get a list of configured webhooks for a specified GitHub organization. Useful for checking webhook integrations and statuses.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name. This parameter is case insensitive. |
result_page_number | integer | Optional | The specific page number of results to retrieve from the list of organization webhooks. |
results_per_page | integer | Optional | The number of webhook results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'orgs/list-webhooks'.GithubApi.ListOrgCodeScanningAlerts
Retrieve code scanning alerts for an organization's repositories. This tool lists code scanning alerts for the default branch of all eligible repositories within a specified organization. It requires the user to be an owner or security manager of the organization, and access tokens with the necessary scopes (`repo`, `security_events`, or `public_repo` for public repositories).
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. This field is not case sensitive. |
alert_severity | string | Optional | Specifies the severity of code scanning alerts to be returned. Acceptable values include 'critical', 'high', 'medium', 'low', 'warning', 'note', and 'error'. |
alert_state | string | Optional | Filter code scanning alerts by their state: 'open', 'closed', 'dismissed', or 'fixed'. |
code_scanning_tool_guid | string | Optional | The GUID of a specific code scanning tool. Use this to filter alerts by the tool. Must not use with `tool_name`. |
cursor_before | string | Optional | A cursor used to fetch results occurring before this point in the data timeline. |
filter_by_tool_name | string | Optional | Specify the name of a code scanning tool to filter results. Only alerts from this tool will be listed. Ensure not to use `tool_guid` if this is specified. |
results_after_cursor | string | Optional | A cursor indicating the point after which to retrieve results. Used for pagination. |
results_page_number | integer | Optional | The page number of the results to fetch from the list of code scanning alerts. |
results_per_page | integer | Optional | The number of results per page, with a maximum limit of 100. |
sort_direction | string | Optional | Specifies the sort order of the results. Use 'asc' for ascending or 'desc' for descending. |
sort_results_by | string | Optional | Specifies the property by which to sort the results. Options are 'created' or 'updated'. |
Requirements
Output
json— Response from the API endpoint 'code-scanning/list-alerts-for-org'.GithubApi.ListOrgMembers
Retrieve members of a GitHub organization. Use this tool to list all users who are members of a specified GitHub organization, including both concealed and public members if authenticated.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization to list members from. It is not case sensitive. |
filter_members | string | Optional | Filter the list of members. Use '2fa_disabled' to list members without two-factor authentication. |
member_role_filter | string | Optional | Filter members by their role in the organization ('all', 'admin', 'member'). |
page_number | integer | Optional | Page number of the results to fetch. Use this to navigate through paginated results. |
results_per_page | integer | Optional | Number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'orgs/list-members'.GithubApi.ListOrgOutsideCollaborators
Retrieve outside collaborators for a GitHub organization. Use this tool to fetch a list of users who are outside collaborators for a specified GitHub organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name, not case sensitive. |
filter_outside_collaborators | string | Optional | Specify '2fa_disabled' to filter for collaborators without two-factor authentication, or 'all' for all collaborators. |
result_page_number | integer | Optional | Specify the page number to fetch results from the list of outside collaborators. |
results_per_page | integer | Optional | Specify the number of results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'orgs/list-outside-collaborators'.GithubApi.ListOrgPreReceiveHooks
Retrieve pre-receive hooks for a GitHub organization. Use this tool to list all pre-receive hooks that are enabled, testing, or configurable at an organization level in GitHub. It excludes globally disabled hooks with no downstream configuration options.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case-sensitive. |
page_number | integer | Optional | Page number of the results to fetch. Use this to navigate through paginated results. |
results_per_page | integer | Optional | The number of results to return per page. The maximum allowed is 100. |
sort_direction | string | Optional | The direction to sort the results by. Accepts 'asc' or 'desc'. |
sort_order | string | Optional | Specify the sort order for the response: options are 'created', 'updated', or 'name'. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-pre-receive-hooks-for-org'.GithubApi.ListOrgRunnerGroupRunners
List self-hosted runners in an organization group. Retrieves self-hosted runners in a specified group within an organization. Requires an access token with 'admin:org' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. It is not case sensitive. |
runner_group_id | integer | Required | Unique identifier of the self-hosted runner group to fetch runners for. |
result_page_number | integer | Optional | Specifies the page number of results to be fetched. Used for pagination. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'actions/list-self-hosted-runners-in-group-for-org'.GithubApi.ListOrgSecretScanningAlerts
Retrieve secret scanning alerts for an organization's repositories. This tool provides a list of secret scanning alerts from eligible repositories within an organization, sorted from newest to oldest. It should be called by users who are administrators or security managers of the organization, using an appropriate access token. GitHub Apps with `secret_scanning_alerts` read permission can also utilize this endpoint.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization for which secret scanning alerts are to be listed. This value is not case-sensitive. |
alert_resolution_filter | string | Optional | A comma-separated list of resolutions to filter secret scanning alerts. Valid options are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted`, and `used_in_tests`. |
alert_state | string | Optional | Specify 'open' or 'resolved' to filter secret scanning alerts by their state. |
results_page_number | integer | Optional | The page number of results to retrieve, starting from 1. Determines which subset of results will be returned. |
results_per_page | integer | Optional | The number of results to return per page, with a maximum of 100. |
search_after_cursor | string | Optional | A cursor for paginating results, provided in the Link header. Use an empty string for the initial request to receive a starting cursor. |
search_before_cursor | string | Optional | A cursor indicating that the query should only look for events before this point. Use an empty string to get an initial cursor. |
secret_types | string | Optional | Comma-separated list of secret types to return. Defaults to all secret types. Refer to the GitHub documentation for details on secret types. |
sort_by_property | string | Optional | Choose 'created' to sort by alert creation date or 'updated' to sort by last update or resolution. |
sort_direction | string | Optional | Specifies the order to sort the results: ascending ('asc') or descending ('desc'). |
Requirements
Output
json— Response from the API endpoint 'secret-scanning/list-alerts-for-org'.GithubApi.ListOrgSelfHostedRunners
Retrieve self-hosted runners for a GitHub organization. This tool fetches all self-hosted runners configured for a specified GitHub organization. Authentication with an admin-level token is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization's name. This is case insensitive. |
results_page_number | integer | Optional | Specify the page number of the results to fetch. For paginated data retrieval. |
results_per_page | integer | Optional | Specify the number of results to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'actions/list-self-hosted-runners-for-org'.GithubApi.ListOrgVariables
Retrieve all variables for a GitHub organization. Use this tool to list all variables configured in a GitHub organization. Authentication with an access token having the `admin:org` scope or a GitHub App with `organization_actions_variables:read` permission is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
result_page_number | integer | Optional | Specify the page number of the organization variables to retrieve. |
results_per_page | integer | Optional | The number of results to display per page, up to a maximum of 30. |
Requirements
Output
json— Response from the API endpoint 'actions/list-org-variables'.GithubApi.ListPersonalAccessTokens
Retrieve personal access tokens for all users including admins. This tool calls the GitHub API to list personal access tokens for all users in an enterprise, including admin users. It's useful for administrators wanting to audit or manage user access tokens.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
results_page_number | integer | Optional | The page number of the results to fetch, used for pagination. |
results_per_page | integer | Optional | Number of results to return per page. Maximum value is 100. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-personal-access-tokens'.GithubApi.ListPreReceiveEnvironments
Retrieve a list of pre-receive environments for GitHub Enterprise. This tool is used to fetch and list all pre-receive environments in a GitHub Enterprise instance. It should be called when you need to inspect or manage pre-receive environments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
page_number | integer | Optional | Specifies the page number of results to fetch. Use this to navigate through paginated data. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum of 100. |
sort | string | Optional | Criteria to sort the results: 'created', 'updated', or 'name'. |
sort_direction | string | Optional | Specifies the order to sort results: 'asc' for ascending or 'desc' for descending. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-pre-receive-environments'.GithubApi.ListPreReceiveHooks
Retrieve the list of pre-receive hooks in GitHub Enterprise. Use this tool to get a list of all the pre-receive hooks configured in the GitHub Enterprise admin settings.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
results_page_number | integer | Optional | The specific page number of results to retrieve, used for pagination. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum of 100. |
sort_direction | string | Optional | The direction to sort the results by. Options are 'asc' for ascending or 'desc' for descending. |
sort_results_by | string | Optional | Specify the property to sort the results by. Options are 'created', 'updated', or 'name'. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-pre-receive-hooks'.GithubApi.ListProjectCards
Retrieve project cards for a specific column on GitHub projects. Use this tool to obtain a list of project cards within a specified column in GitHub projects. It is useful for managing tasks and tracking project progress by accessing detailed card information in a particular column.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
column_identifier | integer | Required | The unique identifier for the specified project column, used to list its cards. |
filter_by_archived_state | string | Optional | Filters project cards by their archived state. Options are 'all', 'archived', or 'not_archived'. |
results_page_number | integer | Optional | Specifies the page number of the project cards results to fetch. Useful for navigating through paginated results. |
results_per_page | integer | Optional | Number of project cards returned per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'projects/list-cards'.GithubApi.ListProjectCollaborators
Retrieve collaborators for a GitHub organization project. Use this tool to obtain a list of all collaborators for a specified GitHub organization project, including outside collaborators and organization members with various access levels. Requires organization owner or project admin permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_id | integer | Required | The unique identifier for the GitHub organization project to retrieve collaborators for. |
collaborator_affiliation_filter | string | Optional | Specifies how to filter collaborators: `outside`, `direct`, or `all`. |
results_page_number | integer | Optional | The page number to retrieve from the list of collaborators. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'projects/list-collaborators'.GithubApi.ListProvisionedGroupsForEnterprise
Retrieve provisioned SCIM groups for an enterprise. This tool retrieves a list of provisioned SCIM groups within an enterprise account on GitHub. It is useful for administrators who need to manage or audit group provisions. For optimized performance, exclude 'members' from the response using the 'excludedAttributes' query parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_attribute_from_results | string | Optional | Specify an attribute to exclude from the results to speed up response time. |
filter_by_attribute | string | Optional | Filter results by a specific attribute. Supported filters: `externalId`, `id`, `displayName`. Example: `externalId eq '9138790-10932-109120392-12321'`. |
results_per_page | integer | Optional | The number of SCIM group results to return per page for pagination. |
start_index | integer | Optional | The starting index for pagination; specifies where to begin returning results. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-provisioned-groups-enterprise'.GithubApi.ListPublicGithubRepositories
Retrieve all public GitHub repositories. This tool lists all public repositories on GitHub, ordered by creation date. It uses pagination via the 'since' parameter and provides the Link header for navigating pages.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_visibility | string | Optional | Specify types of repositories to return, such as 'all' or 'public'. |
starting_repository_id | integer | Optional | Specify a repository ID to list only repositories with an ID greater than this value for pagination. |
Requirements
Output
json— Response from the API endpoint 'repos/list-public'.GithubApi.ListPublicOrgEvents
List public events for a GitHub organization. This tool retrieves and lists all public events for a specified organization on GitHub. It is useful for monitoring recent activities within an organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
results_page_number | integer | Optional | Page number of the results to fetch. Determines which set of results to return. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'activity/list-public-org-events'.GithubApi.ListPublicOrgMembers
Retrieve public members of a GitHub organization. Use this tool to obtain a list of members who have publicized their membership in a specified GitHub organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
results_page_number | integer | Optional | The page number of the results to fetch, used for pagination. |
results_per_page | integer | Optional | Specify the number of results to return per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'orgs/list-public-members'.GithubApi.ListPublicOrgsForUser
Retrieve public organization memberships for a GitHub user. Use this tool to obtain a list of public organization memberships for a specified GitHub user. It does not require authentication and only retrieves public memberships. For private memberships, use an authenticated method.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub user account handle to retrieve public organization memberships for. |
results_page_number | integer | Optional | Specify the page number of the results to fetch, for paginated results. |
results_per_page | integer | Optional | The number of results to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'orgs/list-for-user'.GithubApi.ListPublicSshKeys
Retrieve public SSH keys for the authenticated GitHub user. Call this tool to get a list of public SSH keys associated with the authenticated user's GitHub account. Requires authentication with `read:public_key` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
result_page_number | integer | Optional | Specifies which page of results to fetch, starting from 1. |
results_per_page | integer | Optional | The number of SSH key results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'users/list-public-ssh-keys-for-authenticated-user'.GithubApi.ListPullRequestCommentReactions
Retrieve reactions for a pull request review comment. Use this tool to list all reactions associated with a specific pull request review comment in a GitHub repository. It helps in understanding community engagement on specific comments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_unique_identifier | integer | Required | The unique identifier for the pull request review comment. |
repository_name | string | Required | The name of the repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
filter_reaction_type | string | Optional | Specify a single reaction type to filter results. Leave blank to return all reactions. |
results_page_number | integer | Optional | Specify the page number of results to fetch for reactions to a pull request review comment. |
results_per_page | integer | Optional | Specify the number of reactions to return per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'reactions/list-for-pull-request-review-comment'.GithubApi.ListPullRequestCommits
Retrieve up to 250 commits for a specific pull request. Use this tool to get a list of commits associated with a particular pull request. This is useful when you want to review changes or keep track of modifications made in a pull request. For a complete list with more than 250 commits, consider using the List commits endpoint.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pull_request_number | integer | Required | The unique number identifying the pull request within the repository. |
repository_name | string | Required | The name of the repository. It is not case sensitive and should be given as a string. |
repository_owner | string | Required | The account owner of the repository, not case sensitive. |
results_page_number | integer | Optional | Specify the page number of commit results to fetch. Useful for paginating through commit lists. |
results_per_page | integer | Optional | Specify the number of commit results to return per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'pulls/list-commits'.GithubApi.ListPullRequestReviewComments
Retrieve all review comments for a pull request. This tool fetches all review comments associated with a specified pull request in a GitHub repository. It returns the comments sorted in ascending order by ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pull_request_number | integer | Required | The unique number identifying the pull request within the repository. |
repository_name | string | Required | The name of the GitHub repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
notifications_since_timestamp | string | Optional | Filter review comments updated after this timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. |
page_number_to_fetch | integer | Optional | The specific results page number to retrieve. |
results_per_page | integer | Optional | Specify the number of results to return per page, with a maximum limit of 100. |
sort_direction | string | Optional | Specifies the direction to sort results. Use 'asc' for ascending or 'desc' for descending. Ignored without the 'sort' parameter. |
sort_results_by | string | Optional | Property to sort comments: 'created' or 'updated'. |
Requirements
Output
json— Response from the API endpoint 'pulls/list-review-comments'.GithubApi.ListPullRequests
Retrieve pull requests from a GitHub repository. This tool retrieves a list of pull requests from a specified GitHub repository, including both open and draft requests, for users with appropriate GitHub plans.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository from which to retrieve pull requests. This name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
base_branch_name | string | Optional | Specify the base branch name to filter pull requests. Example: 'gh-pages'. |
filter_by_head | string | Optional | Filter pull requests by head user/organization and branch in `user:ref-name` format. |
filter_by_state | string | Optional | Filter pull requests by state: `open`, `closed`, or `all`. |
page_number | integer | Optional | Page number of the results to fetch from the list of pull requests. |
results_per_page | integer | Optional | The number of pull requests to retrieve per page, with a maximum of 100 results allowed. |
sort_direction | string | Optional | The direction of the sorting for pull requests. Use 'asc' for ascending or 'desc' for descending order. Defaults to 'desc' when 'sort' is 'created' or not specified. |
sort_pull_request_results_by | string | Optional | Specify the criterion for sorting pull request results. Options are 'created', 'updated', 'popularity', or 'long-running'. |
Requirements
Output
json— Response from the API endpoint 'pulls/list'.GithubApi.ListPullRequestsForCommit
Retrieve pull requests linked to a specific commit. Fetches pull requests associated with a specific commit in a GitHub repository. Returns merged pull requests if the commit is in the default branch; otherwise, only open pull requests are returned.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
commit_sha | string | Required | The SHA identifier of the commit to fetch associated pull requests. |
repository_name | string | Required | The name of the repository (not case sensitive). |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
results_page_number | integer | Optional | Page number of the results to fetch from the list of pull requests associated with the commit. |
results_per_page | integer | Optional | Number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-pull-requests-associated-with-commit'.GithubApi.ListRecentCodeScanningAnalyses
Retrieve recent code scanning analyses for a repository. Use this tool to list the details of recent code scanning analyses for a GitHub repository. It retrieves a paginated list starting with the most recent analyses. Useful for understanding security events and code quality checks. Requires proper access tokens or GitHub App permissions for private repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive, and it should match the GitHub account owning the target repository. |
code_scanning_tool_guid | string | Optional | The GUID of the code scanning tool to filter results. Specify either this or 'tool_name', not both. |
code_scanning_tool_name | string | Optional | Specify the name of a code scanning tool to list results by this tool only. Cannot be used with `tool_guid`. |
filter_by_sarif_id | string | Optional | Filter analyses that belong to a specific SARIF upload by providing the SARIF ID. |
git_reference_for_analyses | string | Optional | The Git reference for analyses; format as `refs/heads/<branch>` for branches or `refs/pull/<number>/merge` for pull requests. |
page_number | integer | Optional | The page number of the results to fetch. Used for paginating through the list of analyses. |
results_per_page | integer | Optional | Number of results per page, with a maximum limit of 100. |
sort_by_property | string | Optional | Specify the property for sorting the results. Available option: 'created'. |
sort_direction | string | Optional | The order to sort results, either ascending ('asc') or descending ('desc'). |
Requirements
Output
json— Response from the API endpoint 'code-scanning/list-recent-analyses'.GithubApi.ListRecentGithubEvents
Retrieve recent public events from GitHub. Obtain the most recent public events from GitHub, with events delayed by at least five minutes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
page_number | integer | Optional | The page number of the GitHub public event results to fetch. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'activity/list-public-events'.GithubApi.ListRecentGithubMigrations
Retrieve the latest GitHub migrations for an organization. Use this tool to list recent migrations for a specified GitHub organization, including export and import activities. The list includes `repositories` only for export migrations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name. This value is not case sensitive. Use to specify which organization's migrations to list. |
exclude_attributes | array<string> | Optional | A list of attributes to exclude from the API response to enhance performance. |
results_page_number | integer | Optional | Page number to fetch specific results from the list of migrations. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum value of 100. |
Requirements
Output
json— Response from the API endpoint 'migrations/list-for-org'.GithubApi.ListRecentPublicGists
Retrieve the most recently updated public gists. Call this tool to get a list of public gists on GitHub sorted by the most recent updates. Useful for accessing the latest shared code snippets or projects made publicly available on GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
result_page_number | integer | Optional | Page number to fetch the results from. Use for pagination. |
results_per_page | integer | Optional | Specifies the number of gists to display per page. Maximum allowed is 100. |
updated_since | string | Optional | A timestamp in ISO 8601 format to filter gists updated after this time. |
Requirements
Output
json— Response from the API endpoint 'gists/list-public'.GithubApi.ListRepoCacheStatus
Lists the status of each repository cache replica. Use this tool to get information about the status of cache replicas for a specific GitHub repository. Ideal for monitoring or troubleshooting cache issues.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. It is not case sensitive and should clearly identify the GitHub repository of interest. |
repository_owner | string | Required | The GitHub username of the repository owner. This is not case sensitive. |
result_page_number | integer | Optional | The page number of results to fetch, used for pagination. |
results_per_page | integer | Optional | The number of results per page (maximum 100). |
Requirements
Output
json— Response from the API endpoint 'repos/list-cache-info'.GithubApi.ListRepoCommitComments
Retrieve commit comments for a GitHub repository. This tool retrieves commit comments for a specified GitHub repository. It's useful when you want to analyze or display comments made on commits in a project. Call this tool when you need to access the comments sorted by ascending ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This name is not case sensitive. |
results_page_number | integer | Optional | Specify the page number of commit comments to fetch from the repository. |
results_per_page | integer | Optional | Number of commit comments to retrieve per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-commit-comments-for-repo'.GithubApi.ListRepoInvitations
List open invitations for a GitHub repository. Use this tool to retrieve all currently open invitations for a specified GitHub repository, requiring admin rights for access.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. It's not case sensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. The name is not case sensitive. |
results_page_number | integer | Optional | Specifies the page number to fetch results from, used for pagination. |
results_per_page | integer | Optional | The number of invitations to display per page, with a maximum limit of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-invitations'.GithubApi.ListRepoLanguages
List programming languages used in a GitHub repository. This tool retrieves the languages used in a specified GitHub repository, along with the number of bytes of code written in each language. It should be called when you need to find out which programming languages are utilized in a repository on GitHub.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. Case insensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. Case insensitive. |
Requirements
Output
json— Response from the API endpoint 'repos/list-languages'.GithubApi.ListRepoNetworkPublicEvents
Retrieve public events for a network of repositories. Use this tool to get the latest public events associated with a network of repositories on GitHub. It is useful for monitoring activity across multiple related repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This value is not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. This value is not case sensitive. |
results_page_number | integer | Optional | Specify the page number of results to retrieve. Use this to navigate through paginated results. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'activity/list-public-events-for-repo-network'.GithubApi.ListRepoPreReceiveHooks
List pre-receive hooks for a GitHub repository. Fetch all enabled, testing, and allowed disabled pre-receive hooks for a specific GitHub repository. This includes hooks that can be enabled at the repository level, excluding those disabled at higher levels and not configurable.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This is not case sensitive. |
repository_owner | string | Required | The account owner of the repository, not case sensitive. |
result_page_number | integer | Optional | The number of the results page to fetch, starting from 1. |
results_per_page | integer | Optional | The number of results to display per page, maximum 100. |
sort_direction | string | Optional | Specify 'asc' for ascending or 'desc' for descending sorting of results. |
sort_hooks_by | string | Optional | Specifies the attribute to sort the pre-receive hooks by. Possible values are 'created', 'updated', or 'name'. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-pre-receive-hooks-for-repo'.GithubApi.ListRepoRequiredWorkflows
Retrieve required workflows in a GitHub repository. Use this tool to list required workflows in a GitHub repository. This is accessible to anyone with read access. For private repositories, an access token with the `repo` scope is necessary. GitHub Apps need `actions:read` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. It is not case sensitive. |
repository_name | string | Required | The name of the GitHub repository you want to query. This is not case sensitive. |
page_number | integer | Optional | The specific page of workflow results to retrieve. Use this for pagination. |
results_per_page | integer | Optional | Specify the number of results to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'actions/list-repo-required-workflows'.GithubApi.ListRepoSecrets
Retrieve all repository secrets without values. This tool retrieves all the secrets available in a specified GitHub repository without revealing their encrypted values. Authentication is required using an access token with `repo` scope. GitHub Apps need `secrets` repository permission to access this endpoint.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. It is not case sensitive. |
results_page_number | integer | Optional | Specifies the page number of the secrets list to fetch. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'actions/list-repo-secrets'.GithubApi.ListReposForOrgMigration
List all repositories for an organization's migration. Use this tool to retrieve a list of all repositories associated with a specific organization migration on GitHub. It's useful for tracking migration progress or fetching details about repositories being moved.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
migration_unique_identifier | integer | Required | The unique identifier for the organization migration in GitHub. |
organization_name | string | Required | The name of the organization. This name is not case sensitive and identifies the GitHub organization for which the migration repositories will be listed. |
results_page_number | integer | Optional | Page number of the results to fetch, used for pagination. |
results_per_page | integer | Optional | Number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'migrations/list-repos-for-org'.GithubApi.ListRepositoryEnvironments
Retrieve environments for a GitHub repository. Use this tool to list all environments associated with a specific GitHub repository. It requires read access to the repository. If the repository is private, ensure to use an access token with the necessary `repo` scope. This endpoint is also accessible to GitHub Apps with `actions:read` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository to retrieve environments for. This name is not case-sensitive. |
repository_owner | string | Required | The GitHub username of the repository owner. Case insensitive. |
results_page_number | integer | Optional | The number of the page to retrieve for paginated results. |
results_per_page | integer | Optional | The number of results to retrieve per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/get-all-environments'.GithubApi.ListRepositoryLabels
Retrieve labels for a GitHub repository. Use this tool to obtain the list of labels associated with a specified repository on GitHub. It helps in identifying the categories or tags used for organizing issues within the repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository, not case-sensitive. |
repository_owner | string | Required | The GitHub username of the repository owner. It is not case sensitive. |
result_page_number | integer | Optional | The specific page number of results to fetch. Use this to navigate through paginated results. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'issues/list-labels-for-repo'.GithubApi.ListRepositoryProjects
Retrieve projects from a specific GitHub repository. Use this tool to list all the projects of a specified GitHub repository. It should be called when you need to view available projects. Note that a 404 status is returned if projects are disabled, and a 401 or 410 status if there are insufficient privileges.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. This value is not case sensitive. |
project_state | string | Optional | Specify which state of projects to return: 'open', 'closed', or 'all'. |
results_page_number | integer | Optional | Specifies which page of the results to fetch. Useful for paginated responses. |
results_per_page | integer | Optional | The number of results to return per page. Maximum is 100. |
Requirements
Output
json— Response from the API endpoint 'projects/list-for-repo'.GithubApi.ListRepositoryTeams
Retrieve a list of teams for a specified GitHub repository. Use this tool to get all the teams associated with a specific GitHub repository by providing the repository owner and name.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. Not case sensitive. |
repository_owner | string | Required | The account owner of the repository. This is case-insensitive. |
result_page_number | integer | Optional | The page number to fetch from the results. Use this to iterate through paginated data. |
results_per_page | integer | Optional | The number of results to include per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-teams'.GithubApi.ListRepositoryWebhooks
Retrieve webhooks for a specified GitHub repository. Use this tool to list all webhooks configured for a specific GitHub repository. Helpful for managing and reviewing webhook configurations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This value is not case sensitive. |
repository_owner | string | Required | The account owner of the repository, not case sensitive. |
result_page_number | integer | Optional | The page number of webhooks results to fetch from the repository. |
results_per_page | integer | Optional | Specify the number of webhooks to list per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'repos/list-webhooks'.GithubApi.ListRepoStargazers
Retrieve users who starred a specific GitHub repository. This tool provides a list of users that have starred a specified GitHub repository, along with the timestamps of when the stars were added. It's useful for understanding the popularity and engagement of a repository.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. It is case-insensitive. |
repository_owner | string | Required | The username of the repository's account owner. The name is not case sensitive. |
results_page_number | integer | Optional | Specify the page number for results pagination to retrieve a specific set of stargazers. |
results_per_page | integer | Optional | The number of stargazer results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'activity/list-stargazers-for-repo'.GithubApi.ListReposWithOrgSecret
Retrieve repositories with access to a specific organization secret. This tool lists all repositories that have been given access to a specific organization secret with `selected` visibility. It requires authentication with an access token featuring the `admin:org` scope, or a GitHub App with `secrets` organization permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. It is not case sensitive. |
secret_name | string | Required | The name of the secret for which to list selected repositories. Case insensitive. |
result_page_number | integer | Optional | Page number of the results to fetch for pagination. |
results_per_page | integer | Optional | The number of repositories to return per page, with a maximum of 100 allowed. |
Requirements
Output
json— Response from the API endpoint 'actions/list-selected-repos-for-org-secret'.GithubApi.ListReposWithOrgVariableAccess
Retrieve repos accessing an organization's variable. This tool lists all repositories that have access to a specified organization variable. Authentication with an access token having the `admin:org` scope is required. GitHub Apps must have the `organization_actions_variables:read` permission.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. It is not case sensitive. |
variable_name | string | Required | The name of the organization variable to check for repository access. |
result_page_number | integer | Optional | The page number of repository results to retrieve. Use this to navigate through results. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'actions/list-selected-repos-for-org-variable'.GithubApi.ListReposWithRunnerGroupAccess
Retrieve repositories with access to a runner group in an organization. This tool lists the repositories that have access to a specified self-hosted runner group in an organization. It requires authentication with an access token having `admin:org` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The case-insensitive name of the organization. |
runner_group_id | integer | Required | Unique identifier of the self-hosted runner group to fetch repository access details. |
result_page_number | integer | Optional | Page number of the results to fetch. |
results_per_page | integer | Optional | The number of results to retrieve per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'actions/list-repo-access-to-self-hosted-runner-group-in-org'.GithubApi.ListRequiredWorkflowRepositories
List repositories configured for a required workflow. This tool retrieves a list of repositories that are configured to use a specific required workflow within an organization. It should be called when you need to know which repositories are set up to run a required workflow. Authentication with an access token having `read:org` scope or a GitHub App with `administration` permission is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. It is not case sensitive and identifies the organization within GitHub. |
workflow_unique_identifier | integer | Required | The unique identifier of the required workflow for which the repositories are to be listed. |
Requirements
Output
json— Response from the API endpoint 'actions/list-selected-repositories-required-workflow'.GithubApi.ListRequiredWorkflowRuns
Retrieve all workflow runs for a required workflow. Use this tool to list all workflow runs associated with a specific required workflow in a GitHub repository. It is useful for monitoring and analyzing the execution of required workflows. Requires repository read access, and for private repositories, an access token with the `repo` scope is needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. Case sensitivity is ignored. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. |
required_workflow_id | integer | Required | The ID of the required workflow that has run at least once in a repository. |
branch_name | string | Optional | Specify the branch name to filter workflow runs associated with it. Use the name of the branch from the `push`. |
check_suite_identifier | integer | Optional | Specify the Check Suite ID to filter workflow runs associated with this specific ID. |
exclude_pull_requests | boolean | Optional | If true, pull requests are omitted from the response. |
results_page_number | integer | Optional | The page number of the results to fetch, used for pagination of the workflow runs. |
results_per_page | integer | Optional | The number of workflow run results to display per page, with a maximum limit of 100. |
sha_for_head_commit | string | Optional | Returns workflow runs associated with the specified head SHA (commit identifier). |
trigger_event | string | Optional | Specify the event type that triggers the workflow run, such as `push`, `pull_request`, or `issue`. |
workflow_actor_username | string | Optional | Specify the username of the actor whose workflow runs you want to retrieve. Use the GitHub login for the user who initiated the push. |
workflow_run_status | string | Optional | Specify the workflow run status or conclusion to filter results. Options include 'completed', 'in_progress', 'success', etc. |
workflow_runs_created_date_range | string | Optional | Specify the date-time range to filter workflow runs based on their creation date. Use GitHub's date search syntax for formatting. |
Requirements
Output
json— Response from the API endpoint 'actions/list-required-workflow-runs'.GithubApi.ListRequiredWorkflows
Retrieve all required workflows in a GitHub organization. Use this tool to get a list of all workflows that are required within a specific GitHub organization. Authentication with an access token having the `read:org` scope is necessary.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization name. Note: The name is not case sensitive. This identifies which organization's workflows to list. |
results_page_number | integer | Optional | The specific page number of required workflow results to fetch. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'actions/list-required-workflows'.GithubApi.ListReviewCommentsForRepo
Retrieve review comments for all pull requests in a repository. Use this tool to obtain a list of review comments for all pull requests within a specified repository. This is useful for tracking feedback and discussions associated with pull requests.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository to fetch review comments from. The name is not case sensitive. |
repository_owner | string | Required | The account owner of the repository. The name is not case sensitive. Specify the username or organization name. |
page_number | integer | Optional | Specify the page number of the results to retrieve from the API. Used for pagination. |
results_per_page | integer | Optional | The number of review comments to retrieve per page, with a maximum limit of 100. |
sort_direction | string | Optional | Specifies the order to sort the review comments. Options are 'asc' for ascending and 'desc' for descending. Note: This is ignored if no 'sort' parameter is set. |
sort_reviews | string | Optional | Determines the order of review comments based on 'created', 'updated', or 'created_at'. |
updated_after | string | Optional | Timestamp to filter notifications updated after this time in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. |
Requirements
Output
json— Response from the API endpoint 'pulls/list-review-comments-for-repo'.GithubApi.ListRunnerAppsForRepo
Retrieve runner application binaries for a GitHub repository. Use this tool to list binaries for GitHub runner applications that can be downloaded and run. Requires authentication with a token that has 'repo' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository. Case insensitive. |
repository_owner | string | Required | The account owner of the repository on GitHub. The name is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'actions/list-runner-applications-for-repo'.GithubApi.ListRunnerBinariesForEnterprise
Retrieve download links for runner application binaries. Use this tool to list available binaries for GitHub runner applications that can be downloaded and run for a specified enterprise. Authentication with an access token having the `manage_runners:enterprise` scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug or ID for the enterprise to obtain runner binaries. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-runner-applications-for-enterprise'.GithubApi.ListRunnerGroupsForOrg
Retrieve self-hosted runner groups for a GitHub organization. This tool lists all self-hosted runner groups configured in a specified GitHub organization, including those inherited from an enterprise. Authentication with an access token having the `admin:org` scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization's name. This is not case sensitive. |
repository_visibility_filter | string | Optional | Specify the repository to filter runner groups that they are allowed to be used by. |
results_page_number | integer | Optional | Specify the page number of the results to fetch. Use an integer value. |
results_per_page | integer | Optional | Specify the number of results per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'actions/list-self-hosted-runner-groups-for-org'.GithubApi.ListRunnerLabels
Retrieve all labels for a self-hosted runner in a GitHub repo. Use this tool to get all labels for a specific self-hosted runner configured in a GitHub repository. Authentication with a token that has the `repo` scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the repository. This is not case sensitive. |
repository_owner | string | Required | The GitHub account owner of the repository. Case insensitive. |
self_hosted_runner_id | integer | Required | The unique integer identifier of the self-hosted runner in the repository. |
Requirements
Output
json— Response from the API endpoint 'actions/list-labels-for-self-hosted-runner-for-repo'.GithubApi.ListRunnerLabelsForOrg
Retrieve labels for a self-hosted runner in an organization. This tool is used to list all labels for a specified self-hosted runner within an organization. Authentication with an access token having the `admin:org` scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the organization. This parameter is not case sensitive. |
runner_unique_id | integer | Required | The unique identifier for the self-hosted runner. It must be an integer. |
Requirements
Output
json— Response from the API endpoint 'actions/list-labels-for-self-hosted-runner-for-org'.GithubApi.ListScimEnterpriseMembers
Lists provisioned SCIM enterprise members for GitHub enterprises. This tool retrieves a list of provisioned SCIM enterprise members associated with a GitHub enterprise account. It is useful for managing enterprise users and understanding membership status. The tool allows you to exclude certain attributes to improve query performance.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
exclude_attributes | string | Optional | Specify attributes to exclude from the results to improve query performance. Commonly used values are 'groups'. |
filter_criteria | string | Optional | Filter results by `userName`, `externalId`, `id`, or `displayName`. Only one filter is supported. E.g., "externalId eq '9138790-10932-109120392-12321'". |
pagination_start_index | integer | Optional | The starting index of the first result to return for paginated responses. |
results_per_page | integer | Optional | Specify the number of SCIM enterprise members to return per page for pagination. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-provisioned-identities-enterprise'.GithubApi.ListSecretScanningAlertLocations
Retrieve locations for a secret scanning alert in a repository. This tool retrieves all locations associated with a specific secret scanning alert within an eligible GitHub repository. It requires administrator access and a personal access token with appropriate scopes. Suitable for checking where a secret may have been exposed in repository files or areas.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
alert_number | integer | Required | The unique identifier number for a secret scanning alert. This can be found at the end of the URL for a code scanning alert on GitHub, or in the `number` field of the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` API call. |
repository_name | string | Required | The name of the repository, case insensitive. |
repository_owner | string | Required | The account owner of the GitHub repository. It is not case sensitive. |
results_page_number | integer | Optional | The page number of the results to fetch for the secret scanning alert locations. |
results_per_page | integer | Optional | Specify the number of results to return per page (maximum 100). |
Requirements
Output
json— Response from the API endpoint 'secret-scanning/list-locations-for-alert'.GithubApi.ListSecretScanningAlertsForEnterprise
Retrieve secret scanning alerts for enterprise repositories. This tool fetches secret scanning alerts for eligible repositories within an enterprise, presented from newest to oldest. Users must be members of the enterprise and possess the appropriate access token with `repo` or `security_events` scope. Alerts are only available for organizations where the user has ownership or security management permissions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug or ID of the enterprise. This identifies the specific enterprise to list alerts for. |
alert_resolution_filters | string | Optional | Comma-separated list of alert resolutions to filter by: false_positive, wont_fix, revoked, pattern_edited, pattern_deleted, used_in_tests. |
alert_state_filter | string | Optional | Specify if only 'open' or 'resolved' secret scanning alerts should be listed. |
cursor_after | string | Optional | A cursor for retrieving results after this point, as specified in the Link header. |
cursor_before | string | Optional | A cursor to fetch results before this point, as specified by the link header. |
results_per_page | integer | Optional | The number of results per page. Maximum is 100. |
secret_types_to_return | string | Optional | A comma-separated list of secret types to return. By default, all secret types are returned. Refer to GitHub's secret scanning patterns documentation for supported types. |
sort_by | string | Optional | Specify 'created' to sort by alert creation date or 'updated' to sort by the last update or resolution date. |
sort_direction | string | Optional | Specify the direction ('asc' or 'desc') to sort the secret scanning alerts results. |
Requirements
Output
json— Response from the API endpoint 'secret-scanning/list-alerts-for-enterprise'.GithubApi.ListSecurityManagerTeams
Retrieve teams that are security managers in an organization. This tool retrieves a list of teams designated as security managers for a specified organization on GitHub. It should be used when you need to identify teams responsible for security within an organization. Requires appropriate access rights, like being an administrator or security manager with a token having the `read:org` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The GitHub organization's name. It is not case sensitive. |
Requirements
Output
json— Response from the API endpoint 'orgs/list-security-manager-teams'.GithubApi.ListSelectedRepositoriesForSecret
Retrieve repositories with selected access for an org secret. This tool lists all repositories that have been granted access to a secret in a GitHub organization, where the access visibility is set to 'selected'. Use it when you need to determine which repositories can access a particular secret. Requires an access token with 'admin:org' scope or 'dependabot_secrets' permission for GitHub Apps.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. This is not case sensitive. Required to identify the organization whose secret's repository access is being queried. |
secret_name | string | Required | The name of the secret for which you wish to list selected repositories. It is case insensitive. |
results_page_number | integer | Optional | The page number of the results to fetch, used for pagination. |
results_per_page | integer | Optional | Number of results per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'dependabot/list-selected-repos-for-org-secret'.GithubApi.ListSelfHostedRunnerGroups
Retrieve all self-hosted runner groups for an enterprise. Fetches a list of all self-hosted runner groups for a specified enterprise. Requires authentication with an access token having the 'manage_runners:enterprise' scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_slug | string | Required | The slug or ID of the enterprise for which to list self-hosted runner groups. This identifies the enterprise by name or numeric ID. |
organization_filter | string | Optional | Filter results to show runner groups usable by the specified organization. |
results_page_number | integer | Optional | Specifies which page of the self-hosted runner groups results to retrieve. Useful for paginating through large sets of data. |
results_per_page | integer | Optional | The maximum number of results to return per page, up to 100. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-self-hosted-runner-groups-for-enterprise'.GithubApi.ListSelfHostedRunners
Retrieve self-hosted runners for a GitHub repository. Use this tool to list all self-hosted runners configured in a specific GitHub repository. Authentication with an access token having the `repo` scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
repository_name | string | Required | The name of the GitHub repository (case-insensitive) for which to list self-hosted runners. |
repository_owner | string | Required | The account owner of the repository, not case sensitive. |
results_page_number | integer | Optional | Page number of the results to fetch for listing self-hosted runners. |
results_per_page | integer | Optional | The number of results to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'actions/list-self-hosted-runners-for-repo'.GithubApi.ListSelfHostedRunnersForEnterprise
Retrieve all self-hosted runners for a GitHub enterprise. Use this tool to obtain a list of all self-hosted runners configured for a specified GitHub enterprise. Authentication with an access token having the `manage_runners:enterprise` scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug or ID of the enterprise for which to list self-hosted runners. |
results_page_number | integer | Optional | Specify the page number of the results to fetch for pagination purposes. |
results_per_page | integer | Optional | The number of results to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-self-hosted-runners-for-enterprise'.GithubApi.ListSelfHostedRunnersInGroup
Retrieve self-hosted runners in an enterprise group. Use this tool to list the self-hosted runners associated with a specific group in an enterprise on GitHub. Authentication with an access token that has the 'manage_runners:enterprise' scope is required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
enterprise_identifier | string | Required | The slug or ID of the enterprise. Use the slug version of the enterprise name or substitute with the enterprise ID. |
runner_group_id | integer | Required | The unique identifier of the self-hosted runner group within the enterprise. |
results_page_number | integer | Optional | Page number of the results to fetch. |
results_per_page | integer | Optional | The number of results to display per page (maximum 100). |
Requirements
Output
json— Response from the API endpoint 'enterprise-admin/list-self-hosted-runners-in-group-for-enterprise'.GithubApi.ListSshSigningKeys
Retrieve SSH signing keys for the authenticated GitHub user. This tool lists the SSH signing keys associated with the authenticated GitHub user's account. It requires authentication via Basic Auth or OAuth with `read:ssh_signing_key` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
results_page_number | integer | Optional | Page number of the results to fetch. Use this to navigate through paginated results. |
results_per_page | integer | Optional | The number of SSH signing key results to display per page. The maximum allowed is 100. |
Requirements
Output
json— Response from the API endpoint 'users/list-ssh-signing-keys-for-authenticated-user'.GithubApi.ListSshSigningKeysForUser
Retrieve SSH signing keys for a specific GitHub user. Use this tool to obtain the SSH signing keys associated with a given GitHub username. This operation can be performed by anyone.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_username | string | Required | The GitHub username whose SSH signing keys you want to retrieve. |
results_page_number | integer | Optional | Page number of the results to fetch when listing SSH signing keys. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'users/list-ssh-signing-keys-for-user'.GithubApi.ListStarredGists
Retrieve the authenticated user's starred gists. Call this tool to get the authenticated user's starred gists on GitHub. Useful for accessing gists that the user has marked as starred.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
results_page_number | integer | Optional | Specifies which page of results to fetch for the user's starred gists. |
results_per_page | integer | Optional | Specify the number of results per page. Maximum allowed is 100. |
updated_since_time | string | Optional | Only show gists updated after this time. Use ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. |
Requirements
Output
json— Response from the API endpoint 'gists/list-starred'.GithubApi.ListStarredRepos
Retrieve repositories starred by a user on GitHub. Use this tool to get a list of repositories that a specified GitHub user has starred, including the option to find out when stars were created.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub user's handle (username) to retrieve starred repositories for. |
page_number | integer | Optional | The page number of the results to fetch, useful for pagination. |
results_per_page | integer | Optional | The number of repository results to return per page, with a maximum of 100. |
sort_direction | string | Optional | Specify the direction to sort the results: 'asc' for ascending or 'desc' for descending. |
sort_repositories_by | string | Optional | Property to sort the repositories by: 'created' for star date or 'updated' for last push date. |
Requirements
Output
json— Response from the API endpoint 'activity/list-repos-starred-by-user'.GithubApi.ListStarredRepositories
Retrieve repositories starred by the authenticated user. This tool fetches a list of repositories that the authenticated user has starred on GitHub. It can also provide information on when the stars were created if desired.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
page_number_to_fetch | integer | Optional | Specify the page number of results to retrieve. Use for pagination of starred repositories. |
results_per_page | integer | Optional | The number of repositories to return per page, maximum of 100. |
sort_by | string | Optional | The property to sort the results by. Use 'created' for sorting by the star creation date or 'updated' for the last push date. |
sort_direction | string | Optional | The direction to sort the results by. Use 'asc' for ascending or 'desc' for descending. |
Requirements
Output
json— Response from the API endpoint 'activity/list-repos-starred-by-authenticated-user'.GithubApi.ListTeamDiscussionCommentReactions
Retrieve reactions for a team discussion comment in an organization. This tool retrieves the list of reactions for a specific comment in a team discussion within an organization on GitHub. It requires OAuth access tokens with the `read:discussion` scope. Use this when you need to analyze or display reactions to a particular discussion comment.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
comment_identifier | integer | Required | The unique number identifying the discussion comment. |
discussion_number | integer | Required | The number identifying the specific discussion in the team. |
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
team_slug | string | Required | The slug of the team name, case-insensitive, used to identify the team in the organization. |
filter_by_reaction_type | string | Optional | Specify a single reaction type to filter results. Options: '+1', '-1', 'laugh', 'confused', 'heart', 'hooray', 'rocket', 'eyes'. Omit to list all reactions. |
results_page_number | integer | Optional | The page number of the comments reactions to fetch from the results. |
results_per_page | integer | Optional | The number of results per page to return (maximum 100). |
Requirements
Output
json— Response from the API endpoint 'reactions/list-for-team-discussion-comment-in-org'.GithubApi.ListTeamDiscussionComments
Retrieve comments from a team discussion in an organization. This tool lists all comments on a specified team discussion within an organization on GitHub. It requires an OAuth token with the `read:discussion` scope and can be used when you need to see all comments made in a particular team discussion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
discussion_id | integer | Required | The unique number identifying the discussion to retrieve comments from. |
organization_name | string | Required | The name of the organization. It is not case sensitive. |
team_slug | string | Required | The identifier for the team, typically a URL-friendly version of the team name. |
results_page_number | integer | Optional | The specific page of discussion comments to retrieve, starting with 1 for the first page. |
results_per_page | integer | Optional | The number of discussion comments to return per page, maximum of 100. |
sort_direction | string | Optional | Specify the sort order for results: 'asc' for ascending or 'desc' for descending. |
Requirements
Output
json— Response from the API endpoint 'teams/list-discussion-comments-in-org'.GithubApi.ListTeamDiscussions
Retrieve all discussions from a team's page in an organization. Use this tool to get a list of discussions on a specified team's page within a GitHub organization. Requires OAuth access tokens with the `read:discussion` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The case-insensitive name of the GitHub organization. |
team_slug | string | Required | The slug of the team's name to identify which team's discussions to retrieve in the organization. |
pinned_discussions_only | string | Optional | Filter to retrieve only pinned discussions. Use 'true' for pinned only, 'false' for all. |
results_page_number | integer | Optional | The specific page number of discussion results to retrieve. |
results_per_page | integer | Optional | The number of results per page, with a maximum of 100. |
sort_direction | string | Optional | Specify the sorting direction for the results. Use 'asc' for ascending or 'desc' for descending order. |
Requirements
Output
json— Response from the API endpoint 'teams/list-discussions-in-org'.GithubApi.ListTeamMembersInOrg
Retrieve team members in a specified organization. Call this tool to get a list of members in a specific team within an organization on GitHub. It includes members from child teams, provided that the authenticated user has visibility of the team.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The name of the GitHub organization. It is not case sensitive. |
team_slug | string | Required | The slug of the team name within the organization. Used to identify the specific team. |
filter_by_role | string | Optional | Filters team members by their role: 'member', 'maintainer', or 'all'. |
result_page_number | integer | Optional | The page number of results to fetch. Use this for pagination. |
results_per_page | integer | Optional | Specifies the number of team members to return per page, up to a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'teams/list-members-in-org'.GithubApi.ListTeamProjectsInOrg
Retrieve a list of projects for a team in an organization. Use this tool to get a list of organization projects associated with a specific team based on the organization name and team slug. Ideal for fetching project details for managerial or planning purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The case-insensitive name of the organization for which to list team projects. |
team_slug | string | Required | The team's unique slug identifier. This is used to specify which team's projects to list. |
results_page_number | integer | Optional | The page number for the results you wish to retrieve. Used for paginating through results. |
results_per_page | integer | Optional | The number of results to display per page, with a maximum limit of 100. |
Requirements
Output
json— Response from the API endpoint 'teams/list-projects-in-org'.GithubApi.ListTeamRepositories
Retrieve a list of repositories for a specified team. This tool lists repositories associated with a specified team within an organization, visible to the authenticated user. Ideal for obtaining an overview of team-managed projects.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
organization_name | string | Required | The organization name. Case insensitivity applies. |
team_slug | string | Required | The slug of the team name (case-insensitive). |
results_page_number | integer | Optional | The page number of the results to fetch for pagination. |
results_per_page | integer | Optional | Number of results to return per page, with a maximum of 100. |
Requirements
Output
json— Response from the API endpoint 'teams/list-repos-in-org'.GithubApi.ListUserAccessibleRepos
List repositories accessible to the authenticated user. Retrieve a list of repositories that the authenticated user can access with specific permissions for a GitHub app installation. Useful for determining the user's access level to various repositories.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
installation_identifier | integer | Required | The unique identifier for the GitHub app installation required to list the repositories. |
results_page_number | integer | Optional | Specify the page number of results to fetch, starting from 1. |
results_per_page | integer | Optional | Specify the number of repository results to return per page (maximum 100). |
Requirements
Output
json— Response from the API endpoint 'apps/list-installation-repos-for-authenticated-user'.GithubApi.ListUserEmailAddresses
Retrieve all email addresses of the authenticated user. Fetches all email addresses associated with the authenticated GitHub user, indicating which are public. Useful for managing email visibility or account settings. Requires `user:email` scope.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
results_page_number | integer | Optional | Specify the page number to fetch results for user email addresses. |
results_per_page | integer | Optional | The number of email results to retrieve per page, maximum is 100. |
Requirements
Output
json— Response from the API endpoint 'users/list-emails-for-authenticated-user'.GithubApi.ListUserFollowers
Retrieve a list of followers for a specific GitHub user. Use this tool to get the list of people following a specified GitHub user. It should be called when you need information about who is following a particular user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
github_user_handle | string | Required | The GitHub user handle to list followers for. |
results_page_number | integer | Optional | Specify the page number of results to retrieve followers for the specified user. Use this to paginate through results if there are many followers. |
results_per_page | integer | Optional | The number of follower results to display per page, with a maximum limit of 100. |
Requirements
Output
json— Response from the API endpoint 'users/list-followers-for-user'.