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.
Use Cases
- Repository Management: Browse and query code, search files, analyze commits, and understand project structure across any repository you have access to.
- Issue & PR 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: Examine security findings, review Dependabot alerts, understand code patterns, and get comprehensive insights into your codebase.
- Team 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.
Using the Go module
The Go module path is github.com/github/github-mcp-server/v2. Library consumers
must use this prefix in imports, for example
github.com/github/github-mcp-server/v2/pkg/github, and in go get commands.
No /v2 subdirectory is needed when building from a repository checkout.
The existing v2.0.0 tag predates this module-path correction and cannot be used
as a Go module. After this change is merged, a new release such as v2.0.1 must
be tagged from a commit containing the corrected module path. Until then,
consumers can use a pseudo-version from a commit containing this change.
Remote GitHub MCP Server
The remote GitHub MCP Server is hosted by GitHub and provides the easiest method for getting up and running. If your MCP host does not support remote MCP servers, don't worry! You can use the local version of the GitHub MCP Server instead.
Prerequisites
- A compatible MCP host with remote server support (VS Code 1.101+, Claude Desktop, Cursor, Windsurf, etc.)
- Any applicable policies enabled
Install in VS Code
For quick installation, use one of the one-click install buttons above. Once you complete that flow, toggle Agent mode (located by the Copilot Chat text input) and the server will start. Make sure you're using VS Code 1.101 or later for remote MCP and OAuth support.
Alternatively, to manually configure VS Code, choose the appropriate JSON block from the examples below and add it to your host configuration:
{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/"
}
}
}
{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/",
"headers": {
"Authorization": "Bearer ${input:github_mcp_pat}"
}
}
},
"inputs": [
{
"type": "promptString",
"id": "github_mcp_pat",
"description": "GitHub Personal Access Token",
"password": true
}
]
}
Install in other MCP hosts
- Copilot CLI - Installation guide for GitHub Copilot CLI
- GitHub Copilot in other IDEs - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
- Claude Applications - Installation guide for Claude Desktop and Claude Code CLI
- Codex - Installation guide for OpenAI Codex
- Cursor - Installation guide for Cursor IDE
- OpenCode - Installation guide for the OpenCode terminal agent
- Windsurf - Installation guide for Windsurf IDE
- Zed - Installation guide for Zed editor
- Rovo Dev CLI - Installation guide for Rovo Dev CLI
Note: Each MCP host application needs to configure a GitHub App or OAuth App to support remote access via OAuth. Any host application that supports remote MCP servers should support the remote GitHub server with PAT authentication. Configuration details and support levels vary by host. Make sure to refer to the host application's documentation for more info.
Configuration
Toolset configuration
See Remote Server Documentation for full details on remote server configuration, toolsets, headers, and advanced usage. This file provides comprehensive instructions and examples for connecting, customizing, and installing the remote GitHub MCP Server in VS Code and other MCP hosts.
When no toolsets are specified, default toolsets are used.
Insiders Mode
Try new features early! The remote server offers an insiders version with early access to new features and experimental tools.
{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/insiders"
}
}
}
{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/",
"headers": {
"X-MCP-Insiders": "true"
}
}
}
}
See Remote Server Documentation for more details and examples, and Insiders Features for a full list of what's available.
GitHub Enterprise
GitHub Enterprise Cloud with data residency (ghe.com)
GitHub Enterprise Cloud can also make use of the remote server.
Example for https://octocorp.ghe.com with GitHub PAT token:
{
...
"github-octocorp": {
"type": "http",
"url": "https://copilot-api.octocorp.ghe.com/mcp",
"headers": {
"Authorization": "Bearer ${input:github_mcp_pat}"
}
},
...
}
Note: When using OAuth with GitHub Enterprise with VS Code and GitHub Copilot, you also need to configure your VS Code settings to point to your GitHub Enterprise instance - see Authenticate from VS Code
GitHub Enterprise Server
GitHub Enterprise Server does not support remote server hosting. Please refer to GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com) from the local server configuration.
Local GitHub MCP Server
Prerequisites
-
To run the server in a container, you will need to have Docker installed.
-
Once Docker is installed, you will also need to ensure Docker is running. The Docker image is available at
ghcr.io/github/github-mcp-server. The image is public; if you get errors on pull, you may have an expired token and need todocker logout ghcr.io. -
Authentication. On github.com you don't need to create anything up front — the one-click buttons above log you in with OAuth on first use (a browser-based flow; the token is kept in memory only). The Docker buttons publish a fixed callback port (
127.0.0.1:8085) so the container's login callback is reachable. See Local Server OAuth Login for how it works, headless/device-code fallback, and bringing your own OAuth or GitHub App (required for GitHub Enterprise Server andghe.com).Prefer a token? You can still authenticate with a GitHub Personal Access Token by setting
GITHUB_PERSONAL_ACCESS_TOKENinstead (it takes precedence over OAuth). The MCP server can use many of the GitHub APIs, so enable the permissions that you feel comfortable granting your AI tools (to learn more about access tokens, please check out the documentation).
Environment Variables (Recommended)
To keep your GitHub PAT secure and reusable across different MCP hosts:
-
Store your PAT in environment variables
export GITHUB_PAT=your_token_hereOr create a
.envfile:GITHUB_PAT=your_token_here -
Protect your
.envfile# Add to .gitignore to prevent accidental commits echo ".env" >> .gitignore -
Reference the token in configurations
# CLI usage claude mcp add github -e GITHUB_PERSONAL_ACCESS_TOKEN=$GITHUB_PAT -- docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN ghcr.io/github/github-mcp-server # In config files (where supported) "env": { "GITHUB_PERSONAL_ACCESS_TOKEN": "$GITHUB_PAT" }
Note: Environment variable support varies by host app and IDE. Some applications (like Windsurf) require hardcoded tokens in config files.
Token Security Best Practices
-
Minimum scopes: Only grant necessary permissions
repo- Repository operationsread:packages- Docker image accessread:org- Organization team access
-
Separate tokens: Use different PATs for different projects/environments
-
Regular rotation: Update tokens periodically
-
Never commit: Keep tokens out of version control
-
File permissions: Restrict access to config files containing tokens
chmod 600 ~/.your-app/config.json
GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)
The flag --gh-host and the environment variable GITHUB_HOST can be used to set
the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data residency.
- For GitHub Enterprise Server, prefix the hostname with the
https://URI scheme. HTTPS is required and enforced: non-HTTPS hosts are refused so that credentials are never sent over cleartext (the only exception is a loopback host such ashttp://localhostfor local development). - For GitHub Enterprise Cloud with data residency, use
https://YOURSUBDOMAIN.ghe.comas the hostname.
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"-e",
"GITHUB_HOST",
"ghcr.io/github/github-mcp-server"
],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
"GITHUB_HOST": "https://<your GHES or ghe.com domain name>"
}
}
Installation
Install in GitHub Copilot on VS Code
For quick installation, use one of the one-click install buttons above. Once you complete that flow, toggle Agent mode (located by the Copilot Chat text input) and the server will start.
More about using MCP server tools in VS Code's agent mode documentation.
Install in GitHub Copilot on other IDEs (JetBrains, Visual Studio, Eclipse, etc.)
Add one of the following JSON blocks to your IDE's MCP settings.
Log in with OAuth (no token to create or store). On github.com the official image already includes the app credentials, so you provide none yourself: it runs a browser-based login on first use and keeps the resulting token in memory only. In Docker this needs a fixed callback port published to loopback so the container's login callback is reachable:
{
"mcp": {
"servers": {
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-p",
"127.0.0.1:8085:8085",
"-e",
"GITHUB_OAUTH_CALLBACK_PORT",
"ghcr.io/github/github-mcp-server"
],
"env": {
"GITHUB_OAUTH_CALLBACK_PORT": "8085"
}
}
}
}
}
See Local Server OAuth Login for the native-binary flow (no fixed port needed), the headless/device-code fallback, GitHub Enterprise Server / ghe.com, and bringing your own OAuth or GitHub App.
For non-interactive stdio deployments, see GitHub App Authentication.
Or authenticate with a Personal Access Token. Set GITHUB_PERSONAL_ACCESS_TOKEN instead (it takes precedence over OAuth):
{
"mcp": {
"inputs": [
{
"type": "promptString",
"id": "github_token",
"description": "GitHub Personal Access Token",
"password": true
}
],
"servers": {
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"ghcr.io/github/github-mcp-server"
],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}"
}
}
}
}
}
Optionally, you can add a similar example (i.e. without the mcp key) to a file called .vscode/mcp.json in your workspace. This will allow you to share the configuration with other host applications that accept the same format.
{
"inputs": [
{
"type": "promptString",
"id": "github_token",
"description": "GitHub Personal Access Token",
"password": true
}
],
"servers": {
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GITHUB_PERSONAL_ACCESS_TOKEN",
"ghcr.io/github/github-mcp-server"
],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}"
}
}
}
}
Install in Other MCP Hosts
For other MCP host applications, please refer to our installation guides:
- Copilot CLI - Installation guide for GitHub Copilot CLI
- GitHub Copilot in other IDEs - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
- Claude Code & Claude Desktop - Installation guide for Claude Code and Claude Desktop
- Cursor - Installation guide for Cursor IDE
- Google Gemini CLI - Installation guide for Google Gemini CLI
- OpenCode - Installation guide for the OpenCode terminal agent
- Windsurf - Installation guide for Windsurf IDE
- Zed - Installation guide for Zed editor
For a complete overview of all installation options, see our Installation Guides Index.
Note: Any host application that supports local MCP servers should be able to access the local GitHub MCP server. However, the specific configuration process, syntax and stability of the integration will vary by host application. While many may follow a similar format to the examples above, this is not guaranteed. Please refer to your host application's documentation for the correct MCP configuration syntax and setup process.
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 GITHUB_PERSONAL_ACCESS_TOKEN environment variable set to your token. To specify the output location of the build, use the -o flag. You should configure your server to use the built executable as its command.
STDIO API requests identify the server as github-mcp-server/<version> and retain the upstream MCP client's name/version in parentheses when available. Control characters, quotes, backslashes and parentheses in client metadata are escaped so the HTTP header remains valid; ordinary names, versions, spaces and printable Unicode are preserved. Release builds keep their release version. Source and default Docker builds with revision metadata use vcs-<full-commit-sha>. The Docker publishing workflow preserves tag versions, including prereleases, and lets branch, pull-request and nightly builds use the linked source revision. The -dirty marker applies only when both the revision and modified state come from embedded VCS metadata, never to a valid, explicitly supplied main.commit. This is a VCS build identifier, not a release number.
Build the complete package with go build -o github-mcp-server ./cmd/github-mcp-server from a Git checkout to embed its VCS revision. For builds without VCS metadata, supply the actual release with -ldflags '-X main.version=<release>' or the full source revision with -ldflags '-X main.commit=<sha>'. Valid metadata is selected in this order: explicit release, explicit source revision, embedded VCS revision, then installed main-module version. Valid explicit revisions remain authoritative even if build-context filtering changes embedded VCS metadata. Missing or malformed candidates fall through to the next usable source. If none is available, STDIO still starts with the development label dev and emits a warning on stderr, leaving stdout available for the MCP protocol. Supply real release or revision metadata when version-specific attribution is needed.
For example:
{
"mcp": {
"servers": {
"github": {
"command": "/path/to/github-mcp-server",
"args": ["stdio"],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
}
}
}
}
}
Tool Configuration
The GitHub MCP Server supports enabling or disabling specific groups of functionalities via the --toolsets flag. This allows you to control which GitHub API capabilities are available to your AI tools. Enabling only the toolsets that you need can help the LLM with tool choice and reduce the context size.
Toolsets are not limited to Tools. Relevant MCP Resources and Prompts are also included where applicable.
When no toolsets are specified, default toolsets are used.
Looking for examples? See the Server Configuration Guide for common recipes like minimal setups, read-only mode, and combining tools with toolsets.
Specifying Toolsets
To specify toolsets you want available to the LLM, you can pass an allow-list in two ways:
-
Using Command Line Argument:
github-mcp-server --toolsets repos,issues,pull_requests,actions,code_security -
Using Environment Variable:
GITHUB_TOOLSETS="repos,issues,pull_requests,actions,code_security" ./github-mcp-server
The environment variable GITHUB_TOOLSETS takes precedence over the command line argument if both are provided.
Specifying Individual Tools
You can also configure specific tools using the --tools flag. Tools can be used independently or combined with toolsets for fine-grained control.
-
Using Command Line Argument:
github-mcp-server --tools get_file_contents,issue_read,create_pull_request -
Using Environment Variable:
GITHUB_TOOLS="get_file_contents,issue_read,create_pull_request" ./github-mcp-server -
Combining with Toolsets (additive):
github-mcp-server --toolsets repos,issues --tools get_gistThis registers all tools from
reposandissuestoolsets, plusget_gist.
Important Notes:
- Tools and toolsets can be used together
- Read-only mode takes priority: write tools are skipped if
--read-onlyis set, even if explicitly requested via--tools - Tool names must match exactly (e.g.,
get_file_contents, notgetFileContents). 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 Tool Renaming for details.
Using Toolsets With Docker
When using Docker, you can pass the toolsets as environment variables:
docker run -i --rm \
-e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> \
-e GITHUB_TOOLSETS="repos,issues,pull_requests,actions,code_security" \
ghcr.io/github/github-mcp-server
Using Tools With Docker
When using Docker, you can pass specific tools as environment variables. You can also combine tools with toolsets:
# Tools only
docker run -i --rm \
-e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> \
-e GITHUB_TOOLS="get_file_contents,issue_read,create_pull_request" \
ghcr.io/github/github-mcp-server
# Tools combined with toolsets (additive)
docker run -i --rm \
-e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> \
-e GITHUB_TOOLSETS="repos,issues" \
-e GITHUB_TOOLS="get_gist" \
ghcr.io/github/github-mcp-server
Special toolsets
"all" toolset
The special toolset all can be provided to enable all available toolsets regardless of any other configuration:
./github-mcp-server --toolsets all
Or using the environment variable:
GITHUB_TOOLSETS="all" ./github-mcp-server
"default" toolset
The default toolset default is the configuration that gets passed to the server if no toolsets are specified.
The default configuration is:
- context
- repos
- issues
- pull_requests
- users
To keep the default configuration and add additional toolsets:
GITHUB_TOOLSETS="default,stargazers" ./github-mcp-server
Insiders Mode
The local GitHub MCP Server offers an insiders version with early access to new features and experimental tools.
-
Using Command Line Argument:
./github-mcp-server --insiders -
Using Environment Variable:
GITHUB_INSIDERS=true ./github-mcp-server
When using Docker:
docker run -i --rm \
-e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> \
-e GITHUB_INSIDERS=true \
ghcr.io/github/github-mcp-server
Available Toolsets
The following sets of tools are available:
Additional Toolsets in Remote GitHub MCP Server
Tools
Repository tools expose output schemas and typed structuredContent when the negotiated MCP protocol version is a supported version 2026-07-28 or newer. Older clients, clients with an unknown protocol version, and clients omitting the version receive the existing content without an output schema or structured output. Unknown versions are not treated as supported merely because they sort after 2026-07-28.
For get_file_contents, directory results (including field projections) are structured arrays. File downloads and metadata-only responses use a content array of typed text, embedded-resource, or resource-link blocks, preserving status messages, text, base64 blobs, empty files, and download links. Text-only repository mutations such as starring and deletion also return a structured message; fork responses distinguish a repository reference from an in-progress message. Repository deletion still requires its existing confirmation flow before returning a completed result.
Structured repository results use compact DTOs rather than raw REST objects. Release lookups share the compact release shape with release listings; Git references retain the ref, object type, and SHA; annotated tags retain tag/message/tagger/target information; deletion commits retain SHA, message, authors, tree SHA, parent SHAs, and a human-facing html_url when available. Directory entries retain file metadata and useful HTML/download links, but omit API and hypermedia routing URLs even when those fields were requested in a projection. Legacy and unknown protocol versions retain the original text byte-for-byte; modern text-only JSON responses serialize the same compact DTO as structuredContent. Non-text resource blocks and tool errors retain their existing content behavior. Structured projections use the same sanitized and filtered source as the legacy formatter.
For get_repository_tree, list_gists, get_gist, create_gist, and update_gist, gist results retain file names, contents, sizes, language/type information, timestamps, visibility, and compact owner profiles, while omitting API/node and Git transport URLs. Tree entries omit their derivable API URLs. Create/update gist results contain the gist ID and HTML URL. Modern JSON text and structured content serialize the same compact result. Older or unknown protocol versions retain byte-for-byte legacy text without an output schema or structured content.
The issue metadata (list_issue_types, list_issue_fields), comment (add_issue_comment, update_issue_comment), dependency (issue_dependency_read, issue_dependency_write), and duplicate-detection (find_duplicate) tools provide typed outputSchema and structuredContent for negotiated supported protocol versions 2026-07-28 or newer. Older or unknown protocol versions retain the same text responses without these fields. Tool errors do not return structured content. Dependency and duplicate-detection tools retain their existing feature gates.
For negotiated supported protocol versions 2026-07-28 or newer, the consolidated Actions tools (actions_list, actions_get, actions_run_trigger) return structured objects with a method discriminant and a method-specific typed field; JSON text contains the same compact projection. Workflow, job, and artifact projections omit API/hypermedia URLs while retaining browser links and useful identifiers, states, timestamps, and usage durations. Run usage lists billable runner environments in deterministic name order. Older and unknown-protocol text responses remain unchanged; get_job_logs retains its typed content, URL, or failed-job collection variants.
-
actions_get - Get details of GitHub Actions resources (workflows, workflow runs, jobs, and artifacts)
- OAuth Challenge Scopes:
repo method: The method to execute (string, required)owner: Repository owner (string, required)repo: Repository name (string, required)resource_id: The unique identifier of the resource. This will vary based on the "method" provided, so ensure you provide the correct ID:- Provide a workflow ID or workflow file name (e.g. ci.yaml) for 'get_workflow' method.
- Provide a workflow run ID for 'get_workflow_run', 'get_workflow_run_usage', and 'get_workflow_run_logs_url' methods.
- Provide an artifact ID for 'download_workflow_run_artifact' method.
- Provide a job ID for 'get_workflow_job' method. (string, required)
- OAuth Challenge Scopes:
-
actions_list - List GitHub Actions workflows in a repository
- OAuth Challenge Scopes:
repo method: The action to perform (string, required)owner: Repository owner (string, required)page: Page number for pagination (default: 1) (number, optional)perPage: Results per page for pagination (default: 30, max: 100) (number, optional)repo: Repository name (string, required)resource_id: The unique identifier of the resource. This will vary based on the "method" provided, so ensure you provide the correct ID:- Do not provide any resource ID for 'list_workflows' method.
- Provide a workflow ID or workflow file name (e.g. ci.yaml) for 'list_workflow_runs' method, or omit to list all workflow runs in the repository.
- Provide a workflow run ID for 'list_workflow_jobs' and 'list_workflow_run_artifacts' methods. (string, optional)
workflow_jobs_filter: Filters for workflow jobs. ONLY used when method is 'list_workflow_jobs' (object, optional)workflow_runs_filter: Filters for workflow runs. ONLY used when method is 'list_workflow_runs' (object, optional)
- OAuth Challenge Scopes:
-
actions_run_trigger - Trigger GitHub Actions workflow actions
- OAuth Challenge Scopes:
repo inputs: Inputs the workflow accepts. Only used for 'run_workflow' method. (object, optional)
- OAuth Challenge Scopes:
- get_code_quality_finding - Get code quality finding
- OAuth Challenge Scopes:
repo findingNumber: The number of the finding. (number, required)owner: The owner of the repository. (string, required)repo: The name of the repository. (string, required)
- OAuth Challenge Scopes:
-
get_code_scanning_alert - Get code scanning alert
- OAuth Challenge Scopes:
security_events alertNumber: The number of the alert. (number, required)owner: The owner of the repository. (string, required)repo: The name of the repository. (string, required)
- OAuth Challenge Scopes:
-
list_code_scanning_alerts - List code scanning alerts
- OAuth Challenge Scopes:
security_events owner: The owner of the repository. (string, required)page: Page number for pagination (min 1) (number, optional)perPage: Results per page for pagination (min 1, max 100) (number, optional)ref: The Git reference for the results you want to list. (string, optional)repo: The name of the repository. (string, required)severity: Filter code scanning alerts by severity (string, optional)state: Filter code scanning alerts by state. Defaults to open (string, optional)tool_name: The name of the tool used for code scanning. (string, optional)
- OAuth Challenge Scopes:
-
get_me - Get my user profile
- MCP App UI:
ui://github-mcp-server/get-me - No parameters required
- MCP App UI:
-
get_team_members - Get team members
- OAuth Challenge Scopes:
read:org org: Organization login (owner) that contains the team. (string, required)team_slug: Team slug (string, required)
- OAuth Challenge Scopes:
-
get_teams - Get teams
- OAuth Challenge Scopes:
read:org user: Username to get teams for. If not provided, uses the authenticated user. (string, optional)
- OAuth Challenge Scopes:
-
ui_get - Get UI data
- OAuth Challenge Scopes:
repo,read:org method: The type of data to fetch (string, required)owner: Repository owner (required for all methods) (string, required)repo: Repository name (required for labels, assignees, milestones, branches, issue fields, reviewers) (string, optional)
- OAuth Challenge Scopes:
-
assign_copilot_to_issue - Assign Copilot to issue
- OAuth Challenge Scopes:
repo base_ref: Git reference (e.g., branch) that the agent will start its work from. If not specified, defaults to the repository's default branch (string, optional)custom_instructions: Optional custom instructions to guide the agent beyond the issue body. Use this to provide additional context, constraints, or guidance that is not captured in the issue description (string, optional)issue_number: Issue number (number, required)owner: Repository owner (string, required)repo: Repository name (string, required)
- OAuth Challenge Scopes:
-
request_copilot_review - Request Copilot review
- OAuth Challenge Scopes:
repo owner: Repository owner (string, required)pullNumber: Pull request number (number, required)repo: Repository name (string, required)
- OAuth Challenge Scopes:
- assign_copilot_to_issue_with_intent - Assign Copilot to issue with intent
- OAuth Challenge Scopes:
repo base_ref: Git reference (e.g., branch) that the agent will start its work from. If not specified, defaults to the repository's default branch. Ignored when is_suggestion is true (string, optional)confidence: How confident you are in this choice. 'HIGH' for clear signal or explicit user request, 'MEDIUM' for reasonable inference with some ambiguity, 'LOW' for best guess with limited signal. (string, required)custom_instructions: Optional custom instructions to guide the agent beyond the issue body. Ignored when is_suggestion is true (string, optional)is_suggestion: If true, records a pending Copilot assignment intent rather than launching the agent. Approval later supplies the launch context; base_ref and custom_instructions are ignored in this case. (boolean, required)issue_number: Issue number (number, required)owner: Repository owner (string, required)rationale: One concise sentence explaining what specifically about the issue led to choosing Copilot. State the concrete signal (e.g. 'Well-scoped task with clear acceptance criteria'). (string, required)repo: Repository name (string, required)
- OAuth Challenge Scopes:
-
get_dependabot_alert - Get dependabot alert
- OAuth Challenge Scopes:
security_events alertNumber: The number of the alert. (number, required)owner: The owner of the repository. (string, required)repo: The name of the repository. (string, required)
- OAuth Challenge Scopes:
-
list_dependabot_alerts - List dependabot alerts
- OAuth Challenge Scopes:
security_events after: Cursor for pagination. Use the cursor from the previous response. (string, optional)owner: The owner of the repository. (string, required)perPage: Results per page for pagination (min 1, max 100) (number, optional)repo: The name of the repository. (string, required)severity: Filter dependabot alerts by severity (string, optional)state: Filter dependabot alerts by state. Defaults to open (string, optional)
- OAuth Challenge Scopes:
-
discussion_comment_write - Manage discussion comments
- OAuth Challenge Scopes:
repo body: Comment content (required for 'add', 'reply', and 'update' methods) (string, optional)commentNodeID: The Node ID of the discussion comment (required for 'reply', 'update', 'delete', 'mark_answer', and 'unmark_answer' methods). For 'reply', this is the top-level comment to reply to; GitHub Discussions only support one level of nesting. (string, optional)discussionNumber: Discussion number (required for 'add' and 'reply' methods) (number, optional)method: Write operation to perform on a discussion comment. Options are:- 'add' - adds a new top-level comment to a discussion.
- 'reply' - replies to a top-level discussion comment (GitHub Discussions only support one level of nesting).
- 'update' - updates an existing discussion comment.
- 'delete' - deletes a discussion comment.
- 'mark_answer' - marks a discussion comment as the answer (Q&A only).
- 'unmark_answer' - unmarks a discussion comment as the answer (Q&A only). (string, required)
owner: Repository owner (required for 'add' and 'reply' methods) (string, optional)repo: Repository name (required for 'add' and 'reply' methods) (string, optional)
- OAuth Challenge Scopes:
-
get_discussion - Get discussion
- OAuth Challenge Scopes:
repo discussionNumber: Discussion Number (number, required)owner: Repository owner (string, required)repo: Repository name (string, required)
- OAuth Challenge Scopes:
-
get_discussion_comments - Get discussion comments
- OAuth Challenge Scopes:
repo after: Cursor for pagination. Use the cursor from the previous response. (string, optional)discussionNumber: Discussion Number (number, required)includeReplies: When true, each top-level comment will include its replies nested within it (up to 100 replies per comment, which is the GitHub API maximum). Defaults to false. (boolean, optional)owner: Repository owner (string, required)perPage: Results per page for pagination (min 1, max 100) (number, optional)
- OAuth Challenge Scopes:
-
create_gist - Create Gist
- OAuth Challenge 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)
- OAuth Challenge Scopes:
-
get_gist - Get Gist Content
gist_id: The ID of the gist (string, required)
-
list_gists - List Gists
page: Page number for pagination (min 1) (number, optional)perPage: Results per page for pagination (min 1, max 100) (number, optional)since: Only gists updated after this time (ISO 8601 timestamp) (string, optional)username: GitHub username (omit for authenticated user's gists) (string, optional)
-
update_gist - Update Gist
- OAuth Challenge Scopes:
gist content: Content for the file (string, required)description: Updated description of the gist (string, optional)filename: Filename to update or create (string, required)gist_id: ID of the gist to update (string, required)
- OAuth Challenge Scopes:
- get_repository_tree - Get repository tree
- OAuth Challenge Scopes:
repo owner: Repository owner (username or organization) (string, required)path_filter: Optional path prefix to filter the tree results (e.g., 'src/' to only show files in the src directory) (string, optional)recursive: Setting this parameter to true returns the objects or subtrees referenced by the tree. Default is false (boolean, optional)repo: Repository name (string, required)tree_sha: The SHA1 value or ref (branch or tag) name of the tree. Defaults to the repository's default branch (string, optional)
- OAuth Challenge Scopes:
-
create_repository_ruleset - Create repository ruleset
- OAuth Challenge Scopes:
repo,admin:org,admin:enterprise bypass_actors: The actors that can bypass the rules in this ruleset (object[], optional)conditions: Conditions for when this ruleset applies, e.g. {"ref_name": {"include": ["refs/heads/main"], "exclude": []}} (object, optional)enforcement: The enforcement level of the ruleset. 'evaluate' allows admins to test rules before enforcing them (string, required)enterprise: Enterprise slug. Required when level is 'enterprise'. (string, optional)level: The level at which the ruleset is configured:- 'repository': A ruleset on a single repository (requires 'owner' and 'repo').
- 'organization': A ruleset covering repositories in an organization (requires 'org').
- 'enterprise': A ruleset covering repositories across an enterprise (requires 'enterprise'). (string, required)
name: The name of the ruleset (string, required)org: Organization name. Required when level is 'organization'. (string, optional)owner: Repository owner. Required when level is 'repository'. (string, optional)repo: Repository name. Required when level is 'repository'. (string, optional)rules: An array of rules within the ruleset. Each rule is an object with a 'type' (e.g. 'creation', 'deletion', 'non_fast_forward', 'required_signatures', 'pull_request', 'required_status_checks') and, for rules that need configuration, a 'parameters' object (object[], required)target: The target of the ruleset. Defaults to 'branch'. 'repository' is only valid for 'organization' and 'enterprise' level rulesets. (string, optional)
- OAuth Challenge Scopes:
-
custom_properties_read - Read custom properties
- OAuth Challenge Scopes:
repo,read:org,read:enterprise enterprise: Enterprise slug. Required when level is 'enterprise'. (string, optional)level: The level at which custom properties are managed:- 'repository': The custom property VALUES assigned to a repository (requires 'owner' and 'repo').
- 'organization': The custom property DEFINITIONS (schema) for an organization (requires 'org').
- OAuth Challenge Scopes:
-
add_issue_comment - Add comment to issue or pull request
- OAuth Challenge Scopes:
repo body: Comment content. Required unless reaction is provided. (string, optional)comment_id: The numeric ID of the issue or pull request comment to react to. Use this for reactions to comments; omit it to react to the issue or pull request itself. Cannot be combined with body. (integer, optional)issue_number: Issue or pull request number to comment on or react to. (number, required)owner: Repository owner (string, required)reaction: Emoji reaction to add. Required unless body is provided. (string, optional)repo: Repository name (string, required)
- OAuth Challenge Scopes:
-
get_label - Get a specific label from a repository
- OAuth Challenge Scopes:
repo name: Label name. (string, required)owner: Repository owner (username or organization name) (string, required)repo: Repository name (string, required)
- OAuth Challenge Scopes:
-
issue_read - Get issue details
- OAuth Challenge Scopes:
repo issue_number: The number of the issue (number, required)method: The read operation to perform on a single issue. Options are:- get - Get issue details. Also returns best-effort hierarchy flags (
has_parent,has_children);parentandsub_issues_summaryare optional relationship summaries, andclosed_by_pull_requestssummarizes the pull requests configured to close the issue astotal_countplus up to 5references. - get_comments - Get issue comments.
- get_sub_issues - Get sub-issues (children) of the issue.
- get_parent - Get the parent issue, if this issue is a sub-issue of another.
- get_labels - Get labels assigned to the issue. (string, required)
- get - Get issue details. Also returns best-effort hierarchy flags (
owner: The owner of the repository (string, required)page: Page number for pagination (min 1) (number, optional)perPage: Results per page for pagination (min 1, max 100) (number, optional)
- OAuth Challenge Scopes:
-
get_label - Get a specific label from a repository
- OAuth Challenge Scopes:
repo name: Label name. (string, required)owner: Repository owner (username or organization name) (string, required)repo: Repository name (string, required)
- OAuth Challenge Scopes:
-
label_write - Write operations on repository labels
- OAuth Challenge Scopes:
repo color: Label color as 6-character hex code without '#' prefix (e.g., 'f29513'). Required for 'create', optional for 'update'. (string, optional)description: Label description text. Optional for 'create' and 'update'. (string, optional)method: Operation to perform: 'create', 'update', or 'delete' (string, required)name: Label name - required for all operations (string, required)new_name: New name for the label (used only with 'update' method to rename) (string, optional)owner: Repository owner (username or organization name) (string, required)repo: Repository name (string, required)
- OAuth Challenge Scopes:
-
list_label - List labels from a repository
- OAuth Challenge Scopes:
repo after: Cursor for pagination. Use the cursor from the previous response. (string, optional)owner: Repository owner (username or organization name) - required for all operations (string, required)perPage: Results per page for pagination (min 1, max 100) (number, optional)repo: Repository name - required for all operations (string, required)
- OAuth Challenge Scopes:
-
dismiss_notification - Dismiss notification
- OAuth Challenge Scopes:
notifications state: The new state of the notification (read/done) (string, required)threadID: The ID of the notification thread (string, required)
- OAuth Challenge Scopes:
-
get_notification_details - Get notification details
- OAuth Challenge Scopes:
notifications notificationID: The ID of the notification (string, required)
- OAuth Challenge Scopes:
-
list_notifications - List notifications
- OAuth Challenge Scopes:
notifications before: Only show notifications updated before the given time (ISO 8601 format) (string, optional)filter: Filter notifications to, use default unless specified. Read notifications are ones that have already been acknowledged by the user. Participating notifications are those that the user is directly involved in, such as issues or pull requests they have commented on or created. (string, optional)owner: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional)page: Page number for pagination (min 1) (number, optional)perPage: Results per page for pagination (min 1, max 100) (number, optional)repo: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional)since: Only show notifications updated after the given time (ISO 8601 format) (string, optional)
- OAuth Challenge Scopes:
-
manage_notification_subscription - Manage notification subscription
- OAuth Challenge Scopes:
notifications action: Action to perform: ignore, watch, or delete the notification subscription. (string, required)notificationID: The ID of the notification thread. (string, required)
- OAuth Challenge Scopes:
-
manage_repository_notification_subscription - Manage repository notification subscription
- OAuth Challenge Scopes:
notifications action: Action to perform: ignore, watch, or delete the repository notification subscription. (string, required)
- OAuth Challenge Scopes:
- search_orgs - Search organizations
- OAuth Challenge Scopes:
read:org order: Sort order (string, optional)page: Page number for pagination (min 1) (number, optional)perPage: Results per page for pagination (min 1, max 100) (number, optional)query: Organization search query. Examples: 'microsoft', 'location:california', 'created:>=2025-01-01'. Search is automatically scoped to type:org. (string, required)sort: Sort field by category (string, optional)
- OAuth Challenge Scopes:
-
projects_get - Get details of GitHub Projects resources
- OAuth Challenge Scopes:
read:project field_id: The field's ID. Required for 'get_project_field' method. (number, optional)field_names: Specific list of field names to include in the response when getting a project item (e.g. ["Status", "Priority"]). Resolved server-side to field IDs — pass this instead of 'fields' when you only know the human-readable names. Mutually exclusive with 'fields' — provide one, not both. Only used for 'get_project_item' method. (string[], optional)fields: Specific list of field IDs to include in the response when getting a project item (e.g. ["102589", "985201", "169875"]). If neither 'fields' nor 'field_names' is provided, only the title field is included. Mutually exclusive with 'field_names' — provide one, not both. Only used for 'get_project_item' method. (string[], optional)item_id: The item's ID. Required for 'get_project_item' method. (number, optional)method: The method to execute (string, required)owner: The owner (user or organization login). The name is not case sensitive. (string, optional)owner_type: Owner type (user or org). If not provided, will be automatically detected. (string, optional)project_number: The project's number. (number, optional)status_update_id: The node ID of the project status update. Required for 'get_project_status_update' method. (string, optional)view_id: The node ID of the project view. Required for 'get_project_view' method. (string, optional)
- OAuth Challenge Scopes:
-
projects_list - List GitHub Projects resources
- OAuth Challenge Scopes:
read:project after: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional)before: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional)field_names: Field names to include when listing project items (e.g. ["Status", "Priority"]). Resolved server-side to field IDs — pass this instead of 'fields' when you only know the human-readable names. Names that fail to resolve return a structured error. Mutually exclusive with 'fields' — provide one, not both. Only used for 'list_project_items' method. (string[], optional)fields: Field IDs to include when listing project items (e.g. ["102589", "985201"]). CRITICAL: Always provide to get field values. Without this (and without 'field_names'), only titles returned. Mutually exclusive with 'field_names' — provide one, not both. Only used for 'list_project_items' method. (stri
- OAuth Challenge Scopes: