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
echo "ℹ️ **Note:** This job exercises the streamable-http transport against a shared server, with per-config settings supplied via X-MCP-* request headers." >> $GITHUB_STEP_SUMMARY
Copy file name to clipboardExpand all lines: README.md
+20-12Lines changed: 20 additions & 12 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
@@ -822,14 +826,14 @@ The following sets of tools are available:
-**get_label** - Get a specific label from a repository.
926
+
-**get_label** - Get a specific label from a repository
923
927
-**Required OAuth Scopes**: `repo`
924
928
-`name`: Label name. (string, required)
925
929
-`owner`: Repository owner (username or organization name) (string, required)
926
930
-`repo`: Repository name (string, required)
927
931
928
-
-**label_write** - Write operations on repository labels.
932
+
-**label_write** - Write operations on repository labels
929
933
-**Required OAuth Scopes**: `repo`
930
934
-`color`: Label color as 6-character hex code without '#' prefix (e.g., 'f29513'). Required for 'create', optional for 'update'. (string, optional)
931
935
-`description`: Label description text. Optional for 'create' and 'update'. (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>
@@ -1125,7 +1133,7 @@ The following sets of tools are available:
1125
1133
-`pullNumber`: Pull request number (number, required)
-`commitID`: SHA of commit to review (string, optional)
@@ -1155,7 +1163,7 @@ The following sets of tools are available:
1155
1163
-`owner`: Repository owner (string, required)
1156
1164
-`pullNumber`: Pull request number to update (number, required)
1157
1165
-`repo`: Repository name (string, required)
1158
-
-`reviewers`: GitHub usernames to request reviews from (string[], optional)
1166
+
-`reviewers`: GitHub usernames or ORG/team-slug team reviewers to request reviews from (string[], optional)
1159
1167
-`state`: New state (string, optional)
1160
1168
-`title`: New title (string, optional)
1161
1169
@@ -1213,7 +1221,7 @@ The following sets of tools are available:
1213
1221
1214
1222
-**get_commit** - Get commit details
1215
1223
-**Required OAuth Scopes**: `repo`
1216
-
-`include_diff`: Whether to include file diffs and stats in the response. Default is true. (boolean, optional)
1224
+
-`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
1225
-`owner`: Repository owner (string, required)
1218
1226
-`page`: Page number for pagination (min 1) (number, optional)
1219
1227
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
0 commit comments