[
{
"function": {
"description": "Tool to follow a GitHub user using GraphQL. Use when you need to make the authenticated user follow another user.",
"name": "GITHUB_FOLLOW_USER_GRAPHQL",
"parameters": {
"description": "Request parameters for following a GitHub user via GraphQL.\n\nUse the user's Node ID to follow them. The authenticated user will follow the specified user.",
"properties": {
"clientMutationId": {
"description": "A unique identifier for the client performing the mutation. Used to track requests.",
"examples": [
"abc123"
],
"title": "Client Mutation Id",
"type": "string"
},
"userId": {
"description": "The global Node ID of the user to follow. Must be a valid GitHub user ID in the format 'MDQ6VXNlcjU4MzIzMQ=='.",
"examples": [
"MDQ6VXNlcjU4MzIzMQ=="
],
"title": "User Id",
"type": "string"
}
},
"required": [
"userId"
],
"title": "FollowUserGraphqlRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Forcefully cancels a queued or in-progress GitHub Actions workflow run, bypassing conditions like always() that would otherwise continue execution. Only use when the standard cancel endpoint fails. Cannot cancel completed workflow runs. Requires write permissions to the repository.",
"name": "GITHUB_FORCE_CANCEL_WORKFLOW_RUN",
"parameters": {
"description": "Request schema for `ForceCancelWorkflowRun`",
"properties": {
"owner": {
"description": "The account owner of the repository. The name is not case sensitive.",
"examples": [
"octocat"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository without the `.git` extension. The name is not case sensitive. ",
"examples": [
"Hello-World"
],
"title": "Repo",
"type": "string"
},
"run_id": {
"description": "The unique identifier of the workflow run. Note: Only workflow runs with status 'queued' or 'in_progress' can be canceled. Completed workflow runs cannot be canceled.",
"examples": [
123456789
],
"title": "Run Id",
"type": "integer"
}
},
"required": [
"owner",
"repo",
"run_id"
],
"title": "ForceCancelWorkflowRunRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Forks a specified public gist, creating a copy under the authenticated user's account.",
"name": "GITHUB_FORK_GIST",
"parameters": {
"description": "Request schema for forking a public gist.",
"properties": {
"gist_id": {
"description": "The unique identifier of the gist to be forked.",
"examples": [
"aa5a315d61ae9438b18d"
],
"title": "Gist Id",
"type": "string"
}
},
"required": [
"gist_id"
],
"title": "ForkGistRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Generates Markdown release notes content (listing changes, pull requests, and contributors) for a GitHub repository release, customizable via tags and a configuration file.",
"name": "GITHUB_GENERATE_RELEASE_NOTES",
"parameters": {
"description": "Request schema for generating release notes content for a GitHub release.",
"properties": {
"configuration_file_path": {
"description": "Specifies a path to a configuration file in the repository (e.g., `.github/release.yml`) containing settings for generating release notes. If unspecified, GitHub looks for a configuration file at \".github/release.yml\" or \".github/release.yaml\". If no such file is found, default settings are used.",
"examples": [
".github/release.yml",
"docs/configs/release-notes-config.yaml"
],
"title": "Configuration File Path",
"type": "string"
},
"owner": {
"description": "The username or organization name that owns the repository. This field is not case-sensitive.",
"examples": [
"octocat",
"my-organization"
],
"title": "Owner",
"type": "string"
},
"previous_tag_name": {
"description": "The name of the previous tag to use as the starting point for the release notes. This manually specifies the range of changes to be included. If omitted, GitHub will attempt to automatically determine the previous release.",
"examples": [
"v0.9.0",
"beta-v2"
],
"title": "Previous Tag Name",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the `.git` extension. This field is not case-sensitive.",
"examples": [
"hello-world",
"my-project-name"
],
"title": "Repo",
"type": "string"
},
"tag_name": {
"description": "The tag name for which the release notes are to be generated. This can be an existing tag or a new tag name.",
"examples": [
"v1.0.0",
"release-candidate-01"
],
"title": "Tag Name",
"type": "string"
},
"target_commitish": {
"description": "Specifies the commitish value (e.g., a branch name, tag name, or commit SHA) that will be the target for the release's tag. This is required if the `tag_name` does not reference an existing tag. It is ignored if `tag_name` already exists.",
"examples": [
"main",
"develop",
"c65e38030b3247b89ac4cc5db5da26c4"
],
"title": "Target Commitish",
"type": "string"
}
},
"required": [
"owner",
"repo",
"tag_name"
],
"title": "GenerateReleaseNotesRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves the raw, typically Base64-encoded, content of a file (blob) from a GitHub repository using its SHA hash, if the repository and blob SHA exist.",
"name": "GITHUB_GET_A_BLOB",
"parameters": {
"description": "Request schema for retrieving a blob (file content) from a GitHub repository.",
"properties": {
"file_sha": {
"description": "The SHA-1 hash of the file (blob) to retrieve.",
"examples": [
"e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
],
"title": "File Sha",
"type": "string"
},
"owner": {
"description": "The username or organization name that owns the repository. This field is not case-sensitive.",
"examples": [
"octocat",
"github"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the '.git' extension. This field is not case-sensitive.",
"examples": [
"Hello-World",
"Spoon-Knife"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"file_sha"
],
"title": "GetABlobRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves detailed information for a specified branch within a GitHub repository.",
"name": "GITHUB_GET_A_BRANCH",
"parameters": {
"description": "Request schema for `GetABranch`",
"properties": {
"branch": {
"description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). If 'HEAD' is provided, it will be resolved to the repository's default branch.",
"examples": [
"main"
],
"title": "Branch",
"type": "string"
},
"owner": {
"description": "The account owner of the repository. The name is not case sensitive.",
"examples": [
"octocat"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository without the `.git` extension. The name is not case sensitive. ",
"examples": [
"Hello-World"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"branch"
],
"title": "GetABranchRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Lists users, teams, and GitHub Apps with push access to a branch; this branch must be protected in repository settings for detailed restrictions, otherwise expect a 404 or empty response.",
"name": "GITHUB_GET_ACCESS_RESTRICTIONS",
"parameters": {
"description": "Request schema for `GetAccessRestrictions`",
"properties": {
"branch": {
"description": "The name of the branch. Wildcard characters are not supported in this field. To manage branch protections with wildcard patterns, please refer to the GitHub GraphQL API documentation.",
"examples": [
"main",
"develop",
"feature/new-ui"
],
"title": "Branch",
"type": "string"
},
"owner": {
"description": "The account owner of the repository (e.g., username or organization name). This name is not case-sensitive.",
"examples": [
"octocat",
"my-github-org"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the `.git` extension. This name is not case-sensitive.",
"examples": [
"hello-world",
"my-project-repo"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"branch"
],
"title": "GetAccessRestrictionsRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves a specific commit from a repository by its owner, name, and a valid commit reference (SHA, branch, or tag), supporting pagination for large diffs.",
"name": "GITHUB_GET_A_COMMIT",
"parameters": {
"description": "Request schema for `GetACommit` action, used to retrieve a specific commit from a repository.",
"properties": {
"owner": {
"description": "The username or organization name that owns the repository. This field is not case-sensitive.",
"examples": [
"octocat",
"github"
],
"title": "Owner",
"type": "string"
},
"page": {
"default": 1,
"description": "Page number for paginating the commit's diff if it's too large. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
"title": "Page",
"type": "integer"
},
"per_page": {
"default": 30,
"description": "Number of results per page when paginating the commit's diff (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
"title": "Per Page",
"type": "integer"
},
"ref": {
"description": "The commit reference. Can be a commit SHA (e.g., '`sha`'), a branch name (e.g., 'heads/`BRANCH_NAME`' or simply '`BRANCH_NAME`'), or a tag name (e.g., 'tags/`TAG_NAME`'). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
"examples": [
"main",
"heads/develop",
"tags/v1.0.0",
"007a47250555ae82606ac2cb00f8f731976059a5"
],
"title": "Ref",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the `.git` extension. This field is not case-sensitive.",
"examples": [
"Spoon-Knife",
"linguist"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"ref"
],
"title": "GetACommitRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Checks if repository administrators are subject to the branch protection rules on a specific branch.",
"name": "GITHUB_GET_ADMIN_BRANCH_PROTECTION",
"parameters": {
"description": "Input parameters for checking admin branch protection.",
"properties": {
"branch": {
"description": "Name of the branch (wildcard characters not allowed; use GraphQL API for wildcard support).",
"examples": [
"main",
"develop"
],
"title": "Branch",
"type": "string"
},
"owner": {
"description": "Account owner of the repository (case-insensitive).",
"examples": [
"octocat"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "Name of the repository, without the `.git` extension (case-insensitive).",
"examples": [
"hello-world"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"branch"
],
"title": "GetAdminBranchProtectionRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves all officially supported, date-based (e.g., \"2022-11-28\") versions of the GitHub REST API from the /versions endpoint.",
"name": "GITHUB_GET_ALL_API_VERSIONS",
"parameters": {
"description": "Request model for the GetAllApiVersions action. This action does not require any parameters.",
"properties": {},
"title": "GetAllApiVersionsRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves commit activity (total commits, weekly additions/deletions/commits) for all contributors to a repository; may require a retry if GitHub returns 202 while preparing data.",
"name": "GITHUB_GET_ALL_CONTRIBUTOR_COMMIT_ACTIVITY",
"parameters": {
"description": "Request to retrieve commit activity for all contributors to a repository.",
"properties": {
"owner": {
"description": "Username of the repository owner (case-insensitive).",
"examples": [
"octocat",
"my-organization"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "Repository name, excluding `.git` (case-insensitive).",
"examples": [
"Spoon-Knife",
"my-awesome-project"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo"
],
"title": "GetAllContributorCommitActivityRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Lists all enabled custom deployment protection rules for a specific environment in a repository; the environment must exist and be configured for deployments.",
"name": "GITHUB_GET_ALL_DEPLOYMENT_PROTECTION_RULES_FOR_ENV",
"parameters": {
"description": "Request schema for `GetAllDeploymentProtectionRulesForEnv`",
"properties": {
"environment_name": {
"description": "The name of the environment. This name must be URL-encoded. For instance, if the environment name contains slashes (`/`), they should be replaced with `%2F`.",
"examples": [
"production",
"staging%2Fenvironment"
],
"title": "Environment Name",
"type": "string"
},
"owner": {
"description": "The username or organization name that owns the repository. This field is not case-sensitive.",
"examples": [
"octocat",
"MyOrganization"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the `.git` extension. This field is not case-sensitive.",
"examples": [
"my-awesome-repo",
"Project-X"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"environment_name",
"repo",
"owner"
],
"title": "GetAllDeploymentProtectionRulesForEnvRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves detailed information for a specific milestone within a GitHub repository by its number.",
"name": "GITHUB_GET_A_MILESTONE",
"parameters": {
"description": "Request schema for `GetAMilestone`",
"properties": {
"milestone_number": {
"description": "The unique sequential number identifying the milestone within the repository.",
"examples": [
1,
5,
42
],
"title": "Milestone Number",
"type": "integer"
},
"owner": {
"description": "The username of the account that owns the repository. This field is not case-sensitive.",
"examples": [
"octocat",
"kubernetes"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the `.git` extension. This field is not case-sensitive.",
"examples": [
"Spoon-Knife",
"autoscaler"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"milestone_number"
],
"title": "GetAMilestoneRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves publicly available information for an existing GitHub App, identified by its unique URL-friendly `app_slug`.",
"name": "GITHUB_GET_AN_APP",
"parameters": {
"description": "Request schema for retrieving detailed information about a specific GitHub App.",
"properties": {
"app_slug": {
"description": "The app's unique, URL-friendly, lowercase, hyphenated identifier, derived from its name (e.g., 'my-awesome-app').",
"examples": [
"my-github-app",
"octoapp"
],
"title": "App Slug",
"type": "string"
}
},
"required": [
"app_slug"
],
"title": "GetAnAppRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Gets a specific artifact for a repository by `artifact_id`. This action retrieves the details of a specific artifact from a GitHub repository using the artifact's unique identifier. It allows users to access information about artifacts stored in the repository.",
"name": "GITHUB_GET_AN_ARTIFACT",
"parameters": {
"description": "Request schema for `GetAnArtifact`",
"properties": {
"artifact_id": {
"description": "The unique identifier (ID) of the artifact to retrieve. This ID can be obtained from other API calls that list artifacts.",
"examples": [
"12345",
"67890"
],
"title": "Artifact Id",
"type": "integer"
},
"owner": {
"description": "The username or organization name that owns the repository. This field is not case-sensitive.",
"examples": [
"octocat",
"github"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the `.git` extension. This field is not case-sensitive. ",
"examples": [
"Spoon-Knife",
"docs"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"artifact_id"
],
"title": "GetAnArtifactRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves detailed information for a specific GitHub Classroom assignment if the authenticated user is an administrator of the classroom.",
"name": "GITHUB_GET_AN_ASSIGNMENT",
"parameters": {
"description": "Request schema for `GetAnAssignment`",
"properties": {
"assignment_id": {
"description": "The unique identifier of the GitHub Classroom assignment to retrieve.",
"examples": [
"12345"
],
"title": "Assignment Id",
"type": "integer"
}
},
"required": [
"assignment_id"
],
"title": "GetAnAssignmentRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves a specific autolink reference (which automatically hyperlinks text like 'JIRA-123' to an external system) for a repository using its unique ID; requires administrator access to the repository.",
"name": "GITHUB_GET_AN_AUTOLINK_REFERENCE_OF_A_REPOSITORY",
"parameters": {
"description": "Request schema for `GetAnAutolinkReferenceOfARepository`",
"properties": {
"autolink_id": {
"description": "The unique numeric identifier of the autolink configuration to retrieve. You can get this ID from the 'Get all autolinks of a repository' action.",
"examples": [
123,
456
],
"title": "Autolink Id",
"type": "integer"
},
"owner": {
"description": "The username or organization name that owns the repository. This field is not case-sensitive.",
"examples": [
"octocat",
"my-organization"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the `.git` extension. This field is not case-sensitive.",
"examples": [
"Spoon-Knife",
"my-awesome-project"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"autolink_id"
],
"title": "GetAnAutolinkReferenceOfARepositoryRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves the details of a specific deployment environment for a given repository, including its name, configurations, and current status.",
"name": "GITHUB_GET_AN_ENVIRONMENT",
"parameters": {
"description": "Request schema for retrieving details of a specific deployment environment in a repository.",
"properties": {
"environment_name": {
"description": "The name of the deployment environment. The name must be URL-encoded; for example, any slashes `/` must be replaced with `%2F`.",
"examples": [
"production",
"staging%2Fteam-alpha"
],
"title": "Environment Name",
"type": "string"
},
"owner": {
"description": "The username of the account that owns the repository. This name is not case-sensitive.",
"examples": [
"octocat"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the `.git` extension. This name is not case-sensitive.",
"examples": [
"Hello-World"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"environment_name"
],
"title": "GetAnEnvironmentRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves the public key for a specified GitHub repository environment, used to encrypt secrets for GitHub Actions.",
"name": "GITHUB_GET_AN_ENVIRONMENT_PUBLIC_KEY",
"parameters": {
"description": "Request schema for retrieving the public key for an environment. This key is used to encrypt secrets.",
"properties": {
"environment_name": {
"description": "The name of the environment. The name must be URL encoded. For example, any slashes (`/`) in the name must be replaced with `%2F`.",
"examples": [
"production",
"staging%2Fapp-server"
],
"title": "Environment Name",
"type": "string"
},
"owner": {
"description": "The username or organization name that owns the repository. This field is not case-sensitive.",
"examples": [
"octocat",
"my-organization"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the `.git` extension. This field is not case-sensitive.",
"examples": [
"hello-world",
"my-awesome-project"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"environment_name"
],
"title": "GetAnEnvironmentPublicKeyRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves metadata (name and timestamps) for a single secret in a GitHub Actions environment. Note: The actual secret value is never returned by this API for security reasons.",
"name": "GITHUB_GET_AN_ENVIRONMENT_SECRET",
"parameters": {
"description": "Request model for retrieving a specific environment secret's metadata from a repository.",
"properties": {
"environment_name": {
"description": "Name of the environment (must be URL-encoded if it contains special characters).",
"examples": [
"production",
"staging%2Fv1",
"dev_environment"
],
"title": "Environment Name",
"type": "string"
},
"owner": {
"description": "Username or organization name of the repository owner (not case-sensitive).",
"examples": [
"octocat",
"my-organization"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "Name of the repository, without the `.git` extension (not case-sensitive).",
"examples": [
"hello-world",
"my-awesome-project"
],
"title": "Repo",
"type": "string"
},
"secret_name": {
"description": "Name of the secret to retrieve.",
"examples": [
"DATABASE_PASSWORD",
"API_TOKEN_X"
],
"title": "Secret Name",
"type": "string"
}
},
"required": [
"owner",
"repo",
"environment_name",
"secret_name"
],
"title": "GetAnEnvironmentSecretRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves a specific environment variable from a GitHub Actions environment by repository owner, repository name, environment name, and variable name.",
"name": "GITHUB_GET_AN_ENVIRONMENT_VARIABLE",
"parameters": {
"description": "Request schema for `GetAnEnvironmentVariable` action, specifying the repository, environment, and variable name.",
"properties": {
"environment_name": {
"description": "The name of the GitHub Actions environment. If the name contains special characters (e.g., slashes `/`), it must be URL-encoded (e.g., `staging/feature` becomes `staging%2Ffeature`).",
"examples": [
"production",
"staging%2Fuser_testing"
],
"title": "Environment Name",
"type": "string"
},
"name": {
"description": "The name of the specific environment variable to retrieve.",
"examples": [
"SERVER_URL",
"API_TOKEN_STAGING"
],
"title": "Name",
"type": "string"
},
"owner": {
"description": "The username or organization name that owns the repository. This is not case-sensitive.",
"examples": [
"octocat",
"github"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the `.git` extension. This is not case-sensitive.",
"examples": [
"hello-world",
"docs"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"environment_name",
"name"
],
"title": "GetAnEnvironmentVariableRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves detailed information about a specific issue in a repository using the owner, repository name, and issue number.",
"name": "GITHUB_GET_AN_ISSUE",
"parameters": {
"description": "Request schema for `GetAnIssue`",
"properties": {
"issue_number": {
"description": "The identifying number of the issue.",
"examples": [
1347
],
"title": "Issue Number",
"type": "integer"
},
"owner": {
"description": "Username of the account owning the repository. Not case-sensitive.",
"examples": [
"octocat"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "Name of the repository (without `.git` extension). Not case-sensitive.",
"examples": [
"Hello-World"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"issue_number"
],
"title": "GetAnIssueRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Action to get an issue comment.",
"name": "GITHUB_GET_AN_ISSUE_COMMENT",
"parameters": {
"description": "Request schema for `GetAnIssueComment`. Defines the parameters to identify and retrieve a specific issue comment.",
"properties": {
"comment_id": {
"description": "The unique identifier of the issue comment.",
"examples": [
123456789
],
"title": "Comment Id",
"type": "integer"
},
"owner": {
"description": "The username of the account that owns the repository. This field is not case sensitive.",
"examples": [
"octocat"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the `.git` extension. This field is not case sensitive.",
"examples": [
"Spoon-Knife"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"comment_id"
],
"title": "GetAnIssueCommentRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Fetches details of a specific issue event for a given repository and event ID.",
"name": "GITHUB_GET_AN_ISSUE_EVENT",
"parameters": {
"description": "Request schema for `GetAnIssueEvent`",
"properties": {
"event_id": {
"description": "Unique identifier for the issue event.",
"examples": [
1234567
],
"title": "Event Id",
"type": "integer"
},
"owner": {
"description": "Username of the account owning the repository. Not case-sensitive.",
"examples": [
"octocat"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "Name of the repository, without the `.git` extension. Not case-sensitive.",
"examples": [
"Spoon-Knife"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"event_id"
],
"title": "GetAnIssueEventRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Get an organization",
"name": "GITHUB_GET_AN_ORGANIZATION",
"parameters": {
"description": "Request schema for retrieving a GitHub organization.",
"properties": {
"org": {
"description": "The name of the organization. This name is not case-sensitive.",
"examples": [
"github",
"microsoft",
"google"
],
"title": "Org",
"type": "string"
}
},
"required": [
"org"
],
"title": "GetAnOrganizationRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Action for `GetAnOrganizationPublicKey`.",
"name": "GITHUB_GET_AN_ORGANIZATION_PUBLIC_KEY",
"parameters": {
"description": "Request for `GetAnOrganizationPublicKey`.",
"properties": {
"org": {
"description": "Organization name (case-insensitive).",
"examples": [
"octo-org"
],
"title": "Org",
"type": "string"
}
},
"required": [
"org"
],
"title": "GetAnOrganizationPublicKeyRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves a specific GitHub organization role by its ID.",
"name": "GITHUB_GET_AN_ORGANIZATION_ROLE",
"parameters": {
"description": "Request schema for retrieving a specific organization role by its ID.",
"properties": {
"org": {
"description": "The name of the GitHub organization. This name is not case-sensitive.",
"examples": [
"github",
"my-company-org"
],
"title": "Org",
"type": "string"
},
"role_id": {
"description": "The unique numerical identifier of the role within the organization.",
"examples": [
123,
456
],
"title": "Role Id",
"type": "integer"
}
},
"required": [
"org",
"role_id"
],
"title": "GetAnOrganizationRoleRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Gets an organization secret's metadata (e.g., name, creation/update dates, visibility), but not its encrypted value.",
"name": "GITHUB_GET_AN_ORGANIZATION_SECRET",
"parameters": {
"description": "Request schema for `GetAnOrganizationSecret`",
"properties": {
"org": {
"description": "Organization name (case-insensitive).",
"examples": [
"octo-org"
],
"title": "Org",
"type": "string"
},
"secret_name": {
"description": "Name of the secret.",
"examples": [
"MY_API_TOKEN"
],
"title": "Secret Name",
"type": "string"
}
},
"required": [
"org",
"secret_name"
],
"title": "GetAnOrganizationSecretRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves details (name, value, visibility, timestamps) of a specific, existing variable for an existing GitHub organization.",
"name": "GITHUB_GET_AN_ORGANIZATION_VARIABLE",
"parameters": {
"description": "Request schema for `GetAnOrganizationVariable`",
"properties": {
"name": {
"description": "Name of the organization variable.",
"examples": [
"CI_ENVIRONMENT"
],
"title": "Name",
"type": "string"
},
"org": {
"description": "Name of the organization (case-insensitive).",
"examples": [
"octo-org"
],
"title": "Org",
"type": "string"
}
},
"required": [
"org",
"name"
],
"title": "GetAnOrganizationVariableRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves the full configuration, including subscribed events and delivery settings, for an existing organization webhook.",
"name": "GITHUB_GET_AN_ORGANIZATION_WEBHOOK",
"parameters": {
"description": "Request model for fetching an organization webhook's details.",
"properties": {
"hook_id": {
"description": "The unique identifier of the webhook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
"examples": [
123456789
],
"title": "Hook Id",
"type": "integer"
},
"org": {
"description": "The name of the GitHub organization. This field is not case-sensitive.",
"examples": [
"octo-org"
],
"title": "Org",
"type": "string"
}
},
"required": [
"org",
"hook_id"
],
"title": "GetAnOrganizationWebhookRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves a specific package (by type and name) from an organization, if both the package and organization exist.",
"name": "GITHUB_GET_A_PACKAGE_FOR_AN_ORGANIZATION",
"parameters": {
"description": "Request schema for retrieving a specific package from a GitHub organization.",
"properties": {
"org": {
"description": "Name of the GitHub organization (case-insensitive).",
"examples": [
"my-organization"
],
"title": "Org",
"type": "string"
},
"package_name": {
"description": "The unique name of the package.",
"examples": [
"my-package-name"
],
"title": "Package Name",
"type": "string"
},
"package_type": {
"description": "Type of the package. GitHub Gradle packages use `maven` type. Images from `ghcr.io` (Container registry) use `container` type. Use `docker` for images from `docker.pkg.github.com` (Docker registry), even if migrated to the Container registry.",
"enum": [
"npm",
"maven",
"rubygems",
"docker",
"nuget",
"container"
],
"examples": [
"npm",
"maven",
"rubygems",
"docker",
"nuget",
"container"
],
"title": "Package Type",
"type": "string"
}
},
"required": [
"package_type",
"package_name",
"org"
],
"title": "GetAPackageForAnOrganizationRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves metadata for a specific package owned by a GitHub user, using package type, name, and username as identifiers.",
"name": "GITHUB_GET_A_PACKAGE_FOR_A_USER",
"parameters": {
"description": "Request for retrieving a specific package owned by a GitHub user.",
"properties": {
"package_name": {
"description": "Unique name of the package on GitHub Packages.",
"title": "Package Name",
"type": "string"
},
"package_type": {
"description": "Specifies the package's type. Note: Gradle packages use 'maven'; ghcr.io images use 'container'; 'docker' can find images migrated from docker.pkg.github.com to the Container registry.",
"examples": [
"npm",
"maven",
"rubygems",
"docker",
"nuget",
"container"
],
"title": "Package Type",
"type": "string"
},
"username": {
"description": "GitHub username of the package owner.",
"title": "Username",
"type": "string"
}
},
"required": [
"package_type",
"package_name",
"username"
],
"title": "GetAPackageForAUserRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves detailed information for a specific package owned by the authenticated user.",
"name": "GITHUB_GET_A_PACKAGE_FOR_THE_AUTHENTICATED_USER",
"parameters": {
"description": "Request schema for `GetAPackageForTheAuthenticatedUser`",
"properties": {
"package_name": {
"description": "The unique name of the package as it appears in the registry.",
"examples": [
"my-web-app",
"com.example.utils",
"my-container-image"
],
"title": "Package Name",
"type": "string"
},
"package_type": {
"description": "Type of the package. 'maven' for GitHub's Gradle registry; 'container' for Docker images in GitHub's Container registry (`ghcr.io`); 'docker' for images from GitHub's Docker registry (`docker.pkg.github.com`), including those migrated to the Container registry.",
"examples": [
"npm",
"maven",
"rubygems",
"docker",
"nuget",
"container"
],
"title": "Package Type",
"type": "string"
}
},
"required": [
"package_type",
"package_name"
],
"title": "GetAPackageForTheAuthenticatedUserRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves detailed information for a specific version of a package within an organization.",
"name": "GITHUB_GET_A_PACKAGE_VERSION_FOR_AN_ORGANIZATION",
"parameters": {
"description": "Request schema for retrieving a specific package version within an organization.",
"properties": {
"org": {
"description": "Organization name (case-insensitive).",
"examples": [
"github",
"my-organization"
],
"title": "Org",
"type": "string"
},
"package_name": {
"description": "Unique package name.",
"examples": [
"my-package",
"octo-app"
],
"title": "Package Name",
"type": "string"
},
"package_type": {
"description": "Package type. `maven` for GitHub Gradle registry. `container` for GitHub Container registry (`ghcr.io`) images. `docker` for images from GitHub Docker registry (`docker.pkg.github.com`), including migrated ones.",
"examples": [
"npm",
"maven",
"rubygems",
"docker",
"nuget",
"container"
],
"title": "Package Type",
"type": "string"
},
"package_version_id": {
"description": "Unique ID of the package version.",
"examples": [
12345,
98765
],
"title": "Package Version Id",
"type": "integer"
}
},
"required": [
"package_type",
"package_name",
"org",
"package_version_id"
],
"title": "GetAPackageVersionForAnOrganizationRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves a specific public package version associated with a GitHub user.",
"name": "GITHUB_GET_A_PACKAGE_VERSION_FOR_A_USER",
"parameters": {
"description": "Request schema for retrieving a specific package version for a user on GitHub.",
"properties": {
"package_name": {
"description": "The name of the package.",
"examples": [
"my-custom-package",
"express"
],
"title": "Package Name",
"type": "string"
},
"package_type": {
"description": "The type of package. 'maven' is used for Gradle packages. 'container' is for images in GitHub's Container registry (ghcr.io). 'docker' can be used for images previously in GitHub's Docker registry (docker.pkg.github.com).",
"enum": [
"npm",
"maven",
"rubygems",
"docker",
"nuget",
"container"
],
"examples": [
"npm",
"maven",
"rubygems",
"docker",
"nuget",
"container"
],
"title": "Package Type",
"type": "string"
},
"package_version_id": {
"description": "The unique numeric identifier of the specific package version. Obtain this ID by first listing package versions using the 'list_package_versions_for_a_package_owned_by_a_user' action.",
"examples": [
602564428,
84039048
],
"title": "Package Version Id",
"type": "integer"
},
"username": {
"description": "The GitHub username of the account that owns the package.",
"examples": [
"octocat",
"your-username"
],
"title": "Username",
"type": "string"
}
},
"required": [
"package_type",
"package_name",
"package_version_id",
"username"
],
"title": "GetAPackageVersionForAUserRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves detailed information for an existing specific package version associated with the authenticated user, identified by its type, name, and version ID.",
"name": "GITHUB_GET_A_PACKAGE_VERSION_FOR_THE_AUTHENTICATED_USER",
"parameters": {
"description": "Defines the parameters required to retrieve a specific package version for the authenticated user.",
"properties": {
"package_name": {
"description": "The name of the package, which can be case-sensitive depending on the package type.",
"examples": [
"my-package",
"your-awesome-app"
],
"title": "Package Name",
"type": "string"
},
"package_type": {
"description": "The package type. Note: GitHub's Gradle registry packages use 'maven'; ghcr.io images use 'container'; 'docker' can refer to images from docker.pkg.github.com.",
"examples": [
"npm",
"maven",
"rubygems",
"docker",
"nuget",
"container"
],
"title": "Package Type",
"type": "string"
},
"package_version_id": {
"description": "The unique numerical identifier (ID) of the specific package version.",
"examples": [
"12345",
"98760"
],
"title": "Package Version Id",
"type": "integer"
}
},
"required": [
"package_type",
"package_name",
"package_version_id"
],
"title": "GetAPackageVersionForTheAuthenticatedUserRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves detailed information for a specific GitHub project (V2) using its project number and owner. Note: This action uses GitHub's Projects V2 REST API. The legacy Projects (classic) REST API was sunset on April 1, 2025. The project is identified by its number (visible in the project URL) and owner (either a username or organization name). If no owner is specified, the authenticated user is assumed.",
"name": "GITHUB_GET_A_PROJECT",
"parameters": {
"description": "Request schema for `GetAProject`",
"properties": {
"org": {
"description": "The organization that owns the project. If provided, this takes precedence over username.",
"examples": [
"github",
"microsoft"
],
"title": "Org",
"type": "string"
},
"project_number": {
"description": "The project's sequential number (e.g., 1, 2, 3). This is displayed in the project URL as https://github.com/users/{username}/projects/{project_number}.",
"examples": [
1,
5,
10
],
"title": "Project Number",
"type": "integer"
},
"username": {
"description": "The GitHub username who owns the project. If not provided, defaults to the authenticated user.",
"examples": [
"octocat",
"composio-dev"
],
"title": "Username",
"type": "string"
}
},
"required": [
"project_number"
],
"title": "GetAProjectRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves all details of a specific project card, given its unique `card_id`. DEPRECATION NOTICE: GitHub Projects (classic) REST API was sunset on April 1, 2025. This action only works with existing classic project cards that were created before the sunset date. For new projects, use GitHub Projects V2 (GraphQL API) instead.",
"name": "GITHUB_GET_A_PROJECT_CARD",
"parameters": {
"description": "Request schema for retrieving a specific project card by its ID.",
"properties": {
"card_id": {
"description": "The unique identifier of the project card.",
"examples": [
10526908
],
"title": "Card Id",
"type": "integer"
}
},
"required": [
"card_id"
],
"title": "GetAProjectCardRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves detailed information for a specific project column from GitHub Projects (classic). DEPRECATION NOTICE: GitHub Classic Projects (V1) and its REST API were sunset on April 1, 2025. This action will return 404 for most requests on GitHub.com. However, it may still work on GitHub Enterprise Server instances where classic projects are enabled. For new projects, use GitHub Projects V2 which uses the GraphQL API instead. See: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ Returns column details including: id, name, url, project_url, cards_url, node_id, created_at, and updated_at timestamps.",
"name": "GITHUB_GET_A_PROJECT_COLUMN",
"parameters": {
"description": "Request schema for retrieving a project column from GitHub Projects (classic).",
"properties": {
"column_id": {
"description": "The unique integer identifier of the project column to retrieve. This ID can be obtained from the 'list_project_columns' action or from the column's API URL (e.g., /projects/columns/12345).",
"examples": [
367,
1024748,
2098123
],
"title": "Column Id",
"type": "integer"
}
},
"required": [
"column_id"
],
"title": "GetAProjectColumnRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves a specific pull request from a GitHub repository using its owner, repository name, and pull request number.",
"name": "GITHUB_GET_A_PULL_REQUEST",
"parameters": {
"description": "Request schema for `GetAPullRequest`",
"properties": {
"owner": {
"description": "The username of the account that owns the repository. This value is not case sensitive.",
"examples": [
"octocat"
],
"title": "Owner",
"type": "string"
},
"pull_number": {
"description": "The number that identifies the specific pull request.",
"examples": [
1347
],
"title": "Pull Number",
"type": "integer"
},
"repo": {
"description": "The name of the repository, without the .git extension. This value is not case sensitive.",
"examples": [
"Hello-World"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"pull_number"
],
"title": "GetAPullRequestRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves a specific Git reference (e.g., a branch, tag, or fully qualified like 'heads/main') from a GitHub repository. The reference must exist in the repository; use 'list_matching_references' first if unsure what references are available.",
"name": "GITHUB_GET_A_REFERENCE",
"parameters": {
"description": "Request schema for `GetAReference`",
"properties": {
"owner": {
"description": "The username or organization name that owns the repository. This field is not case-sensitive.",
"examples": [
"octocat",
"google"
],
"title": "Owner",
"type": "string"
},
"ref": {
"description": "The Git reference to retrieve. Must be formatted as `heads/<branch_name>` for branches, `tags/<tag_name>` for tags, or `pull/<number>/head` (or `pull/<number>/merge`) for pull requests. Simple branch names (e.g., `main`) are automatically converted to `heads/<name>`. The reference must exist in the repository; a 404 error is returned if not found. If unsure which references exist, use 'list_matching_references' or 'get_a_branch' first. Note: Commit SHAs are not supported by this endpoint; use commit-specific endpoints instead. Not all repositories use 'master'; many now use 'main' as the default branch.",
"examples": [
"heads/main",
"tags/v1.2.3",
"heads/feature-branch",
"pull/42/head"
],
"title": "Ref",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the `.git` extension. This field is not case-sensitive.",
"examples": [
"Hello-World",
"mercury"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"ref"
],
"title": "GetAReferenceRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Gets a specific release from a GitHub repository, provided the repository is accessible and the release exists.",
"name": "GITHUB_GET_A_RELEASE",
"parameters": {
"description": "Request schema for retrieving a specific release from a GitHub repository.",
"properties": {
"owner": {
"description": "The username of the account that owns the repository. This field is not case-sensitive.",
"examples": [
"octocat",
"my-organization"
],
"title": "Owner",
"type": "string"
},
"release_id": {
"description": "The unique numerical identifier for the release.",
"examples": [
"1",
"12345"
],
"title": "Release Id",
"type": "integer"
},
"repo": {
"description": "The name of the repository, without the '.git' extension. This field is not case-sensitive.",
"examples": [
"Hello-World",
"my-awesome-project"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"release_id"
],
"title": "GetAReleaseRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Gets metadata for a specific release asset in a GitHub repository, including a `browser_download_url` for downloading the asset.",
"name": "GITHUB_GET_A_RELEASE_ASSET",
"parameters": {
"description": "Request schema for `GetAReleaseAsset`",
"properties": {
"asset_id": {
"description": "The unique numeric identifier of the release asset.",
"examples": [
"1234567"
],
"title": "Asset Id",
"type": "integer"
},
"owner": {
"description": "The account owner of the repository (GitHub username or organization name). This name is not case sensitive.",
"examples": [
"octocat"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the `.git` extension. This name is not case sensitive.",
"examples": [
"Spoon-Knife"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"asset_id"
],
"title": "GetAReleaseAssetRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Gets a release from a GitHub repository by its tag name; the repository and a release with this tag must already exist.",
"name": "GITHUB_GET_A_RELEASE_BY_TAG_NAME",
"parameters": {
"description": "Request schema for `GetAReleaseByTagName`",
"properties": {
"owner": {
"description": "Account owner of the repository (not case sensitive).",
"examples": [
"octocat"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "Name of the repository, without the `.git` extension (not case sensitive).",
"examples": [
"Hello-World"
],
"title": "Repo",
"type": "string"
},
"tag": {
"description": "Tag identifying the release to fetch.",
"examples": [
"v1.0.0"
],
"title": "Tag",
"type": "string"
}
},
"required": [
"owner",
"repo",
"tag"
],
"title": "GetAReleaseByTagNameRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves detailed information about an existing and accessible GitHub repository.",
"name": "GITHUB_GET_A_REPOSITORY",
"parameters": {
"description": "Request schema for retrieving detailed information about a specific GitHub repository.",
"properties": {
"owner": {
"description": "The username of the account that owns the repository. This field is case-insensitive.",
"examples": [
"octocat",
"kubernetes"
],
"minLength": 1,
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository, without the `.git` extension. This field is case-insensitive.",
"examples": [
"Hello-World",
"kubernetes"
],
"minLength": 1,
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo"
],
"title": "GetARepositoryRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Gets a repository's public key for encrypting secrets to be used in GitHub Actions, if the repository exists and is accessible.",
"name": "GITHUB_GET_A_REPOSITORY_PUBLIC_KEY",
"parameters": {
"description": "Request schema for `GetARepositoryPublicKey`",
"properties": {
"owner": {
"description": "Account owner of the repository (case-insensitive).",
"examples": [
"octocat"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "Name of the repository without the `.git` extension (case-insensitive).",
"examples": [
"hello-world"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo"
],
"title": "GetARepositoryPublicKeyRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Fetches the README file (if it exists and is accessible) from a specified GitHub repository, returning its Base64-encoded content and metadata.",
"name": "GITHUB_GET_A_REPOSITORY_README",
"parameters": {
"description": "Request schema for `GetARepositoryReadme`",
"properties": {
"owner": {
"description": "The GitHub account owner of the repository. This name is not case-sensitive.",
"examples": [
"octocat",
"my-organization"
],
"title": "Owner",
"type": "string"
},
"ref": {
"description": "The specific git reference (branch name, tag name, or commit SHA) to retrieve the README from. If omitted, the repository's default branch is used.",
"examples": [
"main",
"develop",
"v2.1.0",
"c23a31f32747a8e2a13f8c11699a5e4e9148f2be"
],
"title": "Ref",
"type": "string"
},
"repo": {
"description": "The name of the repository, excluding the `.git` extension. This name is not case-sensitive.",
"examples": [
"Hello-World",
"my-project-name"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo"
],
"title": "GetARepositoryReadmeRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves the README file from a specified directory within a GitHub repository, optionally at a given commit, branch, or tag.",
"name": "GITHUB_GET_A_REPOSITORY_README_FOR_A_DIRECTORY",
"parameters": {
"description": "Request schema for `GetARepositoryReadmeForADirectory`",
"properties": {
"dir": {
"description": "Path to the directory containing the README file.",
"examples": [
"docs",
"src/my_package"
],
"title": "Dir",
"type": "string"
},
"owner": {
"description": "Username of the account owning the repository (not case sensitive).",
"examples": [
"octocat"
],
"title": "Owner",
"type": "string"
},
"ref": {
"description": "Commit, branch, or tag name; defaults to the repository's default branch if not provided.",
"examples": [
"main",
"v1.0.0",
"my-feature-branch"
],
"title": "Ref",
"type": "string"
},
"repo": {
"description": "Name of the repository, without the `.git` extension (not case sensitive).",
"examples": [
"Hello-World"
],
"title": "Repo",
"type": "string"
}
},
"required": [
"owner",
"repo",
"dir"
],
"title": "GetARepositoryReadmeForADirectoryRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Retrieves a specific repository ruleset by its ID; if `includes_parents` is true, the search for this `ruleset_id` also extends to rulesets from parent organizations.",
"name": "GITHUB_GET_A_REPOSITORY_RULESET",
"parameters": {
"description": "Request to retrieve a specific ruleset for a GitHub repository, which governs interactions with its branches and tags.",
"properties": {
"includes_parents": {
"default": true,
"description": "If true, also returns rulesets configured at higher levels (e.g., organization) that apply to this repository.",
"title": "Includes Parents",
"type": "boolean"
},
"owner": {
"description": "Account owner of the repository (username or organization); case-insensitive.",
"examples": [
"octocat",
"github"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "Repository name, excluding `.git` extension; case-insensitive.",
"examples": [
"Spoon-Knife",
"docs"
],
"title": "Repo",
"type": "string"
},
"ruleset_id": {
"description": "Unique identifier of the ruleset.",
"examples": [
12345,
54321
],
"title": "Ruleset Id",
"type": "integer"
}
},
"required": [
"owner",
"repo",
"ruleset_id"
],
"title": "GetARepositoryRulesetRequest",
"type": "object"
}
},
"type": "function"
},
{
"function": {
"description": "Gets detailed information for a specific repository rule suite by its ID, including its evaluation status and the results of its individual rules.",
"name": "GITHUB_GET_A_REPOSITORY_RULE_SUITE",
"parameters": {
"description": "Request schema for `GetARepositoryRuleSuite`",
"properties": {
"owner": {
"description": "The username of the account or the name of the organization that owns the repository. This name is not case-sensitive.",
"examples": [
"octocat"
],
"title": "Owner",
"type": "string"
},
"repo": {
"description": "The name of the repository, excluding the `.git` extension. This name is not case-sensitive.",
"examples": [
"hello-world"
],
"title": "Repo",
"type": "string"
},
"rule_suite_id": {
"description": "The unique identifier of the rule suite. To obtain this ID, you can list rule suites for the repository (e.g., via `GET /repos/{owner}/{repo}/rulesets/rule-suites`) or organization (e.g., via `GET /orgs/{org}/rulesets/rule-suites`).",
"title": "Rule Suite Id",
"type": "integer"
}
},
"required": [
"owner",
"repo",
"rule_suite_id"
],
"title": "GetARepositoryRuleSuiteRequest",
"type": "object"
}
},
"type": "function"
}
]