Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ The remote GitHub MCP Server is hosted by GitHub and provides the easiest method

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](https://code.visualstudio.com/updates/v1_101) or [later](https://code.visualstudio.com/updates) for remote MCP and OAuth support.


Alternatively, to manually configure VS Code, choose the appropriate JSON block from the examples below and add it to your host configuration:

<table>
Expand Down Expand Up @@ -176,7 +175,6 @@ Add the following JSON block to your IDE MCP settings.

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 others.


```json
{
"inputs": [
Expand Down Expand Up @@ -276,7 +274,6 @@ The following sets of tools are available (all are on by default):
| `users` | Anything relating to GitHub Users |
| `experiments` | Experimental features (not considered stable) |


#### Specifying Toolsets

To specify toolsets you want available to the LLM, you can pass an allow-list in two ways:
Expand All @@ -288,6 +285,7 @@ To specify toolsets you want available to the LLM, you can pass an allow-list in
```

2. **Using Environment Variable**:

```bash
GITHUB_TOOLSETS="repos,issues,pull_requests,actions,code_security" ./github-mcp-server
```
Expand Down Expand Up @@ -366,6 +364,7 @@ the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data r

- For GitHub Enterprise Server, prefix the hostname with the `https://` URI scheme, as it otherwise defaults to `http://`, which GitHub Enterprise Server does not support.
- For GitHub Enterprise Cloud with data residency, use `https://YOURSUBDOMAIN.ghe.com` as the hostname.

``` json
"github": {
"command": "docker",
Expand Down Expand Up @@ -491,7 +490,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- `assignees`: New assignees (string[], optional)
- `milestone`: New milestone number (number, optional)

- **search_issues** - Search for issues and pull requests
- **search_issues** - Search for issues
- `query`: Search query (string, required)
- `sort`: Sort field (string, optional)
- `order`: Sort order (string, optional)
Expand Down Expand Up @@ -527,6 +526,16 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- `perPage`: Results per page (number, optional)
- `page`: Page number (number, optional)

- **search_pull_requests** - Search for pull requests in GitHub repositories using pull request search syntax

- `query`: Search query using GitHub pull request search syntax (string, required)
- `owner`: Repository owner (string, optional)
- `repo`: Repository name (string, optional)
- `sort`: Sort field (string, optional)
- `order`: Sort order (string, optional)
- `page`: Page number (number, optional)
- `perPage`: Results per page (number, optional)

- **merge_pull_request** - Merge a pull request

- `owner`: Repository owner (string, required)
Expand All @@ -541,6 +550,10 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- `owner`: Repository owner (string, required)
- `repo`: Repository name (string, required)
- `pullNumber`: Pull request number (number, required)
- `sort`: Sort field (string, optional)
- `direction`: Sort direction (string, optional)
- `perPage`: Results per page (number, optional)
- `page`: Page number (number, optional)

- **get_pull_request_status** - Get the combined status of all status checks for a pull request

Expand Down