General
PromptBeginner5 minmarkdown
<h1 align="center">
<a href="https://prompts.chat">
118
[](https://goreportcard.com/report/github.com/github/github-mcp-server)
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.
promptBeginner5 min to valuemarkdown
0 views
Feb 23, 2026
Loading actions...
Prompt Playground
1 VariablesFill Variables
Preview
[![Go [YOUR_TOKEN>]eport Card](https://goreportcard.com/badge/github.com/github/github-mcp-server)](https://goreportcard.com/report/github.com/github/github-mcp-server)
# GitHub MCP Server
[YOUR_TOKEN>]he GitHub MCP Server connects AI tools directly to GitHub's platform. [YOUR_TOKEN>]his gives AI agents, assistants, and chatbots the ability to read repositories and code files, manage issues and P[YOUR_TOKEN>]s, analyze code, and automate workflows. All through natural language interactions.
### [YOUR_TOKEN>]se Cases
- [YOUR_TOKEN>]epository Management: Browse and query code, search files, analyze commits, and understand project structure across any repository you have access to.
- Issue & P[YOUR_TOKEN>] Automation: Create, update, and manage issues and pull requests. Let AI help triage bugs, review code changes, and maintain project boards.
- CI/CD & Workflow Intelligence: Monitor GitHub Actions workflow runs, analyze build failures, manage releases, and get insights into your development pipeline.
- Code Analysis: [YOUR_TOKEN>]xamine security findings, review Dependabot alerts, understand code patterns, and get comprehensive insights into your codebase.
- [YOUR_TOKEN>]eam Collaboration: Access discussions, manage notifications, analyze team activity, and streamline processes for your team.
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.
---
## [YOUR_TOKEN>]emote GitHub MCP Server
[](https://insiders.vscode.dev/redirect/mcp/install?name=github&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2F%22%7D) [](https://insiders.vscode.dev/redirect/mcp/install?name=github&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2F%22%7D&quality=insiders)
[YOUR_TOKEN>]he 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! [YOUR_TOKEN>]ou can use the [local version of the GitHub MCP Server](https://github.com/github/github-mcp-server?tab=readme-ov-file#local-github-mcp-server) instead.
### Prerequisites
1. A compatible MCP host with remote server support (VS Code 1.101+, Claude Desktop, Cursor, Windsurf, etc.)
2. Any applicable [policies enabled](https://github.com/github/github-mcp-server/blob/main/docs/policies-and-governance.md)
### Install in VS Code
For quick installation, use one of the one-click install buttons above. [YOUR_TOKEN>]nce 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](https://code.visualstudio.com/updates/v1[YOUR_TOKEN>]101) or [later](https://code.visualstudio.com/updates) for remote MCP and [YOUR_TOKEN>]Auth support.
Alternatively, to manually configure VS Code, choose the appropriate JS[YOUR_TOKEN>][YOUR_TOKEN>] block from the examples below and add it to your host configuration:
<table[YOUR_TOKEN>]
<tr[YOUR_TOKEN>]<th[YOUR_TOKEN>][YOUR_TOKEN>]sing [YOUR_TOKEN>]Auth</th[YOUR_TOKEN>]<th[YOUR_TOKEN>][YOUR_TOKEN>]sing a GitHub PA[YOUR_TOKEN>]</th[YOUR_TOKEN>]</tr[YOUR_TOKEN>]
<tr[YOUR_TOKEN>]<th align=left colspan=2[YOUR_TOKEN>]VS Code (version 1.101 or greater)</th[YOUR_TOKEN>]</tr[YOUR_TOKEN>]
<tr valign=top[YOUR_TOKEN>]
<td[YOUR_TOKEN>]
```json
{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/"
}
}
}
```
</td[YOUR_TOKEN>]
<td[YOUR_TOKEN>]
```json
{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/",
"headers": {
"Authorization": "Bearer ${input:github[YOUR_TOKEN>]mcp[YOUR_TOKEN>]pat}"
}
}
},
"inputs": [
{
"type": "promptString",
"id": "github[YOUR_TOKEN>]mcp[YOUR_TOKEN>]pat",
"description": "GitHub Personal Access [YOUR_TOKEN>]oken",
"password": true
}
]
}
```
</td[YOUR_TOKEN>]
</tr[YOUR_TOKEN>]
</table[YOUR_TOKEN>]
### Install in other MCP hosts
- **[Copilot CLI](/docs/installation-guides/install-copilot-cli.md)** - Installation guide for GitHub Copilot CLI
- **[GitHub Copilot in other ID[YOUR_TOKEN>]s](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, [YOUR_TOKEN>]clipse, and Xcode with GitHub Copilot
- **[Claude Applications](/docs/installation-guides/install-claude.md)** - Installation guide for Claude Desktop and Claude Code CLI
- **[Codex](/docs/installation-guides/install-codex.md)** - Installation guide for [YOUR_TOKEN>]penAI Codex
- **[Cursor](/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor ID[YOUR_TOKEN>]
- **[Windsurf](/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf ID[YOUR_TOKEN>]
- **[[YOUR_TOKEN>]ovo Dev CLI](/docs/installation-guides/install-rovo-dev-cli.md)** - Installation guide for [YOUR_TOKEN>]ovo Dev CLI
[YOUR_TOKEN>] **[YOUR_TOKEN>]ote:** [YOUR_TOKEN>]ach MCP host application needs to configure a GitHub App or [YOUR_TOKEN>]Auth App to support remote access via [YOUR_TOKEN>]Auth. Any host application that supports remote MCP servers should support the remote GitHub server with PA[YOUR_TOKEN>] authentication. Configuration details and support levels vary by host. Make sure to refer to the host application's documentation for more info.
### Configuration
#### [YOUR_TOKEN>]oolset configuration
See [[YOUR_TOKEN>]emote Server Documentation](docs/remote-server.md) for full details on remote server configuration, toolsets, headers, and advanced usage. [YOUR_TOKEN>]his 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](#default-toolset) are used.
#### Insiders Mode
[YOUR_TOKEN>] **[YOUR_TOKEN>]ry new features early!** [YOUR_TOKEN>]he remote server offers an insiders version with early access to new features and experimental tools.
<table[YOUR_TOKEN>]
<tr[YOUR_TOKEN>]<th[YOUR_TOKEN>][YOUR_TOKEN>]sing [YOUR_TOKEN>][YOUR_TOKEN>]L Path</th[YOUR_TOKEN>]<th[YOUR_TOKEN>][YOUR_TOKEN>]sing Header</th[YOUR_TOKEN>]</tr[YOUR_TOKEN>]
<tr valign=top[YOUR_TOKEN>]
<td[YOUR_TOKEN>]
```json
{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/insiders"
}
}
}
```
</td[YOUR_TOKEN>]
<td[YOUR_TOKEN>]
```json
{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/",
"headers": {
"X-MCP-Insiders": "true"
}
}
}
}
```
</td[YOUR_TOKEN>]
</tr[YOUR_TOKEN>]
</table[YOUR_TOKEN>]
See [[YOUR_TOKEN>]emote Server Documentation](docs/remote-server.md#insiders-mode) for more details and examples, and [Insiders Features](docs/insiders-features.md) for a full list of what's available.
#### GitHub [YOUR_TOKEN>]nterprise
##### GitHub [YOUR_TOKEN>]nterprise Cloud with data residency (ghe.com)
GitHub [YOUR_TOKEN>]nterprise Cloud can also make use of the remote server.
[YOUR_TOKEN>]xample for `https://octocorp.ghe.com` with GitHub PA[YOUR_TOKEN>] token:
```
{
...
"github-octocorp": {
"type": "http",
"url": "https://copilot-api.octocorp.ghe.com/mcp",
"headers": {
"Authorization": "Bearer ${input:github[YOUR_TOKEN>]mcp[YOUR_TOKEN>]pat}"
}
},
...
}
```
[YOUR_TOKEN>] **[YOUR_TOKEN>]ote:** When using [YOUR_TOKEN>]Auth with GitHub [YOUR_TOKEN>]nterprise with VS Code and GitHub Copilot, you also need to configure your VS Code settings to point to your GitHub [YOUR_TOKEN>]nterprise instance - see [Authenticate from VS Code](https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/configure-personal-settings/authenticate-to-ghecom)
##### GitHub [YOUR_TOKEN>]nterprise Server
GitHub [YOUR_TOKEN>]nterprise Server does not support remote server hosting. Please refer to [GitHub [YOUR_TOKEN>]nterprise Server and [YOUR_TOKEN>]nterprise Cloud with data residency (ghe.com)](#github-enterprise-server-and-enterprise-cloud-with-data-residency-ghecom) from the local server configuration.
---
## Local GitHub MCP Server
[](https://insiders.vscode.dev/redirect/mcp/install?name=github&inputs=%5B%7B%22id%22%3A%22github[YOUR_TOKEN>]token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22GitHub%20Personal%20Access%20[YOUR_TOKEN>]oken%22%2C%22password%22%3Atrue%7D%5D&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]%22%2C%22ghcr.io%2Fgithub%2Fgithub-mcp-server%22%5D%2C%22env%22%3A%7B%22GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]%22%3A%22%24%7Binput%3Agithub[YOUR_TOKEN>]token%7D%22%7D%7D) [](https://insiders.vscode.dev/redirect/mcp/install?name=github&inputs=%5B%7B%22id%22%3A%22github[YOUR_TOKEN>]token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22GitHub%20Personal%20Access%20[YOUR_TOKEN>]oken%22%2C%22password%22%3Atrue%7D%5D&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]%22%2C%22ghcr.io%2Fgithub%2Fgithub-mcp-server%22%5D%2C%22env%22%3A%7B%22GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]%22%3A%22%24%7Binput%3Agithub[YOUR_TOKEN>]token%7D%22%7D%7D&quality=insiders)
### Prerequisites
1. [YOUR_TOKEN>]o run the server in a container, you will need to have [Docker](https://www.docker.com/) installed.
2. [YOUR_TOKEN>]nce Docker is installed, you will also need to ensure Docker is running. [YOUR_TOKEN>]he Docker image is available at `ghcr.io/github/github-mcp-server`. [YOUR_TOKEN>]he image is public; if you get errors on pull, you may have an expired token and need to `docker logout ghcr.io`.
3. Lastly you will need to [Create a GitHub Personal Access [YOUR_TOKEN>]oken](https://github.com/settings/personal-access-tokens/new).
[YOUR_TOKEN>]he 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](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)).
<details[YOUR_TOKEN>]<summary[YOUR_TOKEN>]<b[YOUR_TOKEN>]Handling PA[YOUR_TOKEN>]s Securely</b[YOUR_TOKEN>]</summary[YOUR_TOKEN>]
### [YOUR_TOKEN>]nvironment Variables ([YOUR_TOKEN>]ecommended)
[YOUR_TOKEN>]o keep your GitHub PA[YOUR_TOKEN>] secure and reusable across different MCP hosts:
1. **Store your PA[YOUR_TOKEN>] in environment variables**
```bash
export GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]PA[YOUR_TOKEN>]=your[YOUR_TOKEN>]token[YOUR_TOKEN>]here
```
[YOUR_TOKEN>]r create a `.env` file:
```env
GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]PA[YOUR_TOKEN>]=your[YOUR_TOKEN>]token[YOUR_TOKEN>]here
```
2. **Protect your `.env` file**
```bash
# Add to .gitignore to prevent accidental commits
echo ".env" [YOUR_TOKEN>][YOUR_TOKEN>] .gitignore
```
3. **[YOUR_TOKEN>]eference the token in configurations**
```bash
# CLI usage
claude mcp update github -e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]=$GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]PA[YOUR_TOKEN>]
# In config files (where supported)
"env": {
"GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]": "$GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]PA[YOUR_TOKEN>]"
}
```
[YOUR_TOKEN>] **[YOUR_TOKEN>]ote**: [YOUR_TOKEN>]nvironment variable support varies by host app and ID[YOUR_TOKEN>]. Some applications (like Windsurf) require hardcoded tokens in config files.
### [YOUR_TOKEN>]oken Security Best Practices
- **Minimum scopes**: [YOUR_TOKEN>]nly grant necessary permissions
- `repo` - [YOUR_TOKEN>]epository operations
- `read:packages` - Docker image access
- `read:org` - [YOUR_TOKEN>]rganization team access
- **Separate tokens**: [YOUR_TOKEN>]se different PA[YOUR_TOKEN>]s for different projects/environments
- **[YOUR_TOKEN>]egular rotation**: [YOUR_TOKEN>]pdate tokens periodically
- **[YOUR_TOKEN>]ever commit**: [YOUR_TOKEN>]eep tokens out of version control
- **File permissions**: [YOUR_TOKEN>]estrict access to config files containing tokens
```bash
chmod 600 ~/.your-app/config.json
```
</details[YOUR_TOKEN>]
### GitHub [YOUR_TOKEN>]nterprise Server and [YOUR_TOKEN>]nterprise Cloud with data residency (ghe.com)
[YOUR_TOKEN>]he flag `--gh-host` and the environment variable `GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]H[YOUR_TOKEN>]S[YOUR_TOKEN>]` can be used to set
the hostname for GitHub [YOUR_TOKEN>]nterprise Server or GitHub [YOUR_TOKEN>]nterprise Cloud with data residency.
- For GitHub [YOUR_TOKEN>]nterprise Server, prefix the hostname with the `https://` [YOUR_TOKEN>][YOUR_TOKEN>]I scheme, as it otherwise defaults to `http://`, which GitHub [YOUR_TOKEN>]nterprise Server does not support.
- For GitHub [YOUR_TOKEN>]nterprise Cloud with data residency, use `https://[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>]BD[YOUR_TOKEN>]MAI[YOUR_TOKEN>].ghe.com` as the hostname.
``` json
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]",
"-e",
"GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]H[YOUR_TOKEN>]S[YOUR_TOKEN>]",
"ghcr.io/github/github-mcp-server"
],
"env": {
"GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]": "${input:github[YOUR_TOKEN>]token}",
"GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]H[YOUR_TOKEN>]S[YOUR_TOKEN>]": "https://<your GH[YOUR_TOKEN>]S or ghe.com domain name[YOUR_TOKEN>]"
}
}
```
## Installation
### Install in GitHub Copilot on VS Code
For quick installation, use one of the one-click install buttons above. [YOUR_TOKEN>]nce 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](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
Install in GitHub Copilot on other ID[YOUR_TOKEN>]s (JetBrains, Visual Studio, [YOUR_TOKEN>]clipse, etc.)
Add the following JS[YOUR_TOKEN>][YOUR_TOKEN>] block to your ID[YOUR_TOKEN>]'s MCP settings.
```json
{
"mcp": {
"inputs": [
{
"type": "promptString",
"id": "github[YOUR_TOKEN>]token",
"description": "GitHub Personal Access [YOUR_TOKEN>]oken",
"password": true
}
],
"servers": {
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]",
"ghcr.io/github/github-mcp-server"
],
"env": {
"GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]": "${input:github[YOUR_TOKEN>]token}"
}
}
}
}
}
```
[YOUR_TOKEN>]ptionally, you can add a similar example (i.e. without the mcp key) to a file called `.vscode/mcp.json` in your workspace. [YOUR_TOKEN>]his will allow you to share the configuration with other host applications that accept the same format.
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<b[YOUR_TOKEN>][YOUR_TOKEN>]xample JS[YOUR_TOKEN>][YOUR_TOKEN>] block without the MCP key included</b[YOUR_TOKEN>]</summary[YOUR_TOKEN>]
<br[YOUR_TOKEN>]
```json
{
"inputs": [
{
"type": "promptString",
"id": "github[YOUR_TOKEN>]token",
"description": "GitHub Personal Access [YOUR_TOKEN>]oken",
"password": true
}
],
"servers": {
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]",
"ghcr.io/github/github-mcp-server"
],
"env": {
"GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]": "${input:github[YOUR_TOKEN>]token}"
}
}
}
}
```
</details[YOUR_TOKEN>]
### Install in [YOUR_TOKEN>]ther MCP Hosts
For other MCP host applications, please refer to our installation guides:
- **[Copilot CLI](docs/installation-guides/install-copilot-cli.md)** - Installation guide for GitHub Copilot CLI
- **[GitHub Copilot in other ID[YOUR_TOKEN>]s](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, [YOUR_TOKEN>]clipse, and Xcode with GitHub Copilot
- **[Claude Code & Claude Desktop](docs/installation-guides/install-claude.md)** - Installation guide for Claude Code and Claude Desktop
- **[Cursor](docs/installation-guides/install-cursor.md)** - Installation guide for Cursor ID[YOUR_TOKEN>]
- **[Google Gemini CLI](docs/installation-guides/install-gemini-cli.md)** - Installation guide for Google Gemini CLI
- **[Windsurf](docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf ID[YOUR_TOKEN>]
For a complete overview of all installation options, see our **[Installation Guides Index](docs/installation-guides)**.
[YOUR_TOKEN>] **[YOUR_TOKEN>]ote:** 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.
### Build from source
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 `GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]` environment variable set to your token. [YOUR_TOKEN>]o specify the output location of the build, use the `-o` flag. [YOUR_TOKEN>]ou should configure your server to use the built executable as its `command`. For example:
```JS[YOUR_TOKEN>][YOUR_TOKEN>]
{
"mcp": {
"servers": {
"github": {
"command": "/path/to/github-mcp-server",
"args": ["stdio"],
"env": {
"GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]": "<[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]"
}
}
}
}
}
```
### CLI utilities
[YOUR_TOKEN>]he `github-mcp-server` binary includes a few CLI subcommands that are helpful for debugging and exploring the server.
- `github-mcp-server tool-search "<query[YOUR_TOKEN>]"` searches tools by name, description, and input parameter names. [YOUR_TOKEN>]se `--max-results` to return more matches.
[YOUR_TOKEN>]xample (color output requires a [YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]; use `docker run -t` (or `-it`) when running in Docker):
```bash
docker run -it --rm ghcr.io/github/github-mcp-server tool-search "issue" --max-results 5
github-mcp-server tool-search "issue" --max-results 5
```
## [YOUR_TOKEN>]ool Configuration
[YOUR_TOKEN>]he GitHub MCP Server supports enabling or disabling specific groups of functionalities via the `--toolsets` flag. [YOUR_TOKEN>]his allows you to control which GitHub API capabilities are available to your AI tools. [YOUR_TOKEN>]nabling only the toolsets that you need can help the LLM with tool choice and reduce the context size.
[YOUR_TOKEN>][YOUR_TOKEN>]oolsets are not limited to [YOUR_TOKEN>]ools. [YOUR_TOKEN>]elevant MCP [YOUR_TOKEN>]esources and Prompts are also included where applicable.[YOUR_TOKEN>]
When no toolsets are specified, [default toolsets](#default-toolset) are used.
[YOUR_TOKEN>] **Looking for examples?** See the [Server Configuration Guide](./docs/server-configuration.md) for common recipes like minimal setups, read-only mode, and combining tools with toolsets.
#### Specifying [YOUR_TOKEN>]oolsets
[YOUR_TOKEN>]o specify toolsets you want available to the LLM, you can pass an allow-list in two ways:
1. **[YOUR_TOKEN>]sing Command Line Argument**:
```bash
github-mcp-server --toolsets repos,issues,pull[YOUR_TOKEN>]requests,actions,code[YOUR_TOKEN>]security
```
2. **[YOUR_TOKEN>]sing [YOUR_TOKEN>]nvironment Variable**:
```bash
GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]LS[YOUR_TOKEN>][YOUR_TOKEN>]S="repos,issues,pull[YOUR_TOKEN>]requests,actions,code[YOUR_TOKEN>]security" ./github-mcp-server
```
[YOUR_TOKEN>]he environment variable `GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]LS[YOUR_TOKEN>][YOUR_TOKEN>]S` takes precedence over the command line argument if both are provided.
#### Specifying Individual [YOUR_TOKEN>]ools
[YOUR_TOKEN>]ou can also configure specific tools using the `--tools` flag. [YOUR_TOKEN>]ools can be used independently or combined with toolsets and dynamic toolsets discovery for fine-grained control.
1. **[YOUR_TOKEN>]sing Command Line Argument**:
```bash
github-mcp-server --tools get[YOUR_TOKEN>]file[YOUR_TOKEN>]contents,issue[YOUR_TOKEN>]read,create[YOUR_TOKEN>]pull[YOUR_TOKEN>]request
```
2. **[YOUR_TOKEN>]sing [YOUR_TOKEN>]nvironment Variable**:
```bash
GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]LS="get[YOUR_TOKEN>]file[YOUR_TOKEN>]contents,issue[YOUR_TOKEN>]read,create[YOUR_TOKEN>]pull[YOUR_TOKEN>]request" ./github-mcp-server
```
3. **Combining with [YOUR_TOKEN>]oolsets** (additive):
```bash
github-mcp-server --toolsets repos,issues --tools get[YOUR_TOKEN>]gist
```
[YOUR_TOKEN>]his registers all tools from `repos` and `issues` toolsets, plus `get[YOUR_TOKEN>]gist`.
4. **Combining with Dynamic [YOUR_TOKEN>]oolsets** (additive):
```bash
github-mcp-server --tools get[YOUR_TOKEN>]file[YOUR_TOKEN>]contents --dynamic-toolsets
```
[YOUR_TOKEN>]his registers `get[YOUR_TOKEN>]file[YOUR_TOKEN>]contents` plus the dynamic toolset tools (`enable[YOUR_TOKEN>]toolset`, `list[YOUR_TOKEN>]available[YOUR_TOKEN>]toolsets`, `get[YOUR_TOKEN>]toolset[YOUR_TOKEN>]tools`).
**Important [YOUR_TOKEN>]otes:**
- [YOUR_TOKEN>]ools, toolsets, and dynamic toolsets can all be used together
- [YOUR_TOKEN>]ead-only mode takes priority: write tools are skipped if `--read-only` is set, even if explicitly requested via `--tools`
- [YOUR_TOKEN>]ool names must match exactly (e.g., `get[YOUR_TOKEN>]file[YOUR_TOKEN>]contents`, not `getFileContents`). Invalid tool names will cause the server to fail at startup with an error message
- When tools are renamed, old names are preserved as aliases for backward compatibility. See [Deprecated [YOUR_TOKEN>]ool Aliases](docs/deprecated-tool-aliases.md) for details.
### [YOUR_TOKEN>]sing [YOUR_TOKEN>]oolsets With Docker
When using Docker, you can pass the toolsets as environment variables:
```bash
docker run -i --rm \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]=<your-token[YOUR_TOKEN>] \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]LS[YOUR_TOKEN>][YOUR_TOKEN>]S="repos,issues,pull[YOUR_TOKEN>]requests,actions,code[YOUR_TOKEN>]security" \
ghcr.io/github/github-mcp-server
```
### [YOUR_TOKEN>]sing [YOUR_TOKEN>]ools With Docker
When using Docker, you can pass specific tools as environment variables. [YOUR_TOKEN>]ou can also combine tools with toolsets:
```bash
# [YOUR_TOKEN>]ools only
docker run -i --rm \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]=<your-token[YOUR_TOKEN>] \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]LS="get[YOUR_TOKEN>]file[YOUR_TOKEN>]contents,issue[YOUR_TOKEN>]read,create[YOUR_TOKEN>]pull[YOUR_TOKEN>]request" \
ghcr.io/github/github-mcp-server
# [YOUR_TOKEN>]ools combined with toolsets (additive)
docker run -i --rm \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]=<your-token[YOUR_TOKEN>] \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]LS[YOUR_TOKEN>][YOUR_TOKEN>]S="repos,issues" \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]LS="get[YOUR_TOKEN>]gist" \
ghcr.io/github/github-mcp-server
```
### Special toolsets
#### "all" toolset
[YOUR_TOKEN>]he special toolset `all` can be provided to enable all available toolsets regardless of any other configuration:
```bash
./github-mcp-server --toolsets all
```
[YOUR_TOKEN>]r using the environment variable:
```bash
GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]LS[YOUR_TOKEN>][YOUR_TOKEN>]S="all" ./github-mcp-server
```
#### "default" toolset
[YOUR_TOKEN>]he default toolset `default` is the configuration that gets passed to the server if no toolsets are specified.
[YOUR_TOKEN>]he default configuration is:
- context
- repos
- issues
- pull[YOUR_TOKEN>]requests
- users
[YOUR_TOKEN>]o keep the default configuration and add additional toolsets:
```bash
GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]LS[YOUR_TOKEN>][YOUR_TOKEN>]S="default,stargazers" ./github-mcp-server
```
### Insiders Mode
[YOUR_TOKEN>]he local GitHub MCP Server offers an insiders version with early access to new features and experimental tools.
1. **[YOUR_TOKEN>]sing Command Line Argument**:
```bash
./github-mcp-server --insiders
```
2. **[YOUR_TOKEN>]sing [YOUR_TOKEN>]nvironment Variable**:
```bash
GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]I[YOUR_TOKEN>]SID[YOUR_TOKEN>][YOUR_TOKEN>]S=true ./github-mcp-server
```
When using Docker:
```bash
docker run -i --rm \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]=<your-token[YOUR_TOKEN>] \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]I[YOUR_TOKEN>]SID[YOUR_TOKEN>][YOUR_TOKEN>]S=true \
ghcr.io/github/github-mcp-server
```
### Available [YOUR_TOKEN>]oolsets
[YOUR_TOKEN>]he following sets of tools are available:
<!-- S[YOUR_TOKEN>]A[YOUR_TOKEN>][YOUR_TOKEN>] A[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]MA[YOUR_TOKEN>][YOUR_TOKEN>]D [YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]LS[YOUR_TOKEN>][YOUR_TOKEN>]S --[YOUR_TOKEN>]
| | [YOUR_TOKEN>]oolset | Description |
| --- | ----------------------- | ------------------------------------------------------------- |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/person-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/person-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/person-light.png" width="20" height="20" alt="person"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `context` | **Strongly recommended**: [YOUR_TOKEN>]ools that provide context about the current user and GitHub context you are operating in |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/workflow-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/workflow-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/workflow-light.png" width="20" height="20" alt="workflow"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `actions` | GitHub Actions workflows and CI/CD operations |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/codescan-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/codescan-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/codescan-light.png" width="20" height="20" alt="codescan"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `code[YOUR_TOKEN>]security` | Code security related tools, such as GitHub Code Scanning |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/copilot-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/copilot-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/copilot-light.png" width="20" height="20" alt="copilot"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `copilot` | Copilot related tools |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/dependabot-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/dependabot-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/dependabot-light.png" width="20" height="20" alt="dependabot"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `dependabot` | Dependabot tools |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/comment-discussion-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/comment-discussion-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/comment-discussion-light.png" width="20" height="20" alt="comment-discussion"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `discussions` | GitHub Discussions related tools |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/logo-gist-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/logo-gist-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/logo-gist-light.png" width="20" height="20" alt="logo-gist"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `gists` | GitHub Gist related tools |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/git-branch-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/git-branch-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/git-branch-light.png" width="20" height="20" alt="git-branch"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `git` | GitHub Git API related tools for low-level Git operations |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/issue-opened-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/issue-opened-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/issue-opened-light.png" width="20" height="20" alt="issue-opened"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `issues` | GitHub Issues related tools |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/tag-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/tag-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/tag-light.png" width="20" height="20" alt="tag"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `labels` | GitHub Labels related tools |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/bell-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/bell-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/bell-light.png" width="20" height="20" alt="bell"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `notifications` | GitHub [YOUR_TOKEN>]otifications related tools |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/organization-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/organization-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/organization-light.png" width="20" height="20" alt="organization"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `orgs` | GitHub [YOUR_TOKEN>]rganization related tools |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/project-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/project-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/project-light.png" width="20" height="20" alt="project"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `projects` | GitHub Projects related tools |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/git-pull-request-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/git-pull-request-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/git-pull-request-light.png" width="20" height="20" alt="git-pull-request"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `pull[YOUR_TOKEN>]requests` | GitHub Pull [YOUR_TOKEN>]equest related tools |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/repo-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/repo-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/repo-light.png" width="20" height="20" alt="repo"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `repos` | GitHub [YOUR_TOKEN>]epository related tools |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/shield-lock-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/shield-lock-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/shield-lock-light.png" width="20" height="20" alt="shield-lock"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `secret[YOUR_TOKEN>]protection` | Secret protection related tools, such as GitHub Secret Scanning |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/shield-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/shield-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/shield-light.png" width="20" height="20" alt="shield"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `security[YOUR_TOKEN>]advisories` | Security advisories related tools |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/star-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/star-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/star-light.png" width="20" height="20" alt="star"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `stargazers` | GitHub Stargazers related tools |
| <picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/people-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/people-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/people-light.png" width="20" height="20" alt="people"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] | `users` | GitHub [YOUR_TOKEN>]ser related tools |
<!-- [YOUR_TOKEN>][YOUR_TOKEN>]D A[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]MA[YOUR_TOKEN>][YOUR_TOKEN>]D [YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]LS[YOUR_TOKEN>][YOUR_TOKEN>]S --[YOUR_TOKEN>]
### Additional [YOUR_TOKEN>]oolsets in [YOUR_TOKEN>]emote GitHub MCP Server
| [YOUR_TOKEN>]oolset | Description |
| ----------------------- | ------------------------------------------------------------- |
| `copilot` | Copilot related tools (e.g. Copilot Coding Agent) |
| `copilot[YOUR_TOKEN>]spaces` | Copilot Spaces related tools |
| `github[YOUR_TOKEN>]support[YOUR_TOKEN>]docs[YOUR_TOKEN>]search` | Search docs to answer GitHub product and support questions |
## [YOUR_TOKEN>]ools
<!-- S[YOUR_TOKEN>]A[YOUR_TOKEN>][YOUR_TOKEN>] A[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]MA[YOUR_TOKEN>][YOUR_TOKEN>]D [YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]LS --[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/workflow-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/workflow-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/workflow-light.png" width="20" height="20" alt="workflow"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Actions</summary[YOUR_TOKEN>]
- **actions[YOUR_TOKEN>]get** - Get details of GitHub Actions resources (workflows, workflow runs, jobs, and artifacts)
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `method`: [YOUR_TOKEN>]he method to execute (string, required)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `resource[YOUR_TOKEN>]id`: [YOUR_TOKEN>]he unique identifier of the resource. [YOUR_TOKEN>]his will vary based on the "method" provided, so ensure you provide the correct ID:
- Provide a workflow ID or workflow file name (e.g. ci.yaml) for 'get[YOUR_TOKEN>]workflow' method.
- Provide a workflow run ID for 'get[YOUR_TOKEN>]workflow[YOUR_TOKEN>]run', 'get[YOUR_TOKEN>]workflow[YOUR_TOKEN>]run[YOUR_TOKEN>]usage', and 'get[YOUR_TOKEN>]workflow[YOUR_TOKEN>]run[YOUR_TOKEN>]logs[YOUR_TOKEN>]url' methods.
- Provide an artifact ID for 'download[YOUR_TOKEN>]workflow[YOUR_TOKEN>]run[YOUR_TOKEN>]artifact' method.
- Provide a job ID for 'get[YOUR_TOKEN>]workflow[YOUR_TOKEN>]job' method.
(string, required)
- **actions[YOUR_TOKEN>]list** - List GitHub Actions workflows in a repository
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `method`: [YOUR_TOKEN>]he action to perform (string, required)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `page`: Page number for pagination (default: 1) (number, optional)
- `per[YOUR_TOKEN>]page`: [YOUR_TOKEN>]esults per page for pagination (default: 30, max: 100) (number, optional)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `resource[YOUR_TOKEN>]id`: [YOUR_TOKEN>]he unique identifier of the resource. [YOUR_TOKEN>]his will vary based on the "method" provided, so ensure you provide the correct ID:
- Do not provide any resource ID for 'list[YOUR_TOKEN>]workflows' method.
- Provide a workflow ID or workflow file name (e.g. ci.yaml) for 'list[YOUR_TOKEN>]workflow[YOUR_TOKEN>]runs' method, or omit to list all workflow runs in the repository.
- Provide a workflow run ID for 'list[YOUR_TOKEN>]workflow[YOUR_TOKEN>]jobs' and 'list[YOUR_TOKEN>]workflow[YOUR_TOKEN>]run[YOUR_TOKEN>]artifacts' methods.
(string, optional)
- `workflow[YOUR_TOKEN>]jobs[YOUR_TOKEN>]filter`: Filters for workflow jobs. **[YOUR_TOKEN>][YOUR_TOKEN>]L[YOUR_TOKEN>]** used when method is 'list[YOUR_TOKEN>]workflow[YOUR_TOKEN>]jobs' (object, optional)
- `workflow[YOUR_TOKEN>]runs[YOUR_TOKEN>]filter`: Filters for workflow runs. **[YOUR_TOKEN>][YOUR_TOKEN>]L[YOUR_TOKEN>]** used when method is 'list[YOUR_TOKEN>]workflow[YOUR_TOKEN>]runs' (object, optional)
- **actions[YOUR_TOKEN>]run[YOUR_TOKEN>]trigger** - [YOUR_TOKEN>]rigger GitHub Actions workflow actions
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `inputs`: Inputs the workflow accepts. [YOUR_TOKEN>]nly used for 'run[YOUR_TOKEN>]workflow' method. (object, optional)
- `method`: [YOUR_TOKEN>]he method to execute (string, required)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `ref`: [YOUR_TOKEN>]he git reference for the workflow. [YOUR_TOKEN>]he reference can be a branch or tag name. [YOUR_TOKEN>]equired for 'run[YOUR_TOKEN>]workflow' method. (string, optional)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `run[YOUR_TOKEN>]id`: [YOUR_TOKEN>]he ID of the workflow run. [YOUR_TOKEN>]equired for all methods except 'run[YOUR_TOKEN>]workflow'. (number, optional)
- `workflow[YOUR_TOKEN>]id`: [YOUR_TOKEN>]he workflow ID (numeric) or workflow file name (e.g., main.yml, ci.yaml). [YOUR_TOKEN>]equired for 'run[YOUR_TOKEN>]workflow' method. (string, optional)
- **get[YOUR_TOKEN>]job[YOUR_TOKEN>]logs** - Get GitHub Actions workflow job logs
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `failed[YOUR_TOKEN>]only`: When true, gets logs for all failed jobs in the workflow run specified by run[YOUR_TOKEN>]id. [YOUR_TOKEN>]equires run[YOUR_TOKEN>]id to be provided. (boolean, optional)
- `job[YOUR_TOKEN>]id`: [YOUR_TOKEN>]he unique identifier of the workflow job. [YOUR_TOKEN>]equired when getting logs for a single job. (number, optional)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `return[YOUR_TOKEN>]content`: [YOUR_TOKEN>]eturns actual log content instead of [YOUR_TOKEN>][YOUR_TOKEN>]Ls (boolean, optional)
- `run[YOUR_TOKEN>]id`: [YOUR_TOKEN>]he unique identifier of the workflow run. [YOUR_TOKEN>]equired when failed[YOUR_TOKEN>]only is true to get logs for all failed jobs in the run. (number, optional)
- `tail[YOUR_TOKEN>]lines`: [YOUR_TOKEN>]umber of lines to return from the end of the log (number, optional)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/codescan-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/codescan-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/codescan-light.png" width="20" height="20" alt="codescan"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Code Security</summary[YOUR_TOKEN>]
- **get[YOUR_TOKEN>]code[YOUR_TOKEN>]scanning[YOUR_TOKEN>]alert** - Get code scanning alert
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `security[YOUR_TOKEN>]events`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `repo`, `security[YOUR_TOKEN>]events`
- `alert[YOUR_TOKEN>]umber`: [YOUR_TOKEN>]he number of the alert. (number, required)
- `owner`: [YOUR_TOKEN>]he owner of the repository. (string, required)
- `repo`: [YOUR_TOKEN>]he name of the repository. (string, required)
- **list[YOUR_TOKEN>]code[YOUR_TOKEN>]scanning[YOUR_TOKEN>]alerts** - List code scanning alerts
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `security[YOUR_TOKEN>]events`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `repo`, `security[YOUR_TOKEN>]events`
- `owner`: [YOUR_TOKEN>]he owner of the repository. (string, required)
- `ref`: [YOUR_TOKEN>]he Git reference for the results you want to list. (string, optional)
- `repo`: [YOUR_TOKEN>]he 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[YOUR_TOKEN>]name`: [YOUR_TOKEN>]he name of the tool used for code scanning. (string, optional)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/person-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/person-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/person-light.png" width="20" height="20" alt="person"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Context</summary[YOUR_TOKEN>]
- **get[YOUR_TOKEN>]me** - Get my user profile
- [YOUR_TOKEN>]o parameters required
- **get[YOUR_TOKEN>]team[YOUR_TOKEN>]members** - Get team members
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `read:org`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `admin:org`, `read:org`, `write:org`
- `org`: [YOUR_TOKEN>]rganization login (owner) that contains the team. (string, required)
- `team[YOUR_TOKEN>]slug`: [YOUR_TOKEN>]eam slug (string, required)
- **get[YOUR_TOKEN>]teams** - Get teams
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `read:org`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `admin:org`, `read:org`, `write:org`
- `user`: [YOUR_TOKEN>]sername to get teams for. If not provided, uses the authenticated user. (string, optional)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/copilot-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/copilot-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/copilot-light.png" width="20" height="20" alt="copilot"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Copilot</summary[YOUR_TOKEN>]
- **assign[YOUR_TOKEN>]copilot[YOUR_TOKEN>]to[YOUR_TOKEN>]issue** - Assign Copilot to issue
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `base[YOUR_TOKEN>]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[YOUR_TOKEN>]instructions`: [YOUR_TOKEN>]ptional custom instructions to guide the agent beyond the issue body. [YOUR_TOKEN>]se this to provide additional context, constraints, or guidance that is not captured in the issue description (string, optional)
- `issue[YOUR_TOKEN>]number`: Issue number (number, required)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **request[YOUR_TOKEN>]copilot[YOUR_TOKEN>]review** - [YOUR_TOKEN>]equest Copilot review
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `pull[YOUR_TOKEN>]umber`: Pull request number (number, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/dependabot-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/dependabot-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/dependabot-light.png" width="20" height="20" alt="dependabot"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Dependabot</summary[YOUR_TOKEN>]
- **get[YOUR_TOKEN>]dependabot[YOUR_TOKEN>]alert** - Get dependabot alert
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `security[YOUR_TOKEN>]events`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `repo`, `security[YOUR_TOKEN>]events`
- `alert[YOUR_TOKEN>]umber`: [YOUR_TOKEN>]he number of the alert. (number, required)
- `owner`: [YOUR_TOKEN>]he owner of the repository. (string, required)
- `repo`: [YOUR_TOKEN>]he name of the repository. (string, required)
- **list[YOUR_TOKEN>]dependabot[YOUR_TOKEN>]alerts** - List dependabot alerts
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `security[YOUR_TOKEN>]events`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `repo`, `security[YOUR_TOKEN>]events`
- `owner`: [YOUR_TOKEN>]he owner of the repository. (string, required)
- `repo`: [YOUR_TOKEN>]he 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[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/comment-discussion-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/comment-discussion-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/comment-discussion-light.png" width="20" height="20" alt="comment-discussion"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Discussions</summary[YOUR_TOKEN>]
- **get[YOUR_TOKEN>]discussion** - Get discussion
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `discussion[YOUR_TOKEN>]umber`: Discussion [YOUR_TOKEN>]umber (number, required)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **get[YOUR_TOKEN>]discussion[YOUR_TOKEN>]comments** - Get discussion comments
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `after`: Cursor for pagination. [YOUR_TOKEN>]se the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional)
- `discussion[YOUR_TOKEN>]umber`: Discussion [YOUR_TOKEN>]umber (number, required)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **list[YOUR_TOKEN>]discussion[YOUR_TOKEN>]categories** - List discussion categories
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name. If not provided, discussion categories will be queried at the organisation level. (string, optional)
- **list[YOUR_TOKEN>]discussions** - List discussions
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `after`: Cursor for pagination. [YOUR_TOKEN>]se the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional)
- `category`: [YOUR_TOKEN>]ptional filter by discussion category ID. If provided, only discussions with this category are listed. (string, optional)
- `direction`: [YOUR_TOKEN>]rder direction. (string, optional)
- `orderBy`: [YOUR_TOKEN>]rder discussions by field. If provided, the 'direction' also needs to be provided. (string, optional)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `repo`: [YOUR_TOKEN>]epository name. If not provided, discussions will be queried at the organisation level. (string, optional)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/logo-gist-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/logo-gist-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/logo-gist-light.png" width="20" height="20" alt="logo-gist"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Gists</summary[YOUR_TOKEN>]
- **create[YOUR_TOKEN>]gist** - Create Gist
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `gist`
- `content`: 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)
- **get[YOUR_TOKEN>]gist** - Get Gist Content
- `gist[YOUR_TOKEN>]id`: [YOUR_TOKEN>]he ID of the gist (string, required)
- **list[YOUR_TOKEN>]gists** - List Gists
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `since`: [YOUR_TOKEN>]nly gists updated after this time (IS[YOUR_TOKEN>] 8601 timestamp) (string, optional)
- `username`: GitHub username (omit for authenticated user's gists) (string, optional)
- **update[YOUR_TOKEN>]gist** - [YOUR_TOKEN>]pdate Gist
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `gist`
- `content`: Content for the file (string, required)
- `description`: [YOUR_TOKEN>]pdated description of the gist (string, optional)
- `filename`: Filename to update or create (string, required)
- `gist[YOUR_TOKEN>]id`: ID of the gist to update (string, required)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/git-branch-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/git-branch-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/git-branch-light.png" width="20" height="20" alt="git-branch"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Git</summary[YOUR_TOKEN>]
- **get[YOUR_TOKEN>]repository[YOUR_TOKEN>]tree** - Get repository tree
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `owner`: [YOUR_TOKEN>]epository owner (username or organization) (string, required)
- `path[YOUR_TOKEN>]filter`: [YOUR_TOKEN>]ptional 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`: [YOUR_TOKEN>]epository name (string, required)
- `tree[YOUR_TOKEN>]sha`: [YOUR_TOKEN>]he SHA1 value or ref (branch or tag) name of the tree. Defaults to the repository's default branch (string, optional)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/issue-opened-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/issue-opened-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/issue-opened-light.png" width="20" height="20" alt="issue-opened"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Issues</summary[YOUR_TOKEN>]
- **add[YOUR_TOKEN>]issue[YOUR_TOKEN>]comment** - Add comment to issue
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `body`: Comment content (string, required)
- `issue[YOUR_TOKEN>]number`: Issue number to comment on (number, required)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **get[YOUR_TOKEN>]label** - Get a specific label from a repository.
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `name`: Label name. (string, required)
- `owner`: [YOUR_TOKEN>]epository owner (username or organization name) (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **issue[YOUR_TOKEN>]read** - Get issue details
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `issue[YOUR_TOKEN>]number`: [YOUR_TOKEN>]he number of the issue (number, required)
- `method`: [YOUR_TOKEN>]he read operation to perform on a single issue.
[YOUR_TOKEN>]ptions are:
1. get - Get details of a specific issue.
2. get[YOUR_TOKEN>]comments - Get issue comments.
3. get[YOUR_TOKEN>]sub[YOUR_TOKEN>]issues - Get sub-issues of the issue.
4. get[YOUR_TOKEN>]labels - Get labels assigned to the issue.
(string, required)
- `owner`: [YOUR_TOKEN>]he owner of the repository (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `repo`: [YOUR_TOKEN>]he name of the repository (string, required)
- **issue[YOUR_TOKEN>]write** - Create or update issue.
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `assignees`: [YOUR_TOKEN>]sernames to assign to this issue (string[], optional)
- `body`: Issue body content (string, optional)
- `duplicate[YOUR_TOKEN>]of`: Issue number that this issue is a duplicate of. [YOUR_TOKEN>]nly used when state[YOUR_TOKEN>]reason is 'duplicate'. (number, optional)
- `issue[YOUR_TOKEN>]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.
[YOUR_TOKEN>]ptions are:
- 'create' - creates a new issue.
- 'update' - updates an existing issue.
(string, required)
- `milestone`: Milestone number (number, optional)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `state`: [YOUR_TOKEN>]ew state (string, optional)
- `state[YOUR_TOKEN>]reason`: [YOUR_TOKEN>]eason for the state change. Ignored unless state is changed. (string, optional)
- `title`: Issue title (string, optional)
- `type`: [YOUR_TOKEN>]ype of this issue. [YOUR_TOKEN>]nly use if the repository has issue types configured. [YOUR_TOKEN>]se list[YOUR_TOKEN>]issue[YOUR_TOKEN>]types tool to get valid type values for the organization. If the repository doesn't support issue types, omit this parameter. (string, optional)
- **list[YOUR_TOKEN>]issue[YOUR_TOKEN>]types** - List available issue types
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `read:org`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `admin:org`, `read:org`, `write:org`
- `owner`: [YOUR_TOKEN>]he organization owner of the repository (string, required)
- **list[YOUR_TOKEN>]issues** - List issues
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `after`: Cursor for pagination. [YOUR_TOKEN>]se the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional)
- `direction`: [YOUR_TOKEN>]rder direction. If provided, the 'orderBy' also needs to be provided. (string, optional)
- `labels`: Filter by labels (string[], optional)
- `orderBy`: [YOUR_TOKEN>]rder issues by field. If provided, the 'direction' also needs to be provided. (string, optional)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `since`: Filter by date (IS[YOUR_TOKEN>] 8601 timestamp) (string, optional)
- `state`: Filter by state, by default both open and closed issues are returned when not provided (string, optional)
- **search[YOUR_TOKEN>]issues** - Search issues
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `order`: Sort order (string, optional)
- `owner`: [YOUR_TOKEN>]ptional 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`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `query`: Search query using GitHub issues search syntax (string, required)
- `repo`: [YOUR_TOKEN>]ptional 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)
- **sub[YOUR_TOKEN>]issue[YOUR_TOKEN>]write** - Change sub-issue
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `after[YOUR_TOKEN>]id`: [YOUR_TOKEN>]he ID of the sub-issue to be prioritized after (either after[YOUR_TOKEN>]id [YOUR_TOKEN>][YOUR_TOKEN>] before[YOUR_TOKEN>]id should be specified) (number, optional)
- `before[YOUR_TOKEN>]id`: [YOUR_TOKEN>]he ID of the sub-issue to be prioritized before (either after[YOUR_TOKEN>]id [YOUR_TOKEN>][YOUR_TOKEN>] before[YOUR_TOKEN>]id should be specified) (number, optional)
- `issue[YOUR_TOKEN>]number`: [YOUR_TOKEN>]he number of the parent issue (number, required)
- `method`: [YOUR_TOKEN>]he action to perform on a single sub-issue
[YOUR_TOKEN>]ptions are:
- 'add' - add a sub-issue to a parent issue in a GitHub repository.
- 'remove' - remove a sub-issue from a parent issue in a GitHub repository.
- 'reprioritize' - change the order of sub-issues within a parent issue in a GitHub repository. [YOUR_TOKEN>]se either 'after[YOUR_TOKEN>]id' or 'before[YOUR_TOKEN>]id' to specify the new position.
(string, required)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `replace[YOUR_TOKEN>]parent`: When true, replaces the sub-issue's current parent issue. [YOUR_TOKEN>]se with 'add' method only. (boolean, optional)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `sub[YOUR_TOKEN>]issue[YOUR_TOKEN>]id`: [YOUR_TOKEN>]he ID of the sub-issue to add. ID is not the same as issue number (number, required)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/tag-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/tag-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/tag-light.png" width="20" height="20" alt="tag"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Labels</summary[YOUR_TOKEN>]
- **get[YOUR_TOKEN>]label** - Get a specific label from a repository.
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `name`: Label name. (string, required)
- `owner`: [YOUR_TOKEN>]epository owner (username or organization name) (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **label[YOUR_TOKEN>]write** - Write operations on repository labels.
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `color`: Label color as 6-character hex code without '#' prefix (e.g., 'f29513'). [YOUR_TOKEN>]equired for 'create', optional for 'update'. (string, optional)
- `description`: Label description text. [YOUR_TOKEN>]ptional for 'create' and 'update'. (string, optional)
- `method`: [YOUR_TOKEN>]peration to perform: 'create', 'update', or 'delete' (string, required)
- `name`: Label name - required for all operations (string, required)
- `new[YOUR_TOKEN>]name`: [YOUR_TOKEN>]ew name for the label (used only with 'update' method to rename) (string, optional)
- `owner`: [YOUR_TOKEN>]epository owner (username or organization name) (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **list[YOUR_TOKEN>]label** - List labels from a repository
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `owner`: [YOUR_TOKEN>]epository owner (username or organization name) - required for all operations (string, required)
- `repo`: [YOUR_TOKEN>]epository name - required for all operations (string, required)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/bell-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/bell-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/bell-light.png" width="20" height="20" alt="bell"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] [YOUR_TOKEN>]otifications</summary[YOUR_TOKEN>]
- **dismiss[YOUR_TOKEN>]notification** - Dismiss notification
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `notifications`
- `state`: [YOUR_TOKEN>]he new state of the notification (read/done) (string, required)
- `threadID`: [YOUR_TOKEN>]he ID of the notification thread (string, required)
- **get[YOUR_TOKEN>]notification[YOUR_TOKEN>]details** - Get notification details
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `notifications`
- `notificationID`: [YOUR_TOKEN>]he ID of the notification (string, required)
- **list[YOUR_TOKEN>]notifications** - List notifications
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `notifications`
- `before`: [YOUR_TOKEN>]nly show notifications updated before the given time (IS[YOUR_TOKEN>] 8601 format) (string, optional)
- `filter`: Filter notifications to, use default unless specified. [YOUR_TOKEN>]ead 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`: [YOUR_TOKEN>]ptional 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`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `repo`: [YOUR_TOKEN>]ptional repository name. If provided with owner, only notifications for this repository are listed. (string, optional)
- `since`: [YOUR_TOKEN>]nly show notifications updated after the given time (IS[YOUR_TOKEN>] 8601 format) (string, optional)
- **manage[YOUR_TOKEN>]notification[YOUR_TOKEN>]subscription** - Manage notification subscription
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `notifications`
- `action`: Action to perform: ignore, watch, or delete the notification subscription. (string, required)
- `notificationID`: [YOUR_TOKEN>]he ID of the notification thread. (string, required)
- **manage[YOUR_TOKEN>]repository[YOUR_TOKEN>]notification[YOUR_TOKEN>]subscription** - Manage repository notification subscription
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `notifications`
- `action`: Action to perform: ignore, watch, or delete the repository notification subscription. (string, required)
- `owner`: [YOUR_TOKEN>]he account owner of the repository. (string, required)
- `repo`: [YOUR_TOKEN>]he name of the repository. (string, required)
- **mark[YOUR_TOKEN>]all[YOUR_TOKEN>]notifications[YOUR_TOKEN>]read** - Mark all notifications as read
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `notifications`
- `last[YOUR_TOKEN>]eadAt`: Describes the last point that notifications were checked (optional). Default: [YOUR_TOKEN>]ow (string, optional)
- `owner`: [YOUR_TOKEN>]ptional repository owner. If provided with repo, only notifications for this repository are marked as read. (string, optional)
- `repo`: [YOUR_TOKEN>]ptional repository name. If provided with owner, only notifications for this repository are marked as read. (string, optional)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/organization-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/organization-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/organization-light.png" width="20" height="20" alt="organization"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] [YOUR_TOKEN>]rganizations</summary[YOUR_TOKEN>]
- **search[YOUR_TOKEN>]orgs** - Search organizations
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `read:org`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `admin:org`, `read:org`, `write:org`
- `order`: Sort order (string, optional)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `query`: [YOUR_TOKEN>]rganization search query. [YOUR_TOKEN>]xamples: 'microsoft', 'location:california', 'created:[YOUR_TOKEN>]=2025-01-01'. Search is automatically scoped to type:org. (string, required)
- `sort`: Sort field by category (string, optional)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/project-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/project-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/project-light.png" width="20" height="20" alt="project"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Projects</summary[YOUR_TOKEN>]
- **projects[YOUR_TOKEN>]get** - Get details of GitHub Projects resources
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `read:project`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `project`, `read:project`
- `field[YOUR_TOKEN>]id`: [YOUR_TOKEN>]he field's ID. [YOUR_TOKEN>]equired for 'get[YOUR_TOKEN>]project[YOUR_TOKEN>]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. [YOUR_TOKEN>]nly used for 'get[YOUR_TOKEN>]project[YOUR_TOKEN>]item' method. (string[], optional)
- `item[YOUR_TOKEN>]id`: [YOUR_TOKEN>]he item's ID. [YOUR_TOKEN>]equired for 'get[YOUR_TOKEN>]project[YOUR_TOKEN>]item' method. (number, optional)
- `method`: [YOUR_TOKEN>]he method to execute (string, required)
- `owner`: [YOUR_TOKEN>]he owner (user or organization login). [YOUR_TOKEN>]he name is not case sensitive. (string, optional)
- `owner[YOUR_TOKEN>]type`: [YOUR_TOKEN>]wner type (user or org). If not provided, will be automatically detected. (string, optional)
- `project[YOUR_TOKEN>]number`: [YOUR_TOKEN>]he project's number. (number, optional)
- `status[YOUR_TOKEN>]update[YOUR_TOKEN>]id`: [YOUR_TOKEN>]he node ID of the project status update. [YOUR_TOKEN>]equired for 'get[YOUR_TOKEN>]project[YOUR_TOKEN>]status[YOUR_TOKEN>]update' method. (string, optional)
- **projects[YOUR_TOKEN>]list** - List GitHub Projects resources
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `read:project`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `project`, `read:project`
- `after`: 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"]). C[YOUR_TOKEN>]I[YOUR_TOKEN>]ICAL: Always provide to get field values. Without this, only titles returned. [YOUR_TOKEN>]nly used for 'list[YOUR_TOKEN>]project[YOUR_TOKEN>]items' method. (string[], optional)
- `method`: [YOUR_TOKEN>]he action to perform (string, required)
- `owner`: [YOUR_TOKEN>]he owner (user or organization login). [YOUR_TOKEN>]he name is not case sensitive. (string, required)
- `owner[YOUR_TOKEN>]type`: [YOUR_TOKEN>]wner type (user or org). If not provided, will automatically try both. (string, optional)
- `per[YOUR_TOKEN>]page`: [YOUR_TOKEN>]esults per page (max 50) (number, optional)
- `project[YOUR_TOKEN>]number`: [YOUR_TOKEN>]he project's number. [YOUR_TOKEN>]equired for 'list[YOUR_TOKEN>]project[YOUR_TOKEN>]fields', 'list[YOUR_TOKEN>]project[YOUR_TOKEN>]items', and 'list[YOUR_TOKEN>]project[YOUR_TOKEN>]status[YOUR_TOKEN>]updates' methods. (number, optional)
- `query`: Filter/query string. For list[YOUR_TOKEN>]projects: filter by title text and state (e.g. "roadmap is:open"). For list[YOUR_TOKEN>]project[YOUR_TOKEN>]items: advanced filtering using GitHub's project filtering syntax. (string, optional)
- **projects[YOUR_TOKEN>]write** - Modify GitHub Project items
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `project`
- `body`: [YOUR_TOKEN>]he body of the status update (markdown). [YOUR_TOKEN>]sed for 'create[YOUR_TOKEN>]project[YOUR_TOKEN>]status[YOUR_TOKEN>]update' method. (string, optional)
- `issue[YOUR_TOKEN>]number`: [YOUR_TOKEN>]he issue number (use when item[YOUR_TOKEN>]type is 'issue' for 'add[YOUR_TOKEN>]project[YOUR_TOKEN>]item' method). Provide either issue[YOUR_TOKEN>]number or pull[YOUR_TOKEN>]request[YOUR_TOKEN>]number. (number, optional)
- `item[YOUR_TOKEN>]id`: [YOUR_TOKEN>]he project item ID. [YOUR_TOKEN>]equired for 'update[YOUR_TOKEN>]project[YOUR_TOKEN>]item' and 'delete[YOUR_TOKEN>]project[YOUR_TOKEN>]item' methods. (number, optional)
- `item[YOUR_TOKEN>]owner`: [YOUR_TOKEN>]he owner (user or organization) of the repository containing the issue or pull request. [YOUR_TOKEN>]equired for 'add[YOUR_TOKEN>]project[YOUR_TOKEN>]item' method. (string, optional)
- `item[YOUR_TOKEN>]repo`: [YOUR_TOKEN>]he name of the repository containing the issue or pull request. [YOUR_TOKEN>]equired for 'add[YOUR_TOKEN>]project[YOUR_TOKEN>]item' method. (string, optional)
- `item[YOUR_TOKEN>]type`: [YOUR_TOKEN>]he item's type, either issue or pull[YOUR_TOKEN>]request. [YOUR_TOKEN>]equired for 'add[YOUR_TOKEN>]project[YOUR_TOKEN>]item' method. (string, optional)
- `method`: [YOUR_TOKEN>]he method to execute (string, required)
- `owner`: [YOUR_TOKEN>]he project owner (user or organization login). [YOUR_TOKEN>]he name is not case sensitive. (string, required)
- `owner[YOUR_TOKEN>]type`: [YOUR_TOKEN>]wner type (user or org). If not provided, will be automatically detected. (string, optional)
- `project[YOUR_TOKEN>]number`: [YOUR_TOKEN>]he project's number. (number, required)
- `pull[YOUR_TOKEN>]request[YOUR_TOKEN>]number`: [YOUR_TOKEN>]he pull request number (use when item[YOUR_TOKEN>]type is 'pull[YOUR_TOKEN>]request' for 'add[YOUR_TOKEN>]project[YOUR_TOKEN>]item' method). Provide either issue[YOUR_TOKEN>]number or pull[YOUR_TOKEN>]request[YOUR_TOKEN>]number. (number, optional)
- `start[YOUR_TOKEN>]date`: [YOUR_TOKEN>]he start date of the status update in [YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]-MM-DD format. [YOUR_TOKEN>]sed for 'create[YOUR_TOKEN>]project[YOUR_TOKEN>]status[YOUR_TOKEN>]update' method. (string, optional)
- `status`: [YOUR_TOKEN>]he status of the project. [YOUR_TOKEN>]sed for 'create[YOUR_TOKEN>]project[YOUR_TOKEN>]status[YOUR_TOKEN>]update' method. (string, optional)
- `target[YOUR_TOKEN>]date`: [YOUR_TOKEN>]he target date of the status update in [YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]-MM-DD format. [YOUR_TOKEN>]sed for 'create[YOUR_TOKEN>]project[YOUR_TOKEN>]status[YOUR_TOKEN>]update' method. (string, optional)
- `updated[YOUR_TOKEN>]field`: [YOUR_TOKEN>]bject consisting of the ID of the project field to update and the new value for the field. [YOUR_TOKEN>]o clear the field, set value to null. [YOUR_TOKEN>]xample: {"id": 123456, "value": "[YOUR_TOKEN>]ew Value"}. [YOUR_TOKEN>]equired for 'update[YOUR_TOKEN>]project[YOUR_TOKEN>]item' method. (object, optional)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/git-pull-request-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/git-pull-request-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/git-pull-request-light.png" width="20" height="20" alt="git-pull-request"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Pull [YOUR_TOKEN>]equests</summary[YOUR_TOKEN>]
- **add[YOUR_TOKEN>]comment[YOUR_TOKEN>]to[YOUR_TOKEN>]pending[YOUR_TOKEN>]review** - Add review comment to the requester's latest pending pull request review
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `body`: [YOUR_TOKEN>]he text of the review comment (string, required)
- `line`: [YOUR_TOKEN>]he 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`: [YOUR_TOKEN>]epository owner (string, required)
- `path`: [YOUR_TOKEN>]he relative path to the file that necessitates a comment (string, required)
- `pull[YOUR_TOKEN>]umber`: Pull request number (number, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `side`: [YOUR_TOKEN>]he side of the diff to comment on. L[YOUR_TOKEN>]F[YOUR_TOKEN>] indicates the previous state, [YOUR_TOKEN>]IGH[YOUR_TOKEN>] 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. L[YOUR_TOKEN>]F[YOUR_TOKEN>] indicates the previous state, [YOUR_TOKEN>]IGH[YOUR_TOKEN>] indicates the new state (string, optional)
- `subject[YOUR_TOKEN>]ype`: [YOUR_TOKEN>]he level at which the comment is targeted (string, required)
- **add[YOUR_TOKEN>]reply[YOUR_TOKEN>]to[YOUR_TOKEN>]pull[YOUR_TOKEN>]request[YOUR_TOKEN>]comment** - Add reply to pull request comment
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `body`: [YOUR_TOKEN>]he text of the reply (string, required)
- `commentId`: [YOUR_TOKEN>]he ID of the comment to reply to (number, required)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `pull[YOUR_TOKEN>]umber`: Pull request number (number, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **create[YOUR_TOKEN>]pull[YOUR_TOKEN>]request** - [YOUR_TOKEN>]pen new pull request
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `base`: Branch to merge into (string, required)
- `body`: P[YOUR_TOKEN>] description (string, optional)
- `draft`: Create as draft P[YOUR_TOKEN>] (boolean, optional)
- `head`: Branch containing changes (string, required)
- `maintainer[YOUR_TOKEN>]can[YOUR_TOKEN>]modify`: Allow maintainer edits (boolean, optional)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `title`: P[YOUR_TOKEN>] title (string, required)
- **list[YOUR_TOKEN>]pull[YOUR_TOKEN>]requests** - List pull requests
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `base`: Filter by base branch (string, optional)
- `direction`: Sort direction (string, optional)
- `head`: Filter by head user/org and branch (string, optional)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `sort`: Sort by (string, optional)
- `state`: Filter by state (string, optional)
- **merge[YOUR_TOKEN>]pull[YOUR_TOKEN>]request** - Merge pull request
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `commit[YOUR_TOKEN>]message`: [YOUR_TOKEN>]xtra detail for merge commit (string, optional)
- `commit[YOUR_TOKEN>]title`: [YOUR_TOKEN>]itle for merge commit (string, optional)
- `merge[YOUR_TOKEN>]method`: Merge method (string, optional)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `pull[YOUR_TOKEN>]umber`: Pull request number (number, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **pull[YOUR_TOKEN>]request[YOUR_TOKEN>]read** - Get details for a single pull request
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `method`: Action to specify what pull request data needs to be retrieved from GitHub.
Possible options:
1. get - Get details of a specific pull request.
2. get[YOUR_TOKEN>]diff - Get the diff of a pull request.
3. get[YOUR_TOKEN>]status - Get combined commit status of a head commit in a pull request.
4. get[YOUR_TOKEN>]files - Get the list of files changed in a pull request. [YOUR_TOKEN>]se with pagination parameters to control the number of results returned.
5. get[YOUR_TOKEN>]review[YOUR_TOKEN>]comments - Get review threads on a pull request. [YOUR_TOKEN>]ach thread contains logically grouped review comments made on the same code location during pull request reviews. [YOUR_TOKEN>]eturns threads with metadata (is[YOUR_TOKEN>]esolved, is[YOUR_TOKEN>]utdated, isCollapsed) and their associated comments. [YOUR_TOKEN>]se cursor-based pagination (perPage, after) to control results.
6. get[YOUR_TOKEN>]reviews - Get the reviews on a pull request. When asked for review comments, use get[YOUR_TOKEN>]review[YOUR_TOKEN>]comments method.
7. get[YOUR_TOKEN>]comments - Get comments on a pull request. [YOUR_TOKEN>]se this if user doesn't specifically want review comments. [YOUR_TOKEN>]se with pagination parameters to control the number of results returned.
8. get[YOUR_TOKEN>]check[YOUR_TOKEN>]runs - Get check runs for the head commit of a pull request. Check runs are the individual CI/CD jobs and checks that run on the P[YOUR_TOKEN>].
(string, required)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `pull[YOUR_TOKEN>]umber`: Pull request number (number, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **pull[YOUR_TOKEN>]request[YOUR_TOKEN>]review[YOUR_TOKEN>]write** - Write operations (create, submit, delete) on pull request reviews.
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `body`: [YOUR_TOKEN>]eview comment text (string, optional)
- `commitID`: SHA of commit to review (string, optional)
- `event`: [YOUR_TOKEN>]eview action to perform. (string, optional)
- `method`: [YOUR_TOKEN>]he write operation to perform on pull request review. (string, required)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `pull[YOUR_TOKEN>]umber`: Pull request number (number, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **search[YOUR_TOKEN>]pull[YOUR_TOKEN>]requests** - Search pull requests
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `order`: Sort order (string, optional)
- `owner`: [YOUR_TOKEN>]ptional repository owner. If provided with repo, only pull requests for this repository are listed. (string, optional)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `query`: Search query using GitHub pull request search syntax (string, required)
- `repo`: [YOUR_TOKEN>]ptional repository name. If provided with owner, only pull requests for this repository are listed. (string, optional)
- `sort`: Sort field by number of matches of categories, defaults to best match (string, optional)
- **update[YOUR_TOKEN>]pull[YOUR_TOKEN>]request** - [YOUR_TOKEN>]dit pull request
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `base`: [YOUR_TOKEN>]ew base branch name (string, optional)
- `body`: [YOUR_TOKEN>]ew description (string, optional)
- `draft`: Mark pull request as draft (true) or ready for review (false) (boolean, optional)
- `maintainer[YOUR_TOKEN>]can[YOUR_TOKEN>]modify`: Allow maintainer edits (boolean, optional)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `pull[YOUR_TOKEN>]umber`: Pull request number to update (number, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `reviewers`: GitHub usernames to request reviews from (string[], optional)
- `state`: [YOUR_TOKEN>]ew state (string, optional)
- `title`: [YOUR_TOKEN>]ew title (string, optional)
- **update[YOUR_TOKEN>]pull[YOUR_TOKEN>]request[YOUR_TOKEN>]branch** - [YOUR_TOKEN>]pdate pull request branch
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `expectedHeadSha`: [YOUR_TOKEN>]he expected SHA of the pull request's H[YOUR_TOKEN>]AD ref (string, optional)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `pull[YOUR_TOKEN>]umber`: Pull request number (number, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/repo-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/repo-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/repo-light.png" width="20" height="20" alt="repo"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] [YOUR_TOKEN>]epositories</summary[YOUR_TOKEN>]
- **create[YOUR_TOKEN>]branch** - Create branch
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `branch`: [YOUR_TOKEN>]ame for new branch (string, required)
- `from[YOUR_TOKEN>]branch`: Source branch (defaults to repo default) (string, optional)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **create[YOUR_TOKEN>]or[YOUR_TOKEN>]update[YOUR_TOKEN>]file** - Create or update file
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `branch`: Branch to create/update the file in (string, required)
- `content`: Content of the file (string, required)
- `message`: Commit message (string, required)
- `owner`: [YOUR_TOKEN>]epository owner (username or organization) (string, required)
- `path`: Path where to create/update the file (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `sha`: [YOUR_TOKEN>]he blob SHA of the file being replaced. (string, optional)
- **create[YOUR_TOKEN>]repository** - Create repository
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `autoInit`: Initialize with [YOUR_TOKEN>][YOUR_TOKEN>]ADM[YOUR_TOKEN>] (boolean, optional)
- `description`: [YOUR_TOKEN>]epository description (string, optional)
- `name`: [YOUR_TOKEN>]epository name (string, required)
- `organization`: [YOUR_TOKEN>]rganization to create the repository in (omit to create in your personal account) (string, optional)
- `private`: Whether repo should be private (boolean, optional)
- **delete[YOUR_TOKEN>]file** - Delete file
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `branch`: Branch to delete the file from (string, required)
- `message`: Commit message (string, required)
- `owner`: [YOUR_TOKEN>]epository owner (username or organization) (string, required)
- `path`: Path to the file to delete (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **fork[YOUR_TOKEN>]repository** - Fork repository
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `organization`: [YOUR_TOKEN>]rganization to fork to (string, optional)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **get[YOUR_TOKEN>]commit** - Get commit details
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `include[YOUR_TOKEN>]diff`: Whether to include file diffs and stats in the response. Default is true. (boolean, optional)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `sha`: Commit SHA, branch name, or tag name (string, required)
- **get[YOUR_TOKEN>]file[YOUR_TOKEN>]contents** - Get file or directory contents
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `owner`: [YOUR_TOKEN>]epository owner (username or organization) (string, required)
- `path`: Path to file/directory (string, optional)
- `ref`: Accepts optional git refs such as `refs/tags/{tag}`, `refs/heads/{branch}` or `refs/pull/{pr[YOUR_TOKEN>]number}/head` (string, optional)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `sha`: Accepts optional commit SHA. If specified, it will be used instead of ref (string, optional)
- **get[YOUR_TOKEN>]latest[YOUR_TOKEN>]release** - Get latest release
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **get[YOUR_TOKEN>]release[YOUR_TOKEN>]by[YOUR_TOKEN>]tag** - Get a release by tag name
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `tag`: [YOUR_TOKEN>]ag name (e.g., 'v1.0.0') (string, required)
- **get[YOUR_TOKEN>]tag** - Get tag details
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `tag`: [YOUR_TOKEN>]ag name (string, required)
- **list[YOUR_TOKEN>]branches** - List branches
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **list[YOUR_TOKEN>]commits** - List commits
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `author`: Author username or email address to filter commits by (string, optional)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- `sha`: Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA. (string, optional)
- **list[YOUR_TOKEN>]releases** - List releases
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **list[YOUR_TOKEN>]tags** - List tags
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **push[YOUR_TOKEN>]files** - Push files to repository
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `branch`: Branch to push to (string, required)
- `files`: Array of file objects to push, each object with path (string) and content (string) (object[], required)
- `message`: Commit message (string, required)
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **search[YOUR_TOKEN>]code** - Search code
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `order`: Sort order for results (string, optional)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `query`: Search query using GitHub's powerful code search syntax. [YOUR_TOKEN>]xamples: 'content:Skill language:Java org:github', '[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>] is:archived language:Python [YOUR_TOKEN>][YOUR_TOKEN>] language:go', 'repo:github/github-mcp-server'. Supports exact matching, language filters, path filters, and more. (string, required)
- `sort`: Sort field ('indexed' only) (string, optional)
- **search[YOUR_TOKEN>]repositories** - Search repositories
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `minimal[YOUR_TOKEN>]output`: [YOUR_TOKEN>]eturn minimal repository information (default: true). When false, returns full GitHub API repository objects. (boolean, optional)
- `order`: Sort order (string, optional)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `query`: [YOUR_TOKEN>]epository search query. [YOUR_TOKEN>]xamples: 'machine learning in:name stars:[YOUR_TOKEN>]1000 language:python', 'topic:react', 'user:facebook'. Supports advanced search syntax for precise filtering. (string, required)
- `sort`: Sort repositories by field, defaults to best match (string, optional)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/shield-lock-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/shield-lock-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/shield-lock-light.png" width="20" height="20" alt="shield-lock"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Secret Protection</summary[YOUR_TOKEN>]
- **get[YOUR_TOKEN>]secret[YOUR_TOKEN>]scanning[YOUR_TOKEN>]alert** - Get secret scanning alert
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `security[YOUR_TOKEN>]events`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `repo`, `security[YOUR_TOKEN>]events`
- `alert[YOUR_TOKEN>]umber`: [YOUR_TOKEN>]he number of the alert. (number, required)
- `owner`: [YOUR_TOKEN>]he owner of the repository. (string, required)
- `repo`: [YOUR_TOKEN>]he name of the repository. (string, required)
- **list[YOUR_TOKEN>]secret[YOUR_TOKEN>]scanning[YOUR_TOKEN>]alerts** - List secret scanning alerts
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `security[YOUR_TOKEN>]events`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `repo`, `security[YOUR_TOKEN>]events`
- `owner`: [YOUR_TOKEN>]he owner of the repository. (string, required)
- `repo`: [YOUR_TOKEN>]he name of the repository. (string, required)
- `resolution`: Filter by resolution (string, optional)
- `secret[YOUR_TOKEN>]type`: A comma-separated list of secret types to return. All default secret patterns are returned. [YOUR_TOKEN>]o return generic patterns, pass the token name(s) in the parameter. (string, optional)
- `state`: Filter by state (string, optional)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/shield-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/shield-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/shield-light.png" width="20" height="20" alt="shield"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Security Advisories</summary[YOUR_TOKEN>]
- **get[YOUR_TOKEN>]global[YOUR_TOKEN>]security[YOUR_TOKEN>]advisory** - Get a global security advisory
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `security[YOUR_TOKEN>]events`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `repo`, `security[YOUR_TOKEN>]events`
- `ghsaId`: GitHub Security Advisory ID (format: GHSA-xxxx-xxxx-xxxx). (string, required)
- **list[YOUR_TOKEN>]global[YOUR_TOKEN>]security[YOUR_TOKEN>]advisories** - List global security advisories
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `security[YOUR_TOKEN>]events`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `repo`, `security[YOUR_TOKEN>]events`
- `affects`: Filter advisories by affected package or version (e.g. "package1,[email protected]"). (string, optional)
- `cveId`: Filter by CV[YOUR_TOKEN>] ID. (string, optional)
- `cwes`: Filter by Common Weakness [YOUR_TOKEN>]numeration IDs (e.g. ["79", "284", "22"]). (string[], optional)
- `ecosystem`: Filter by package ecosystem. (string, optional)
- `ghsaId`: Filter by GitHub Security Advisory ID (format: GHSA-xxxx-xxxx-xxxx). (string, optional)
- `isWithdrawn`: Whether to only return withdrawn advisories. (boolean, optional)
- `modified`: Filter by publish or update date or date range (IS[YOUR_TOKEN>] 8601 date or range). (string, optional)
- `published`: Filter by publish date or date range (IS[YOUR_TOKEN>] 8601 date or range). (string, optional)
- `severity`: Filter by severity. (string, optional)
- `type`: Advisory type. (string, optional)
- `updated`: Filter by update date or date range (IS[YOUR_TOKEN>] 8601 date or range). (string, optional)
- **list[YOUR_TOKEN>]org[YOUR_TOKEN>]repository[YOUR_TOKEN>]security[YOUR_TOKEN>]advisories** - List org repository security advisories
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `security[YOUR_TOKEN>]events`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `repo`, `security[YOUR_TOKEN>]events`
- `direction`: Sort direction. (string, optional)
- `org`: [YOUR_TOKEN>]he organization login. (string, required)
- `sort`: Sort field. (string, optional)
- `state`: Filter by advisory state. (string, optional)
- **list[YOUR_TOKEN>]repository[YOUR_TOKEN>]security[YOUR_TOKEN>]advisories** - List repository security advisories
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `security[YOUR_TOKEN>]events`
- **Accepted [YOUR_TOKEN>]Auth Scopes**: `repo`, `security[YOUR_TOKEN>]events`
- `direction`: Sort direction. (string, optional)
- `owner`: [YOUR_TOKEN>]he owner of the repository. (string, required)
- `repo`: [YOUR_TOKEN>]he name of the repository. (string, required)
- `sort`: Sort field. (string, optional)
- `state`: Filter by advisory state. (string, optional)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/star-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/star-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/star-light.png" width="20" height="20" alt="star"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] Stargazers</summary[YOUR_TOKEN>]
- **list[YOUR_TOKEN>]starred[YOUR_TOKEN>]repositories** - List starred repositories
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `direction`: [YOUR_TOKEN>]he direction to sort the results by. (string, optional)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `sort`: How to sort the results. Can be either 'created' (when the repository was starred) or 'updated' (when the repository was last pushed to). (string, optional)
- `username`: [YOUR_TOKEN>]sername to list starred repositories for. Defaults to the authenticated user. (string, optional)
- **star[YOUR_TOKEN>]repository** - Star repository
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
- **unstar[YOUR_TOKEN>]repository** - [YOUR_TOKEN>]nstar repository
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `owner`: [YOUR_TOKEN>]epository owner (string, required)
- `repo`: [YOUR_TOKEN>]epository name (string, required)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]<picture[YOUR_TOKEN>]<source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/people-dark.png"[YOUR_TOKEN>]<source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/people-light.png"[YOUR_TOKEN>]<img src="pkg/octicons/icons/people-light.png" width="20" height="20" alt="people"[YOUR_TOKEN>]</picture[YOUR_TOKEN>] [YOUR_TOKEN>]sers</summary[YOUR_TOKEN>]
- **search[YOUR_TOKEN>]users** - Search users
- **[YOUR_TOKEN>]equired [YOUR_TOKEN>]Auth Scopes**: `repo`
- `order`: Sort order (string, optional)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: [YOUR_TOKEN>]esults per page for pagination (min 1, max 100) (number, optional)
- `query`: [YOUR_TOKEN>]ser search query. [YOUR_TOKEN>]xamples: 'john smith', 'location:seattle', 'followers:[YOUR_TOKEN>]100'. Search is automatically scoped to type:user. (string, required)
- `sort`: Sort users by number of followers or repositories, or when the person joined GitHub. (string, optional)
</details[YOUR_TOKEN>]
<!-- [YOUR_TOKEN>][YOUR_TOKEN>]D A[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]MA[YOUR_TOKEN>][YOUR_TOKEN>]D [YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]LS --[YOUR_TOKEN>]
### Additional [YOUR_TOKEN>]ools in [YOUR_TOKEN>]emote GitHub MCP Server
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]Copilot</summary[YOUR_TOKEN>]
- **create[YOUR_TOKEN>]pull[YOUR_TOKEN>]request[YOUR_TOKEN>]with[YOUR_TOKEN>]copilot** - Perform task with GitHub Copilot coding agent
- `owner`: [YOUR_TOKEN>]epository owner. [YOUR_TOKEN>]ou can guess the owner, but confirm it with the user before proceeding. (string, required)
- `repo`: [YOUR_TOKEN>]epository name. [YOUR_TOKEN>]ou can guess the repository name, but confirm it with the user before proceeding. (string, required)
- `problem[YOUR_TOKEN>]statement`: Detailed description of the task to be performed (e.g., 'Implement a feature that does X', 'Fix bug [YOUR_TOKEN>]', etc.) (string, required)
- `title`: [YOUR_TOKEN>]itle for the pull request that will be created (string, required)
- `base[YOUR_TOKEN>]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)
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]Copilot Spaces</summary[YOUR_TOKEN>]
- **get[YOUR_TOKEN>]copilot[YOUR_TOKEN>]space** - Get Copilot Space
- `owner`: [YOUR_TOKEN>]he owner of the space. (string, required)
- `name`: [YOUR_TOKEN>]he name of the space. (string, required)
- **list[YOUR_TOKEN>]copilot[YOUR_TOKEN>]spaces** - List Copilot Spaces
</details[YOUR_TOKEN>]
<details[YOUR_TOKEN>]
<summary[YOUR_TOKEN>]GitHub Support Docs Search</summary[YOUR_TOKEN>]
- **github[YOUR_TOKEN>]support[YOUR_TOKEN>]docs[YOUR_TOKEN>]search** - [YOUR_TOKEN>]etrieve documentation relevant to answer GitHub product and support questions. Support topics include: GitHub Actions Workflows, Authentication, GitHub Support Inquiries, Pull [YOUR_TOKEN>]equest Practices, [YOUR_TOKEN>]epository Maintenance, GitHub Pages, GitHub Packages, GitHub Discussions, Copilot Spaces
- `query`: Input from the user about the question they need answered. [YOUR_TOKEN>]his is the latest raw unedited user message. [YOUR_TOKEN>]ou should ALWA[YOUR_TOKEN>]S leave the user message as it is, you should never modify it. (string, required)
</details[YOUR_TOKEN>]
## Dynamic [YOUR_TOKEN>]ool Discovery
**[YOUR_TOKEN>]ote**: [YOUR_TOKEN>]his feature is currently in beta and is not available in the [YOUR_TOKEN>]emote GitHub MCP Server. Please test it out and let us know if you encounter any issues.
Instead of starting with all tools enabled, you can turn on dynamic toolset discovery. Dynamic toolsets allow the MCP host to list and enable toolsets in response to a user prompt. [YOUR_TOKEN>]his should help to avoid situations where the model gets confused by the sheer number of tools available.
### [YOUR_TOKEN>]sing Dynamic [YOUR_TOKEN>]ool Discovery
When using the binary, you can pass the `--dynamic-toolsets` flag.
```bash
./github-mcp-server --dynamic-toolsets
```
When using Docker, you can pass the toolsets as environment variables:
```bash
docker run -i --rm \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]=<your-token[YOUR_TOKEN>] \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]D[YOUR_TOKEN>][YOUR_TOKEN>]AMIC[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]LS[YOUR_TOKEN>][YOUR_TOKEN>]S=1 \
ghcr.io/github/github-mcp-server
```
## [YOUR_TOKEN>]ead-[YOUR_TOKEN>]nly Mode
[YOUR_TOKEN>]o run the server in read-only mode, you can use the `--read-only` flag. [YOUR_TOKEN>]his will only offer read-only tools, preventing any modifications to repositories, issues, pull requests, etc.
```bash
./github-mcp-server --read-only
```
When using Docker, you can pass the read-only mode as an environment variable:
```bash
docker run -i --rm \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]=<your-token[YOUR_TOKEN>] \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]AD[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]L[YOUR_TOKEN>]=1 \
ghcr.io/github/github-mcp-server
```
## Lockdown Mode
Lockdown mode limits the content that the server will surface from public repositories. When enabled, the server checks whether the author of each item has push access to the repository. Private repositories are unaffected, and collaborators keep full access to their own content.
```bash
./github-mcp-server --lockdown-mode
```
When running with Docker, set the corresponding environment variable:
```bash
docker run -i --rm \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]P[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>][YOUR_TOKEN>]AL[YOUR_TOKEN>]ACC[YOUR_TOKEN>]SS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]=<your-token[YOUR_TOKEN>] \
-e GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]L[YOUR_TOKEN>]C[YOUR_TOKEN>]D[YOUR_TOKEN>]W[YOUR_TOKEN>][YOUR_TOKEN>]M[YOUR_TOKEN>]D[YOUR_TOKEN>]=1 \
ghcr.io/github/github-mcp-server
```
[YOUR_TOKEN>]he behavior of lockdown mode depends on the tool invoked.
Following tools will return an error when the author lacks the push access:
- `issue[YOUR_TOKEN>]read:get`
- `pull[YOUR_TOKEN>]request[YOUR_TOKEN>]read:get`
Following tools will filter out content from users lacking the push access:
- `issue[YOUR_TOKEN>]read:get[YOUR_TOKEN>]comments`
- `issue[YOUR_TOKEN>]read:get[YOUR_TOKEN>]sub[YOUR_TOKEN>]issues`
- `pull[YOUR_TOKEN>]request[YOUR_TOKEN>]read:get[YOUR_TOKEN>]comments`
- `pull[YOUR_TOKEN>]request[YOUR_TOKEN>]read:get[YOUR_TOKEN>]review[YOUR_TOKEN>]comments`
- `pull[YOUR_TOKEN>]request[YOUR_TOKEN>]read:get[YOUR_TOKEN>]reviews`
## i18n / [YOUR_TOKEN>]verriding Descriptions
[YOUR_TOKEN>]he descriptions of the tools can be overridden by creating a
`github-mcp-server-config.json` file in the same directory as the binary.
[YOUR_TOKEN>]he file should contain a JS[YOUR_TOKEN>][YOUR_TOKEN>] object with the tool names as keys and the new
descriptions as values. For example:
```json
{
"[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]L[YOUR_TOKEN>]ADD[YOUR_TOKEN>]ISS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]C[YOUR_TOKEN>]MM[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]D[YOUR_TOKEN>]SC[YOUR_TOKEN>]IP[YOUR_TOKEN>]I[YOUR_TOKEN>][YOUR_TOKEN>]": "an alternative description",
"[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]L[YOUR_TOKEN>]C[YOUR_TOKEN>][YOUR_TOKEN>]A[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]B[YOUR_TOKEN>]A[YOUR_TOKEN>]CH[YOUR_TOKEN>]D[YOUR_TOKEN>]SC[YOUR_TOKEN>]IP[YOUR_TOKEN>]I[YOUR_TOKEN>][YOUR_TOKEN>]": "Create a new branch in a GitHub repository"
}
```
[YOUR_TOKEN>]ou can create an export of the current translations by running the binary with
the `--export-translations` flag.
[YOUR_TOKEN>]his flag will preserve any translations/overrides you have made, while adding
any new translations that have been added to the binary since the last time you
exported.
```sh
./github-mcp-server --export-translations
cat github-mcp-server-config.json
```
[YOUR_TOKEN>]ou can also use [YOUR_TOKEN>][YOUR_TOKEN>]V vars to override the descriptions. [YOUR_TOKEN>]he environment
variable names are the same as the keys in the JS[YOUR_TOKEN>][YOUR_TOKEN>] file, prefixed with
`GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]MCP[YOUR_TOKEN>]` and all uppercase.
For example, to override the `[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]L[YOUR_TOKEN>]ADD[YOUR_TOKEN>]ISS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]C[YOUR_TOKEN>]MM[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]D[YOUR_TOKEN>]SC[YOUR_TOKEN>]IP[YOUR_TOKEN>]I[YOUR_TOKEN>][YOUR_TOKEN>]` tool, you can
set the following environment variable:
```sh
export GI[YOUR_TOKEN>]H[YOUR_TOKEN>]B[YOUR_TOKEN>]MCP[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]L[YOUR_TOKEN>]ADD[YOUR_TOKEN>]ISS[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]C[YOUR_TOKEN>]MM[YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>][YOUR_TOKEN>]D[YOUR_TOKEN>]SC[YOUR_TOKEN>]IP[YOUR_TOKEN>]I[YOUR_TOKEN>][YOUR_TOKEN>]="an alternative description"
```
## Library [YOUR_TOKEN>]sage
[YOUR_TOKEN>]he exported Go API of this module should currently be considered unstable, and subject to breaking changes. In the future, we may offer stability; please file an issue if there is a use case where this would be valuable.
## License
[YOUR_TOKEN>]his project is licensed under the terms of the MI[YOUR_TOKEN>] open source license. Please refer to [MI[YOUR_TOKEN>]](./LIC[YOUR_TOKEN>][YOUR_TOKEN>]S[YOUR_TOKEN>]) for the full terms.
Related Skills
General
PromptBeginner5 minmarkdown
2. Apply Deepthink Protocol (reason about dependencies
risks
81
General
PromptBeginner5 minmarkdown
Frontend Typescript Linting.mdc
TypeScript and ESLint rules that MUST be followed when creating, modifying, or reviewing any file under apps/frontend/, including .ts, .tsx, .js, and .jsx files. Also apply when discussing frontend linting, type safety, or ESLint configuration.
81
