GitHub's official MCP Server
SaferSkills independently audited Github Mcp Server (Agent Skill) and scored it 100/100 (green). The audit ran 55 deterministic rules across Security, Supply Chain, Maintenance, Transparency, and Community; it found 0 high-severity and 0 lower-severity findings. The full rule-by-rule trace and per-finding evidence are below. Free, methodology-open.
Findings & checks · 0 flagged
Every scanned point with the score it earned and what moved between them.
First recorded scan — no prior version to compare against.
The primary manifest — the file an agent reads to learn what this artifact does.
The GitHub MCP Server connects AI tools directly to GitHub's platform. This gives AI agents, assistants, and chatbots the ability to read repositories and code files, manage issues and PRs, analyze code, and automate workflows. All through natural language interactions.
Built for developers who want to connect their AI tools to GitHub context and capabilities, from simple natural language queries to complex multi-step agent workflows.
The remote GitHub MCP Server is hosted by GitHub and provides the easiest method for getting up and running. If your MCP host does not support remote MCP servers, don't worry! You can use the local version of the GitHub MCP Server instead.
For quick installation, use one of the one-click install buttons above. Once you complete that flow, toggle Agent mode (located by the Copilot Chat text input) and the server will start. Make sure you're using VS Code 1.101 or later for remote MCP and OAuth support.
Alternatively, to manually configure VS Code, choose the appropriate JSON block from the examples below and add it to your host configuration:
<table> <tr><th>Using OAuth</th><th>Using a GitHub PAT</th></tr> <tr><th align=left colspan=2>VS Code (version 1.101 or greater)</th></tr> <tr valign=top> <td>
{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/"
}
}
}</td> <td>
{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/",
"headers": {
"Authorization": "Bearer ${input:github_mcp_pat}"
}
}
},
"inputs": [
{
"type": "promptString",
"id": "github_mcp_pat",
"description": "GitHub Personal Access Token",
"password": true
}
]
}</td> </tr> </table>
Note: Each MCP host application needs to configure a GitHub App or OAuth App to support remote access via OAuth. Any host application that supports remote MCP servers should support the remote GitHub server with PAT authentication. Configuration details and support levels vary by host. Make sure to refer to the host application's documentation for more info.
#### Toolset configuration
See Remote Server Documentation for full details on remote server configuration, toolsets, headers, and advanced usage. This file provides comprehensive instructions and examples for connecting, customizing, and installing the remote GitHub MCP Server in VS Code and other MCP hosts.
When no toolsets are specified, default toolsets are used.
#### Insiders Mode
Try new features early! The remote server offers an insiders version with early access to new features and experimental tools.
<table> <tr><th>Using URL Path</th><th>Using Header</th></tr> <tr valign=top> <td>
{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/insiders"
}
}
}</td> <td>
{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/",
"headers": {
"X-MCP-Insiders": "true"
}
}
}
}</td> </tr> </table>
See Remote Server Documentation for more details and examples, and Insiders Features for a full list of what's available.
#### GitHub Enterprise
##### GitHub Enterprise Cloud with data residency (ghe.com)
GitHub Enterprise Cloud can also make use of the remote server.
Example for https://octocorp.ghe.com with GitHub PAT token:
{
...
"github-octocorp": {
"type": "http",
"url": "https://copilot-api.octocorp.ghe.com/mcp",
"headers": {
"Authorization": "Bearer ${input:github_mcp_pat}"
}
},
...
}Note: When using OAuth with GitHub Enterprise with VS Code and GitHub Copilot, you also need to configure your VS Code settings to point to your GitHub Enterprise instance - see Authenticate from VS Code
##### GitHub Enterprise Server
GitHub Enterprise Server does not support remote server hosting. Please refer to GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com) from the local server configuration.
ghcr.io/github/github-mcp-server. The image is public; if you get errors on pull, you may have an expired token and need to docker logout ghcr.io.The MCP server can use many of the GitHub APIs, so enable the permissions that you feel comfortable granting your AI tools (to learn more about access tokens, please check out the documentation).
<details><summary><b>Handling PATs Securely</b></summary>
To keep your GitHub PAT secure and reusable across different MCP hosts:
export GITHUB_PAT=your_token_hereOr create a .env file:
GITHUB_PAT=your_token_here # Add to .gitignore to prevent accidental commits
echo ".env" >> .gitignore # CLI usage
claude mcp add github -e GITHUB_PERSONAL_ACCESS_TOKEN=$GITHUB_PAT -- docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN ghcr.io/github/github-mcp-server
# In config files (where supported)
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "$GITHUB_PAT"
}Note: Environment variable support varies by host app and IDE. Some applications (like Windsurf) require hardcoded tokens in config files.
repo - Repository operationsread:packages - Docker image accessread:org - Organization team access chmod 600 ~/.your-app/config.json</details>
The flag --gh-host and the environment variable GITHUB_HOST can be used to set the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data residency.
https:// URI scheme, as it otherwise defaults to http://, which GitHub Enterprise Server does not support.https://YOURSUBDOMAIN.ghe.com as the hostname."github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"-e",
"GITHUB_HOST",
"ghcr.io/github/github-mcp-server"
],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
"GITHUB_HOST": "https://<your GHES or ghe.com domain name>"
}
}For quick installation, use one of the one-click install buttons above. Once you complete that flow, toggle Agent mode (located by the Copilot Chat text input) and the server will start.
More about using MCP server tools in VS Code's agent mode documentation.
Install in GitHub Copilot on other IDEs (JetBrains, Visual Studio, Eclipse, etc.)
Add the following JSON block to your IDE's MCP settings.
{
"mcp": {
"inputs": [
{
"type": "promptString",
"id": "github_token",
"description": "GitHub Personal Access Token",
"password": true
}
],
"servers": {
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"ghcr.io/github/github-mcp-server"
],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}"
}
}
}
}
}Optionally, you can add a similar example (i.e. without the mcp key) to a file called .vscode/mcp.json in your workspace. This will allow you to share the configuration with other host applications that accept the same format.
<details> <summary><b>Example JSON block without the MCP key included</b></summary> <br>
{
"inputs": [
{
"type": "promptString",
"id": "github_token",
"description": "GitHub Personal Access Token",
"password": true
}
],
"servers": {
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"ghcr.io/github/github-mcp-server"
],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}"
}
}
}
}</details>
For other MCP host applications, please refer to our installation guides:
For a complete overview of all installation options, see our [Installation Guides Index](docs/installation-guides).
Note: Any host application that supports local MCP servers should be able to access the local GitHub MCP server. However, the specific configuration process, syntax and stability of the integration will vary by host application. While many may follow a similar format to the examples above, this is not guaranteed. Please refer to your host application's documentation for the correct MCP configuration syntax and setup process.
If you don't have Docker, you can use go build to build the binary in the cmd/github-mcp-server directory, and use the github-mcp-server stdio command with the GITHUB_PERSONAL_ACCESS_TOKEN environment variable set to your token. To specify the output location of the build, use the -o flag. You should configure your server to use the built executable as its command. For example:
{
"mcp": {
"servers": {
"github": {
"command": "/path/to/github-mcp-server",
"args": ["stdio"],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
}
}
}
}
}The github-mcp-server binary includes a few CLI subcommands that are helpful for debugging and exploring the server.
github-mcp-server tool-search "<query>" searches tools by name, description, and input parameter names. Use --max-results to return more matches.Example (color output requires a TTY; use docker run -t (or -it) when running in Docker):
docker run -it --rm ghcr.io/github/github-mcp-server tool-search "issue" --max-results 5
github-mcp-server tool-search "issue" --max-results 5The GitHub MCP Server supports enabling or disabling specific groups of functionalities via the --toolsets flag. This allows you to control which GitHub API capabilities are available to your AI tools. Enabling only the toolsets that you need can help the LLM with tool choice and reduce the context size.
_Toolsets are not limited to Tools. Relevant MCP Resources and Prompts are also included where applicable._
When no toolsets are specified, default toolsets are used.
Looking for examples? See the Server Configuration Guide for common recipes like minimal setups, read-only mode, and combining tools with toolsets.
#### Specifying Toolsets
To specify toolsets you want available to the LLM, you can pass an allow-list in two ways:
github-mcp-server --toolsets repos,issues,pull_requests,actions,code_security GITHUB_TOOLSETS="repos,issues,pull_requests,actions,code_security" ./github-mcp-serverThe environment variable GITHUB_TOOLSETS takes precedence over the command line argument if both are provided.
#### Specifying Individual Tools
You can also configure specific tools using the --tools flag. Tools can be used independently or combined with toolsets for fine-grained control.
github-mcp-server --tools get_file_contents,issue_read,create_pull_request GITHUB_TOOLS="get_file_contents,issue_read,create_pull_request" ./github-mcp-server github-mcp-server --toolsets repos,issues --tools get_gistThis registers all tools from repos and issues toolsets, plus get_gist.
Important Notes:
--read-only is set, even if explicitly requested via --toolsget_file_contents, not getFileContents). Invalid tool names will cause the server to fail at startup with an error messageWhen using Docker, you can pass the toolsets as environment variables:
docker run -i --rm \
-e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> \
-e GITHUB_TOOLSETS="repos,issues,pull_requests,actions,code_security" \
ghcr.io/github/github-mcp-serverWhen using Docker, you can pass specific tools as environment variables. You can also combine tools with toolsets:
# Tools only
docker run -i --rm \
-e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> \
-e GITHUB_TOOLS="get_file_contents,issue_read,create_pull_request" \
ghcr.io/github/github-mcp-server
# Tools combined with toolsets (additive)
docker run -i --rm \
-e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> \
-e GITHUB_TOOLSETS="repos,issues" \
-e GITHUB_TOOLS="get_gist" \
ghcr.io/github/github-mcp-server#### "all" toolset
The special toolset all can be provided to enable all available toolsets regardless of any other configuration:
./github-mcp-server --toolsets allOr using the environment variable:
GITHUB_TOOLSETS="all" ./github-mcp-server#### "default" toolset
The default toolset default is the configuration that gets passed to the server if no toolsets are specified.
The default configuration is:
To keep the default configuration and add additional toolsets:
GITHUB_TOOLSETS="default,stargazers" ./github-mcp-serverThe local GitHub MCP Server offers an insiders version with early access to new features and experimental tools.
./github-mcp-server --insiders GITHUB_INSIDERS=true ./github-mcp-serverWhen using Docker:
docker run -i --rm \
-e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> \
-e GITHUB_INSIDERS=true \
ghcr.io/github/github-mcp-serverThe following sets of tools are available:
<!-- START AUTOMATED TOOLSETS -->
| Toolset | Description | |
|---|---|---|
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/person-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/person-light.png"><img src="pkg/octicons/icons/person-light.png" width="20" height="20" alt="person"></picture> | context | Strongly recommended: Tools that provide context about the current user and GitHub context you are operating in |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/workflow-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/workflow-light.png"><img src="pkg/octicons/icons/workflow-light.png" width="20" height="20" alt="workflow"></picture> | actions | GitHub Actions workflows and CI/CD operations |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/code-square-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/code-square-light.png"><img src="pkg/octicons/icons/code-square-light.png" width="20" height="20" alt="code-square"></picture> | code_quality | GitHub Code Quality related tools |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/codescan-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/codescan-light.png"><img src="pkg/octicons/icons/codescan-light.png" width="20" height="20" alt="codescan"></picture> | code_security | Code security related tools, such as GitHub Code Scanning |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/copilot-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/copilot-light.png"><img src="pkg/octicons/icons/copilot-light.png" width="20" height="20" alt="copilot"></picture> | copilot | Copilot related tools |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/dependabot-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/dependabot-light.png"><img src="pkg/octicons/icons/dependabot-light.png" width="20" height="20" alt="dependabot"></picture> | dependabot | Dependabot tools |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/comment-discussion-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/comment-discussion-light.png"><img src="pkg/octicons/icons/comment-discussion-light.png" width="20" height="20" alt="comment-discussion"></picture> | discussions | GitHub Discussions related tools |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/logo-gist-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/logo-gist-light.png"><img src="pkg/octicons/icons/logo-gist-light.png" width="20" height="20" alt="logo-gist"></picture> | gists | GitHub Gist related tools |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/git-branch-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/git-branch-light.png"><img src="pkg/octicons/icons/git-branch-light.png" width="20" height="20" alt="git-branch"></picture> | git | GitHub Git API related tools for low-level Git operations |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/issue-opened-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/issue-opened-light.png"><img src="pkg/octicons/icons/issue-opened-light.png" width="20" height="20" alt="issue-opened"></picture> | issues | GitHub Issues related tools |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/tag-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/tag-light.png"><img src="pkg/octicons/icons/tag-light.png" width="20" height="20" alt="tag"></picture> | labels | GitHub Labels related tools |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/bell-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/bell-light.png"><img src="pkg/octicons/icons/bell-light.png" width="20" height="20" alt="bell"></picture> | notifications | GitHub Notifications related tools |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/organization-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/organization-light.png"><img src="pkg/octicons/icons/organization-light.png" width="20" height="20" alt="organization"></picture> | orgs | GitHub Organization related tools |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/project-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/project-light.png"><img src="pkg/octicons/icons/project-light.png" width="20" height="20" alt="project"></picture> | projects | GitHub Projects related tools |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/git-pull-request-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/git-pull-request-light.png"><img src="pkg/octicons/icons/git-pull-request-light.png" width="20" height="20" alt="git-pull-request"></picture> | pull_requests | GitHub Pull Request related tools |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/repo-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/repo-light.png"><img src="pkg/octicons/icons/repo-light.png" width="20" height="20" alt="repo"></picture> | repos | GitHub Repository related tools |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/shield-lock-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/shield-lock-light.png"><img src="pkg/octicons/icons/shield-lock-light.png" width="20" height="20" alt="shield-lock"></picture> | secret_protection | Secret protection related tools, such as GitHub Secret Scanning |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/shield-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/shield-light.png"><img src="pkg/octicons/icons/shield-light.png" width="20" height="20" alt="shield"></picture> | security_advisories | Security advisories related tools |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/star-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/star-light.png"><img src="pkg/octicons/icons/star-light.png" width="20" height="20" alt="star"></picture> | stargazers | GitHub Stargazers related tools |
| <picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/people-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/people-light.png"><img src="pkg/octicons/icons/people-light.png" width="20" height="20" alt="people"></picture> | users | GitHub User related tools |
<!-- END AUTOMATED TOOLSETS -->
| Toolset | Description |
|---|---|
copilot | Copilot related tools (e.g. Copilot Coding Agent) |
copilot_spaces | Copilot Spaces related tools |
github_support_docs_search | Search docs to answer GitHub product and support questions |
<!-- START AUTOMATED TOOLS --> <details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/workflow-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/workflow-light.png"><img src="pkg/octicons/icons/workflow-light.png" width="20" height="20" alt="workflow"></picture> Actions</summary>
repomethod: The method to execute (string, required)owner: Repository owner (string, required)repo: Repository name (string, required)resource_id: The unique identifier of the resource. This will vary based on the "method" provided, so ensure you provide the correct ID:(string, required)
repomethod: The action to perform (string, required)owner: Repository owner (string, required)page: Page number for pagination (default: 1) (number, optional)per_page: Results per page for pagination (default: 30, max: 100) (number, optional)repo: Repository name (string, required)resource_id: The unique identifier of the resource. This will vary based on the "method" provided, so ensure you provide the correct ID:(string, optional)
workflow_jobs_filter: Filters for workflow jobs. ONLY used when method is 'list_workflow_jobs' (object, optional)workflow_runs_filter: Filters for workflow runs. ONLY used when method is 'list_workflow_runs' (object, optional)repoinputs: Inputs the workflow accepts. Only used for 'run_workflow' method. (object, optional)method: The method to execute (string, required)owner: Repository owner (string, required)ref: The git reference for the workflow. The reference can be a branch or tag name. Required for 'run_workflow' method. (string, optional)repo: Repository name (string, required)run_id: The ID of the workflow run. Required for all methods except 'run_workflow'. (number, optional)workflow_id: The workflow ID (numeric) or workflow file name (e.g., main.yml, ci.yaml). Required for 'run_workflow' method. (string, optional)repofailed_only: When true, gets logs for all failed jobs in the workflow run specified by run_id. Requires run_id to be provided. (boolean, optional)job_id: The unique identifier of the workflow job. Required when getting logs for a single job. (number, optional)owner: Repository owner (string, required)repo: Repository name (string, required)return_content: Returns actual log content instead of URLs (boolean, optional)run_id: The unique identifier of the workflow run. Required when failed_only is true to get logs for all failed jobs in the run. (number, optional)tail_lines: Number of lines to return from the end of the log (number, optional)</details>
<details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/code-square-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/code-square-light.png"><img src="pkg/octicons/icons/code-square-light.png" width="20" height="20" alt="code-square"></picture> Code Quality</summary>
repofindingNumber: The number of the finding. (number, required)owner: The owner of the repository. (string, required)repo: The name of the repository. (string, required)</details>
<details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/codescan-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/codescan-light.png"><img src="pkg/octicons/icons/codescan-light.png" width="20" height="20" alt="codescan"></picture> Code Security</summary>
security_eventsrepo, security_eventsalertNumber: The number of the alert. (number, required)owner: The owner of the repository. (string, required)repo: The name of the repository. (string, required)security_eventsrepo, security_eventsowner: The owner of the repository. (string, required)page: Page number for pagination (min 1) (number, optional)perPage: Results per page for pagination (min 1, max 100) (number, optional)ref: The Git reference for the results you want to list. (string, optional)repo: The name of the repository. (string, required)severity: Filter code scanning alerts by severity (string, optional)state: Filter code scanning alerts by state. Defaults to open (string, optional)tool_name: The name of the tool used for code scanning. (string, optional)</details>
<details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/person-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/person-light.png"><img src="pkg/octicons/icons/person-light.png" width="20" height="20" alt="person"></picture> Context</summary>
read:orgadmin:org, read:org, write:orgorg: Organization login (owner) that contains the team. (string, required)team_slug: Team slug (string, required)read:orgadmin:org, read:org, write:orguser: Username to get teams for. If not provided, uses the authenticated user. (string, optional)</details>
<details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/copilot-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/copilot-light.png"><img src="pkg/octicons/icons/copilot-light.png" width="20" height="20" alt="copilot"></picture> Copilot</summary>
repobase_ref: Git reference (e.g., branch) that the agent will start its work from. If not specified, defaults to the repository's default branch (string, optional)custom_instructions: Optional custom instructions to guide the agent beyond the issue body. Use this to provide additional context, constraints, or guidance that is not captured in the issue description (string, optional)issue_number: Issue number (number, required)owner: Repository owner (string, required)repo: Repository name (string, required)repoowner: Repository owner (string, required)pullNumber: Pull request number (number, required)repo: Repository name (string, required)</details>
<details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/dependabot-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/dependabot-light.png"><img src="pkg/octicons/icons/dependabot-light.png" width="20" height="20" alt="dependabot"></picture> Dependabot</summary>
security_eventsrepo, security_eventsalertNumber: The number of the alert. (number, required)owner: The owner of the repository. (string, required)repo: The name of the repository. (string, required)security_eventsrepo, security_eventsafter: Cursor for pagination. Use the cursor from the previous response. (string, optional)owner: The owner of the repository. (string, required)perPage: Results per page for pagination (min 1, max 100) (number, optional)repo: The name of the repository. (string, required)severity: Filter dependabot alerts by severity (string, optional)state: Filter dependabot alerts by state. Defaults to open (string, optional)</details>
<details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/comment-discussion-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/comment-discussion-light.png"><img src="pkg/octicons/icons/comment-discussion-light.png" width="20" height="20" alt="comment-discussion"></picture> Discussions</summary>
repobody: Comment content (required for 'add', 'reply', and 'update' methods) (string, optional)commentNodeID: The Node ID of the discussion comment (required for 'reply', 'update', 'delete', 'mark_answer', and 'unmark_answer' methods). For 'reply', this is the top-level comment to reply to; GitHub Discussions only support one level of nesting. (string, optional)discussionNumber: Discussion number (required for 'add' and 'reply' methods) (number, optional)method: Write operation to perform on a discussion comment.Options are:
(string, required)
owner: Repository owner (required for 'add' and 'reply' methods) (string, optional)repo: Repository name (required for 'add' and 'reply' methods) (string, optional)repodiscussionNumber: Discussion Number (number, required)owner: Repository owner (string, required)repo: Repository name (string, required)repoafter: Cursor for pagination. Use the cursor from the previous response. (string, optional)discussionNumber: Discussion Number (number, required)includeReplies: When true, each top-level comment will include its replies nested within it (up to 100 replies per comment, which is the GitHub API maximum). Defaults to false. (boolean, optional)owner: Repository owner (string, required)perPage: Results per page for pagination (min 1, max 100) (number, optional)repo: Repository name (string, required)repoowner: Repository owner (string, required)repo: Repository name. If not provided, discussion categories will be queried at the organisation level. (string, optional)repoafter: Cursor for pagination. Use the cursor from the previous response. (string, optional)category: Optional filter by discussion category ID. If provided, only discussions with this category are listed. (string, optional)direction: Order direction. (string, optional)orderBy: Order discussions by field. If provided, the 'direction' also needs to be provided. (string, optional)owner: Repository owner (string, required)perPage: Results per page for pagination (min 1, max 100) (number, optional)repo: Repository name. If not provided, discussions will be queried at the organisation level. (string, optional)</details>
<details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/logo-gist-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/logo-gist-light.png"><img src="pkg/octicons/icons/logo-gist-light.png" width="20" height="20" alt="logo-gist"></picture> Gists</summary>
gistcontent: Content for simple single-file gist creation (string, required)description: Description of the gist (string, optional)filename: Filename for simple single-file gist creation (string, required)public: Whether the gist is public (boolean, optional)gist_id: The ID of the gist (string, required)page: Page number for pagination (min 1) (number, optional)perPage: Results per page for pagination (min 1, max 100) (number, optional)since: Only gists updated after this time (ISO 8601 timestamp) (string, optional)username: GitHub username (omit for authenticated user's gists) (string, optional)gistcontent: Content for the file (string, required)description: Updated description of the gist (string, optional)filename: Filename to update or create (string, required)gist_id: ID of the gist to update (string, required)</details>
<details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/git-branch-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/git-branch-light.png"><img src="pkg/octicons/icons/git-branch-light.png" width="20" height="20" alt="git-branch"></picture> Git</summary>
repoowner: Repository owner (username or organization) (string, required)path_filter: Optional path prefix to filter the tree results (e.g., 'src/' to only show files in the src directory) (string, optional)recursive: Setting this parameter to true returns the objects or subtrees referenced by the tree. Default is false (boolean, optional)repo: Repository name (string, required)tree_sha: The SHA1 value or ref (branch or tag) name of the tree. Defaults to the repository's default branch (string, optional)</details>
<details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/issue-opened-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/issue-opened-light.png"><img src="pkg/octicons/icons/issue-opened-light.png" width="20" height="20" alt="issue-opened"></picture> Issues</summary>
repobody: Comment content (string, required)issue_number: Issue number to comment on (number, required)owner: Repository owner (string, required)repo: Repository name (string, required)reponame: Label name. (string, required)owner: Repository owner (username or organization name) (string, required)repo: Repository name (string, required)repoissue_number: The number of the issue (number, required)method: The read operation to perform on a single issue.Options are:
(string, required)
owner: The owner of the repository (string, required)page: Page number for pagination (min 1) (number, optional)perPage: Results per page for pagination (min 1, max 100) (number, optional)repo: The name of the repository (string, required)repoassignees: Usernames to assign to this issue (string[], optional)body: Issue body content (string, optional)duplicate_of: Issue number that this issue is a duplicate of. Only used when state_reason is 'duplicate'. (number, optional)issue_fields: Issue field values to set or clear. Each item requires 'field_name' and exactly one of 'value', 'field_option_name', or 'delete: true'. (object[], optional)issue_number: Issue number to update (number, optional)labels: Labels to apply to this issue (string[], optional)method: Write operation to perform on a single issue.Options are:
(string, required)
milestone: Milestone number (number, optional)owner: Repository owner (string, required)repo: Repository name (string, required)state: New state (string, optional)state_reason: Reason for the state change. Ignored unless state is changed. (string, optional)title: Issue title (string, optional)type: Type of this issue. Only use if issue types are enabled for this repository. Use list_issue_types tool to get valid type values for this repository or its owner organization. If the repository doesn't support issue types, omit this parameter. (string, optional)repo, read:orgadmin:org, read:org, repo, write:orgowner: The account owner of the repository or organization. The name is not case sensitive. (string, required)repo: The name of the repository. When provided, returns fields for this specific repository (inherited from its organization). When omitted, returns org-level fields directly. (string, optional)repo, read:orgadmin:org, read:org, repo, write:orgowner: The account owner of the repository or organization. (string, required)repo: The name of the repository. When provided, returns issue types for this specific repository. When omitted, returns org-level issue types directly. (string, optional)repoafter: Cursor for pagination. Use the cursor from the previous response. (string, optional)direction: Order direction. If provided, the 'orderBy' also needs to be provided. (string, optional)field_filters: Filter by custom issue field values. Each entry takes a field_name and a value; the server looks up the field and coerces the value to its type (single-select option name, text, number, or YYYY-MM-DD date). (object[], optional)labels: Filter by labels (string[], optional)orderBy: Order issues by field. If provided, the 'direction' also needs to be provided. (string, optional)owner: Repository owner (string, required)perPage: Results per page for pagination (min 1, max 100) (number, optional)repo: Repository name (string, required)since: Filter by date (ISO 8601 timestamp) (string, optional)state: Filter by state, by default both open and closed issues are returned when not provided (string, optional)repoorder: Sort order (string, optional)owner: Optional repository owner. If provided with repo, only issues for this repository are listed. (string, optional)page: Page number for pagination (min 1) (number, optional)perPage: Results per page for pagination (min 1, max 100) (number, optional)query: Search query using GitHub issues search syntax (string, required)repo: Optional repository name. If provided with owner, only issues for this repository are listed. (string, optional)sort: Sort field by number of matches of categories, defaults to best match (string, optional)repoafter_id: The ID of the sub-issue to be prioritized after (either after_id OR before_id should be specified) (number, optional)before_id: The ID of the sub-issue to be prioritized before (either after_id OR before_id should be specified) (number, optional)issue_number: The number of the parent issue (number, required)method: The action to perform on a single sub-issueOptions are:
(string, required)
owner: Repository owner (string, required)replace_parent: When true, replaces the sub-issue's current parent issue. Use with 'add' method only. (boolean, optional)repo: Repository name (string, required)sub_issue_id: The ID of the sub-issue to add. ID is not the same as issue number (number, required)</details>
<details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/tag-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/tag-light.png"><img src="pkg/octicons/icons/tag-light.png" width="20" height="20" alt="tag"></picture> Labels</summary>
reponame: Label name. (string, required)owner: Repository owner (username or organization name) (string, required)repo: Repository name (string, required)repocolor: Label color as 6-character hex code without '#' prefix (e.g., 'f29513'). Required for 'create', optional for 'update'. (string, optional)description: Label description text. Optional for 'create' and 'update'. (string, optional)method: Operation to perform: 'create', 'update', or 'delete' (string, required)name: Label name - required for all operations (string, required)new_name: New name for the label (used only with 'update' method to rename) (string, optional)owner: Repository owner (username or organization name) (string, required)repo: Repository name (string, required)repoowner: Repository owner (username or organization name) - required for all operations (string, required)repo: Repository name - required for all operations (string, required)</details>
<details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/bell-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/bell-light.png"><img src="pkg/octicons/icons/bell-light.png" width="20" height="20" alt="bell"></picture> Notifications</summary>
notificationsstate: The new state of the notification (read/done) (string, required)threadID: The ID of the notification thread (string, required)notificationsnotificationID: The ID of the notification (string, required)notificationsbefore: Only show notifications updated before the given time (ISO 8601 format) (string, optional)filter: Filter notifications to, use default unless specified. Read notifications are ones that have already been acknowledged by the user. Participating notifications are those that the user is directly involved in, such as issues or pull requests they have commented on or created. (string, optional)owner: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional)page: Page number for pagination (min 1) (number, optional)perPage: Results per page for pagination (min 1, max 100) (number, optional)repo: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional)since: Only show notifications updated after the given time (ISO 8601 format) (string, optional)notificationsaction: Action to perform: ignore, watch, or delete the notification subscription. (string, required)notificationID: The ID of the notification thread. (string, required)notificationsaction: Action to perform: ignore, watch, or delete the repository notification subscription. (string, required)owner: The account owner of the repository. (string, required)repo: The name of the repository. (string, required)notificationslastReadAt: Describes the last point that notifications were checked (optional). Default: Now (string, optional)owner: Optional repository owner. If provided with repo, only notifications for this repository are marked as read. (string, optional)repo: Optional repository name. If provided with owner, only notifications for this repository are marked as read. (string, optional)</details>
<details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/organization-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/organization-light.png"><img src="pkg/octicons/icons/organization-light.png" width="20" height="20" alt="organization"></picture> Organizations</summary>
read:orgadmin:org, read:org, write:orgorder: Sort order (string, optional)page: Page number for pagination (min 1) (number, optional)perPage: Results per page for pagination (min 1, max 100) (number, optional)query: Organization search query. Examples: 'microsoft', 'location:california', 'created:>=2025-01-01'. Search is automatically scoped to type:org. (string, required)sort: Sort field by category (string, optional)</details>
<details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/project-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/project-light.png"><img src="pkg/octicons/icons/project-light.png" width="20" height="20" alt="project"></picture> Projects</summary>
read:projectproject, read:projectfield_id: The field's ID. Required for 'get_project_field' method. (number, optional)fields: Specific list of field IDs to include in the response when getting a project item (e.g. ["102589", "985201", "169875"]). If not provided, only the title field is included. Only used for 'get_project_item' method. (string[], optional)item_id: The item's ID. Required for 'get_project_item' method. (number, optional)method: The method to execute (string, required)owner: The owner (user or organization login). The name is not case sensitive. (string, optional)owner_type: Owner type (user or org). If not provided, will be automatically detected. (string, optional)project_number: The project's number. (number, optional)status_update_id: The node ID of the project status update. Required for 'get_project_status_update' method. (string, optional)read:projectproject, read:projectafter: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional)before: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional)fields: Field IDs to include when listing project items (e.g. ["102589", "985201"]). CRITICAL: Always provide to get field values. Without this, only titles returned. Only used for 'list_project_items' method. (string[], optional)method: The action to perform (string, required)owner: The owner (user or organization login). The name is not case sensitive. (string, required)owner_type: Owner type (user or org). If not provided, will automatically try both. (string, optional)per_page: Results per page (max 50) (number, optional)project_number: The project's number. Required for 'list_project_fields', 'list_project_items', and 'list_project_status_updates' methods. (number, optional)query: Filter/query string. For list_projects: filter by title text and state (e.g. "roadmap is:open"). For list_project_items: advanced filtering using GitHub's project filtering syntax. (string, optional)projectbody: The body of the status update (markdown). Used for 'create_project_status_update' method. (string, optional)field_name: The name of the iteration field (e.g. 'Sprint'). Required for 'create_iteration_field' method. (string, optional)issue_number: The issue number (use when item_type is 'issue' for 'add_project_item' method). Provide either issue_number or pull_request_number. (number, optional)item_id: The project item ID. Required for 'update_project_item' and 'delete_project_item' methods. (number, optional)item_owner: The owner (user or organization) of the repository containing the issue or pull request. Required for 'add_project_item' method. (string, optional)item_repo: The name of the repository containing the issue or pull request. Required for 'add_project_item' method. (string, optional)item_type: The item's type, either issue or pull_request. Required for 'add_project_item' method. (string, optional)iteration_duration: Duration in days for iterations of the field (e.g. 7 for weekly, 14 for bi-weekly). Required for 'create_iteration_field' method. (number, optional)iterations: Custom iterations for 'create_iteration_field' method. Only set this when you need iterations with varying durations, breaks between them, or specific titles. Otherwise omit it: GitHub auto-creates three iterations of 'iteration_duration' days starting on 'start_date', which is the right choice for most cases. (object[], optional)method: The method to execute (string, required)owner: The project owner (user or organization login). The name is not case sensitive. (string, required)owner_type: Owner type (user or org). Required for 'create_project' method. If not provided for other methods, will be automatically detected. (string, optional)project_number: The project's number. Required for all methods except 'create_project'. (number, optional)pull_request_number: The pull request number (use when item_type is 'pull_request' for 'add_project_item' method). Provide either issue_number or pull_request_number. (number, optional)start_date: Start date in YYYY-MM-DD format. Used for 'create_project_status_update' and 'create_iteration_field' methods. (string, optional)status: The status of the project. Used for 'create_project_status_update' method. (string, optional)target_date: The target date of the status update in YYYY-MM-DD format. Used for 'create_project_status_update' method. (string, optional)title: The project title. Required for 'create_project' method. (string, optional)updated_field: Object consisting of the ID of the project field to update and the new value for the field. To clear the field, set value to null. Example: {"id": 123456, "value": "New Value"}. Required for 'update_project_item' method. (object, optional)</details>
<details>
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/git-pull-request-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/git-pull-request-light.png"><img src="pkg/octicons/icons/git-pull-request-light.png" width="20" height="20" alt="git-pull-request"></picture> Pull Requests</summary>
repobody: The text of the review comment (string, required)line: The line of the blob in the pull request diff that the comment applies to. For multi-line comments, the last line of the range (number, optional)owner: Repository owner (string, required)path: The relative path to the file that necessitates a comment (string, required)pullNumber: Pull request number (number, required)repo: Repository name (string, required)side: The side of the diff to comment on. LEFT indicates the previous state, RIGHT indicates the new state (string, optional)startLine: For multi-line comments, the first line of the range that the comment applies to (number, optional)startSide: For multi-line comments, the starting side of the diff that the comment applies to. LEFT indicates the previous state, RIGHT indicates the new state (string, optional)subjectType: The level at which the comment is targeted (string, required)repobody: The text of the reply (string, required)commentId: The ID of the comment to reply to (number, required)owner: Repository owner (string, required)pullNumber: Pull request number (number, required)repo: Repository name (string, require~30 seconds. Free. No account. Every finding cites a rule and a line of evidence.