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
+33-20Lines changed: 33 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -140,7 +140,7 @@ When no toolsets are specified, [default toolsets](#default-toolset) are used.
140
140
</tr>
141
141
</table>
142
142
143
-
See [Remote Server Documentation](docs/remote-server.md#insiders-mode) for more details and examples.
143
+
See [Remote Server Documentation](docs/remote-server.md#insiders-mode) for more details and examples, and [Insiders Features](docs/insiders-features.md) for a full list of what's available.
144
144
145
145
#### GitHub Enterprise
146
146
@@ -153,7 +153,7 @@ Example for `https://octocorp.ghe.com` with GitHub PAT token:
@@ -560,6 +560,7 @@ The following sets of tools are available:
560
560
| <picture><sourcemedia="(prefers-color-scheme: dark)"srcset="pkg/octicons/icons/person-dark.png"><sourcemedia="(prefers-color-scheme: light)"srcset="pkg/octicons/icons/person-light.png"><imgsrc="pkg/octicons/icons/person-light.png"width="20"height="20"alt="person"></picture> |`context`|**Strongly recommended**: Tools that provide context about the current user and GitHub context you are operating in |
| <picture><sourcemedia="(prefers-color-scheme: dark)"srcset="pkg/octicons/icons/codescan-dark.png"><sourcemedia="(prefers-color-scheme: light)"srcset="pkg/octicons/icons/codescan-light.png"><imgsrc="pkg/octicons/icons/codescan-light.png"width="20"height="20"alt="codescan"></picture> |`code_security`| Code security related tools, such as GitHub Code Scanning |
563
+
| <picture><sourcemedia="(prefers-color-scheme: dark)"srcset="pkg/octicons/icons/copilot-dark.png"><sourcemedia="(prefers-color-scheme: light)"srcset="pkg/octicons/icons/copilot-light.png"><imgsrc="pkg/octicons/icons/copilot-light.png"width="20"height="20"alt="copilot"></picture> |`copilot`| Copilot related tools |
-**assign_copilot_to_issue** - Assign Copilot to issue
693
+
-**Required OAuth Scopes**: `repo`
694
+
-`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)
695
+
-`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)
@@ -794,14 +815,6 @@ The following sets of tools are available:
794
815
-`owner`: Repository owner (string, required)
795
816
-`repo`: Repository name (string, required)
796
817
797
-
-**assign_copilot_to_issue** - Assign Copilot to issue
798
-
-**Required OAuth Scopes**: `repo`
799
-
-`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)
800
-
-`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)
801
-
-`issue_number`: Issue number (number, required)
802
-
-`owner`: Repository owner (string, required)
803
-
-`repo`: Repository name (string, required)
804
-
805
818
-**get_label** - Get a specific label from a repository.
806
819
-**Required OAuth Scopes**: `repo`
807
820
-`name`: Label name. (string, required)
@@ -983,9 +996,10 @@ The following sets of tools are available:
983
996
-`fields`: Specific list of field IDs to include in the response when getting a project item (e.g. ["102589", "985201", "169875"]). If not provided, only the title field is included. Only used for 'get_project_item' method. (string[], optional)
984
997
-`item_id`: The item's ID. Required for 'get_project_item' method. (number, optional)
985
998
-`method`: The method to execute (string, required)
986
-
-`owner`: The owner (user or organization login). The name is not case sensitive. (string, required)
999
+
-`owner`: The owner (user or organization login). The name is not case sensitive. (string, optional)
987
1000
-`owner_type`: Owner type (user or org). If not provided, will be automatically detected. (string, optional)
988
-
-`project_number`: The project's number. (number, required)
1001
+
-`project_number`: The project's number. (number, optional)
1002
+
-`status_update_id`: The node ID of the project status update. Required for 'get_project_status_update' method. (string, optional)
989
1003
990
1004
-**projects_list** - List GitHub Projects resources
991
1005
-**Required OAuth Scopes**: `read:project`
@@ -997,11 +1011,12 @@ The following sets of tools are available:
997
1011
-`owner`: The owner (user or organization login). The name is not case sensitive. (string, required)
998
1012
-`owner_type`: Owner type (user or org). If not provided, will automatically try both. (string, optional)
999
1013
-`per_page`: Results per page (max 50) (number, optional)
1000
-
-`project_number`: The project's number. Required for 'list_project_fields'and 'list_project_items' methods. (number, optional)
1014
+
-`project_number`: The project's number. Required for 'list_project_fields', 'list_project_items', and 'list_project_status_updates' methods. (number, optional)
1001
1015
-`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)
1002
1016
1003
1017
-**projects_write** - Modify GitHub Project items
1004
1018
-**Required OAuth Scopes**: `project`
1019
+
-`body`: The body of the status update (markdown). Used for 'create_project_status_update' method. (string, optional)
1005
1020
-`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)
1006
1021
-`item_id`: The project item ID. Required for 'update_project_item' and 'delete_project_item' methods. (number, optional)
1007
1022
-`item_owner`: The owner (user or organization) of the repository containing the issue or pull request. Required for 'add_project_item' method. (string, optional)
@@ -1012,6 +1027,9 @@ The following sets of tools are available:
1012
1027
-`owner_type`: Owner type (user or org). If not provided, will be automatically detected. (string, optional)
1013
1028
-`project_number`: The project's number. (number, required)
1014
1029
-`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)
1030
+
-`start_date`: The start date of the status update in YYYY-MM-DD format. Used for 'create_project_status_update' method. (string, optional)
1031
+
-`status`: The status of the project. Used for 'create_project_status_update' method. (string, optional)
1032
+
-`target_date`: The target date of the status update in YYYY-MM-DD format. Used for 'create_project_status_update' method. (string, optional)
1015
1033
-`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)
1016
1034
1017
1035
</details>
@@ -1079,11 +1097,12 @@ The following sets of tools are available:
1079
1097
Possible options:
1080
1098
1. get - Get details of a specific pull request.
1081
1099
2. get_diff - Get the diff of a pull request.
1082
-
3. get_status - Get status of a head commit in a pull request. This reflects status of builds and checks.
1100
+
3. get_status - Get combined commit status of a head commit in a pull request.
1083
1101
4. get_files - Get the list of files changed in a pull request. Use with pagination parameters to control the number of results returned.
1084
1102
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.
1085
1103
6. get_reviews - Get the reviews on a pull request. When asked for review comments, use get_review_comments method.
1086
1104
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.
1105
+
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.
1087
1106
(string, required)
1088
1107
-`owner`: Repository owner (string, required)
1089
1108
-`page`: Page number for pagination (min 1) (number, optional)
@@ -1102,12 +1121,6 @@ The following sets of tools are available:
1102
1121
-`repo`: Repository name (string, required)
1103
1122
-`threadId`: The node ID of the review thread (e.g., PRRT_kwDOxxx). Required for resolve_thread and unresolve_thread methods. Get thread IDs from pull_request_read with method get_review_comments. (string, optional)
0 commit comments