Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commita162ba3

Browse files
committed
Resolve README.md merge conflict by accepting upstream/main version
2 parents4ba494c +853323d commita162ba3

File tree

23 files changed

+1139
-321
lines changed

23 files changed

+1139
-321
lines changed

‎README.md

Lines changed: 57 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,55 @@ The GitHub MCP Server is a [Model Context Protocol (MCP)](https://modelcontextpr
44
server that provides seamless integration with GitHub APIs, enabling advanced
55
automation and interaction capabilities for developers and tools.
66

7-
[![Install with Docker in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=github&inputs=%5B%7B%22id%22%3A%22github_token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22GitHub%20Personal%20Access%20Token%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%22GITHUB_PERSONAL_ACCESS_TOKEN%22%2C%22ghcr.io%2Fgithub%2Fgithub-mcp-server%22%5D%2C%22env%22%3A%7B%22GITHUB_PERSONAL_ACCESS_TOKEN%22%3A%22%24%7Binput%3Agithub_token%7D%22%7D%7D) [![Install with Docker in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install_Server-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=github&inputs=%5B%7B%22id%22%3A%22github_token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22GitHub%20Personal%20Access%20Token%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%22GITHUB_PERSONAL_ACCESS_TOKEN%22%2C%22ghcr.io%2Fgithub%2Fgithub-mcp-server%22%5D%2C%22env%22%3A%7B%22GITHUB_PERSONAL_ACCESS_TOKEN%22%3A%22%24%7Binput%3Agithub_token%7D%22%7D%7D&quality=insiders)
8-
9-
##Use Cases
7+
###Use Cases
108

119
- Automating GitHub workflows and processes.
1210
- Extracting and analyzing data from GitHub repositories.
1311
- Building AI powered tools and applications that interact with GitHub's ecosystem.
1412

13+
---
14+
15+
##Remote GitHub MCP Server
16+
17+
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](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)[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install_Server-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](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)
18+
19+
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](https://github.com/github/github-mcp-server?tab=readme-ov-file#local-github-mcp-server) instead.
20+
21+
##Prerequisites
22+
23+
1. An MCP host that supports the latest MCP specification and remote servers, such as[VS Code](https://code.visualstudio.com/).
24+
25+
##Installation
26+
27+
###Usage with VS Code
28+
29+
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 the[latest version of VS Code](https://code.visualstudio.com/updates/v1_101) for remote MCP and OAuth support.
30+
31+
###Usage in other MCP Hosts
32+
33+
For MCP Hosts that have been[configured to use the remote GitHub MCP Server](docs/host-integration.md), add the following JSON block to the host's configuration:
34+
35+
```json
36+
{
37+
"mcp": {
38+
"servers": {
39+
"github": {
40+
"type":"http",
41+
"url":"https://api.githubcopilot.com/mcp/"
42+
}
43+
}
44+
}
45+
}
46+
```
47+
48+
>**Note:** The exact configuration format may vary by host. Refer to your host's documentation for the correct syntax and location for remote MCP server setup.
49+
50+
---
51+
52+
##Local GitHub MCP Server
53+
54+
[![Install with Docker in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=github&inputs=%5B%7B%22id%22%3A%22github_token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22GitHub%20Personal%20Access%20Token%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%22GITHUB_PERSONAL_ACCESS_TOKEN%22%2C%22ghcr.io%2Fgithub%2Fgithub-mcp-server%22%5D%2C%22env%22%3A%7B%22GITHUB_PERSONAL_ACCESS_TOKEN%22%3A%22%24%7Binput%3Agithub_token%7D%22%7D%7D) [![Install with Docker in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install_Server-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=github&inputs=%5B%7B%22id%22%3A%22github_token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22GitHub%20Personal%20Access%20Token%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%22GITHUB_PERSONAL_ACCESS_TOKEN%22%2C%22ghcr.io%2Fgithub%2Fgithub-mcp-server%22%5D%2C%22env%22%3A%7B%22GITHUB_PERSONAL_ACCESS_TOKEN%22%3A%22%24%7Binput%3Agithub_token%7D%22%7D%7D&quality=insiders)
55+
1556
##Prerequisites
1657

1758
1. To run the server in a container, you will need to have[Docker](https://www.docker.com/) installed.
@@ -23,9 +64,11 @@ The MCP server can use many of the GitHub APIs, so enable the permissions that y
2364

2465
###Usage with VS Code
2566

26-
For quick installation, use one of the one-click install buttons at the top of this README. Once you complete that flow, toggle Agent mode (located by the Copilot Chat text input) and the server will start.
67+
For quick installation, use one of the one-click install buttons. Once you complete that flow, toggle Agent mode (located by the Copilot Chat text input) and the server will start.
68+
69+
###Usage in other MCP Hosts
2770

28-
For manual installation, addthe following JSON block to yourUser Settings (JSON) file in VS Code. You can do this by pressing`Ctrl + Shift + P` and typing`Preferences: Open User Settings (JSON)`.
71+
Addthe following JSON block to yourIDE MCP settings.
2972

3073
```json
3174
{
@@ -141,20 +184,25 @@ If you don't have Docker, you can use `go build` to build the binary in the
141184

142185
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.
143186

187+
_Toolsets are not limited to Tools. Relevant MCP Resources and Prompts are also included where applicable._
188+
144189
###Available Toolsets
145190

146191
The following sets of tools are available (all are on by default):
147192

148193
| Toolset| Description|
149194
| -----------------------| -------------------------------------------------------------|
150-
|`repos`| Repository-related tools (file operations, branches, commits)|
195+
|`context`|**Strongly recommended**: Tools that provide context about the current user and GitHub context you are operating in|
196+
|`code_security`| Code scanning alerts and security features|
151197
|`issues`| Issue-related tools (create, read, update, comment)|
152-
|`users`| Anything relating toGitHubUsers|
198+
|`notifications`|GitHubNotifications related tools|
153199
|`pull_requests`| Pull request operations (create, merge, review)|
154-
|`actions`| GitHub Actions workflows and CI/CD operations|
155-
|`code_security`| Code scanning alerts and security features|
200+
|`repos`| Repository-related tools (file operations, branches, commits)|
201+
|`secret_protection`| Secret protection related tools, such as GitHub Secret Scanning|
202+
|`users`| Anything relating to GitHub Users|
156203
|`experiments`| Experimental features (not considered stable)|
157204

205+
158206
####Specifying Toolsets
159207

160208
To specify toolsets you want available to the LLM, you can pass an allow-list in two ways:

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp