You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-17Lines changed: 26 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,7 +86,9 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
86
86
-**[Claude Applications](/docs/installation-guides/install-claude.md)** - Installation guide for Claude Desktop and Claude Code CLI
87
87
-**[Codex](/docs/installation-guides/install-codex.md)** - Installation guide for OpenAI Codex
88
88
-**[Cursor](/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
89
+
-**[OpenCode](/docs/installation-guides/install-opencode.md)** - Installation guide for the OpenCode terminal agent
89
90
-**[Windsurf](/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
91
+
-**[Zed](/docs/installation-guides/install-zed.md)** - Installation guide for Zed editor
90
92
-**[Rovo Dev CLI](/docs/installation-guides/install-rovo-dev-cli.md)** - Installation guide for Rovo Dev CLI
91
93
92
94
> **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.
@@ -212,7 +214,7 @@ To keep your GitHub PAT secure and reusable across different MCP hosts:
212
214
213
215
```bash
214
216
# CLI usage
215
-
claude mcp update github -e GITHUB_PERSONAL_ACCESS_TOKEN=$GITHUB_PAT
217
+
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
216
218
217
219
# In config files (where supported)
218
220
"env": {
@@ -356,7 +358,9 @@ For other MCP host applications, please refer to our installation guides:
356
358
-**[Claude Code & Claude Desktop](docs/installation-guides/install-claude.md)** - Installation guide for Claude Code and Claude Desktop
357
359
-**[Cursor](docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
358
360
-**[Google Gemini CLI](docs/installation-guides/install-gemini-cli.md)** - Installation guide for Google Gemini CLI
361
+
-**[OpenCode](docs/installation-guides/install-opencode.md)** - Installation guide for the OpenCode terminal agent
359
362
-**[Windsurf](docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
363
+
-**[Zed](docs/installation-guides/install-zed.md)** - Installation guide for Zed editor
360
364
361
365
For a complete overview of all installation options, see our **[Installation Guides Index](docs/installation-guides)**.
362
366
@@ -713,8 +717,8 @@ The following sets of tools are available:
713
717
-**list_dependabot_alerts** - List dependabot alerts
-`after`: Cursor for pagination. Use the cursor from the previous response. (string, optional)
716
721
-`owner`: The owner of the repository. (string, required)
717
-
-`page`: Page number for pagination (min 1) (number, optional)
718
722
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
719
723
-`repo`: The name of the repository. (string, required)
720
724
-`severity`: Filter dependabot alerts by severity (string, optional)
@@ -751,7 +755,7 @@ The following sets of tools are available:
751
755
752
756
-**get_discussion_comments** - Get discussion comments
753
757
-**Required OAuth Scopes**: `repo`
754
-
-`after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional)
758
+
-`after`: Cursor for pagination. Use the cursor from the previous response. (string, optional)
755
759
-`discussionNumber`: Discussion Number (number, required)
756
760
-`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)
757
761
-`owner`: Repository owner (string, required)
@@ -765,7 +769,7 @@ The following sets of tools are available:
765
769
766
770
-**list_discussions** - List discussions
767
771
-**Required OAuth Scopes**: `repo`
768
-
-`after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional)
772
+
-`after`: Cursor for pagination. Use the cursor from the previous response. (string, optional)
769
773
-`category`: Optional filter by discussion category ID. If provided, only discussions with this category are listed. (string, optional)
770
774
-`direction`: Order direction. (string, optional)
771
775
-`orderBy`: Order discussions by field. If provided, the 'direction' also needs to be provided. (string, optional)
@@ -822,7 +826,7 @@ The following sets of tools are available:
-**add_issue_comment** - Add comment to issue or pull request
826
830
-**Required OAuth Scopes**: `repo`
827
831
-`body`: Comment content (string, required)
828
832
-`issue_number`: Issue number to comment on (number, required)
@@ -850,7 +854,7 @@ The following sets of tools are available:
850
854
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
851
855
-`repo`: The name of the repository (string, required)
852
856
853
-
-**issue_write** - Create or update issue
857
+
-**issue_write** - Create or update issue/pull request
854
858
-**Required OAuth Scopes**: `repo`
855
859
-`assignees`: Usernames to assign to this issue (string[], optional)
856
860
-`body`: Issue body content (string, optional)
@@ -877,7 +881,7 @@ The following sets of tools are available:
877
881
878
882
-**list_issues** - List issues
879
883
-**Required OAuth Scopes**: `repo`
880
-
-`after`: Cursor for pagination. Use the endCursor from the previous page's PageInfo for GraphQL APIs. (string, optional)
884
+
-`after`: Cursor for pagination. Use the cursor from the previous response. (string, optional)
881
885
-`direction`: Order direction. If provided, the 'orderBy' also needs to be provided. (string, optional)
882
886
-`labels`: Filter by labels (string[], optional)
883
887
-`orderBy`: Order issues by field. If provided, the 'direction' also needs to be provided. (string, optional)
@@ -1028,22 +1032,26 @@ The following sets of tools are available:
1028
1032
-`project_number`: The project's number. Required for 'list_project_fields', 'list_project_items', and 'list_project_status_updates' methods. (number, optional)
1029
1033
-`query`: Filter/query string. For list_projects: filter by title text and state (e.g. "roadmap is:open"). For list_project_items: advanced filtering using GitHub's project filtering syntax. (string, optional)
1030
1034
1031
-
-**projects_write** - Modify GitHub Project items
1035
+
-**projects_write** - Manage GitHub Projects
1032
1036
-**Required OAuth Scopes**: `project`
1033
1037
-`body`: The body of the status update (markdown). Used for 'create_project_status_update' method. (string, optional)
1038
+
-`field_name`: The name of the iteration field (e.g. 'Sprint'). Required for 'create_iteration_field' method. (string, optional)
1034
1039
-`issue_number`: The issue number (use when item_type is 'issue' for 'add_project_item' method). Provide either issue_number or pull_request_number. (number, optional)
1035
1040
-`item_id`: The project item ID. Required for 'update_project_item' and 'delete_project_item' methods. (number, optional)
1036
1041
-`item_owner`: The owner (user or organization) of the repository containing the issue or pull request. Required for 'add_project_item' method. (string, optional)
1037
1042
-`item_repo`: The name of the repository containing the issue or pull request. Required for 'add_project_item' method. (string, optional)
1038
1043
-`item_type`: The item's type, either issue or pull_request. Required for 'add_project_item' method. (string, optional)
1044
+
-`iteration_duration`: Duration in days for iterations of the field (e.g. 7 for weekly, 14 for bi-weekly). Required for 'create_iteration_field' method. (number, optional)
1045
+
-`iterations`: Custom iterations for 'create_iteration_field' method. Only set this when you need iterations with varying durations, breaks between them, or specific titles. Otherwise omit it: GitHub auto-creates three iterations of 'iteration_duration' days starting on 'start_date', which is the right choice for most cases. (object[], optional)
1039
1046
-`method`: The method to execute (string, required)
1040
1047
-`owner`: The project owner (user or organization login). The name is not case sensitive. (string, required)
1041
-
-`owner_type`: Owner type (user or org). If not provided, will be automatically detected. (string, optional)
1042
-
-`project_number`: The project's number. (number, required)
1048
+
-`owner_type`: Owner type (user or org). Required for 'create_project' method. If not provided for other methods, will be automatically detected. (string, optional)
1049
+
-`project_number`: The project's number. Required for all methods except 'create_project'. (number, optional)
1043
1050
-`pull_request_number`: The pull request number (use when item_type is 'pull_request' for 'add_project_item' method). Provide either issue_number or pull_request_number. (number, optional)
1044
-
-`start_date`: The start date of the status update in YYYY-MM-DD format. Used for 'create_project_status_update' method. (string, optional)
1051
+
-`start_date`: Start date in YYYY-MM-DD format. Used for 'create_project_status_update' and 'create_iteration_field' methods. (string, optional)
1045
1052
-`status`: The status of the project. Used for 'create_project_status_update' method. (string, optional)
1046
1053
-`target_date`: The target date of the status update in YYYY-MM-DD format. Used for 'create_project_status_update' method. (string, optional)
1054
+
-`title`: The project title. Required for 'create_project' method. (string, optional)
1047
1055
-`updated_field`: Object consisting of the ID of the project field to update and the new value for the field. To clear the field, set value to null. Example: {"id": 123456, "value": "New Value"}. Required for 'update_project_item' method. (object, optional)
1048
1056
1049
1057
</details>
@@ -1114,10 +1122,11 @@ The following sets of tools are available:
1114
1122
2. get_diff - Get the diff of a pull request.
1115
1123
3. get_status - Get combined commit status of a head commit in a pull request.
1116
1124
4. get_files - Get the list of files changed in a pull request. Use with pagination parameters to control the number of results returned.
1117
-
5. get_review_comments - Get review threads on a pull request. Each thread contains logically grouped review comments made on the same code location during pull request reviews. Returns threads with metadata (isResolved, isOutdated, isCollapsed) and their associated comments. Use cursor-based pagination (perPage, after) to control results.
1118
-
6. get_reviews - Get the reviews on a pull request. When asked for review comments, use get_review_comments method. Use with pagination parameters to control the number of results returned.
1119
-
7. get_comments - Get comments on a pull request. Use this if user doesn't specifically want review comments. Use with pagination parameters to control the number of results returned.
1120
-
8. get_check_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 PR.
1125
+
5. get_commits - Get the list of commits on a pull request. Use with pagination parameters to control the number of results returned.
1126
+
6. get_review_comments - Get review threads on a pull request. Each thread contains logically grouped review comments made on the same code location during pull request reviews. Returns threads with metadata (isResolved, isOutdated, isCollapsed) and their associated comments. Use cursor-based pagination (perPage, after) to control results.
1127
+
7. get_reviews - Get the reviews on a pull request. When asked for review comments, use get_review_comments method. Use with pagination parameters to control the number of results returned.
1128
+
8. get_comments - Get comments on a pull request. Use this if user doesn't specifically want review comments. Use with pagination parameters to control the number of results returned.
1129
+
9. get_check_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 PR.
1121
1130
(string, required)
1122
1131
-`owner`: Repository owner (string, required)
1123
1132
-`page`: Page number for pagination (min 1) (number, optional)
@@ -1155,7 +1164,7 @@ The following sets of tools are available:
1155
1164
-`owner`: Repository owner (string, required)
1156
1165
-`pullNumber`: Pull request number to update (number, required)
1157
1166
-`repo`: Repository name (string, required)
1158
-
-`reviewers`: GitHub usernames to request reviews from (string[], optional)
1167
+
-`reviewers`: GitHub usernames or ORG/team-slug team reviewers to request reviews from (string[], optional)
1159
1168
-`state`: New state (string, optional)
1160
1169
-`title`: New title (string, optional)
1161
1170
@@ -1213,7 +1222,7 @@ The following sets of tools are available:
1213
1222
1214
1223
-**get_commit** - Get commit details
1215
1224
-**Required OAuth Scopes**: `repo`
1216
-
-`include_diff`: Whether to include file diffs and stats in the response. Default is true. (boolean, optional)
1225
+
-`detail`: Level of detail to include for changed files. "none" omits stats and files entirely. "stats" (default) includes per-file metadata: filename, status, and lines-of-code counts (additions, deletions, changes), with no patch content. "full_patch" additionally includes the unified diff content for each file and can be very large. (string, optional)
1217
1226
-`owner`: Repository owner (string, required)
1218
1227
-`page`: Page number for pagination (min 1) (number, optional)
1219
1228
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
0 commit comments