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
+15-6Lines changed: 15 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -911,7 +911,7 @@ The following sets of tools are available:
911
911
-`issue_number`: The number of the issue (number, required)
912
912
-`method`: The read operation to perform on a single issue.
913
913
Options are:
914
-
1. get - Get issue details. Also returns best-effort hierarchy flags (`has_parent`, `has_children`); `parent` and `sub_issues_summary` are optional relationship summaries.
914
+
1. get - Get issue details. Also returns best-effort hierarchy flags (`has_parent`, `has_children`); `parent` and `sub_issues_summary` are optional relationship summaries, and `closed_by_pull_requests` summarizes the pull requests configured to close the issue as `total_count` plus up to 5 `references`.
915
915
2. get_comments - Get issue comments.
916
916
3. get_sub_issues - Get sub-issues (children) of the issue.
917
917
4. get_parent - Get the parent issue, if this issue is a sub-issue of another.
@@ -926,7 +926,7 @@ The following sets of tools are available:
926
926
-**Required OAuth Scopes**: `repo`
927
927
-`assignees`: Usernames to assign to this issue (string[], optional)
928
928
-`body`: Issue body content (string, optional)
929
-
-`duplicate_of`: Issue number that this issue is a duplicate of. Only used when state_reason is 'duplicate'. (number, optional)
929
+
-`duplicate_of`: Issue number that this issue is a duplicate of. Required when state_reason is 'duplicate'. (number, optional)
930
930
-`issue_fields`: Issue field values to set or clear. Each item requires 'field_name' and exactly one of 'value', 'field_option_name', or 'delete: true'. (object[], optional)
931
931
-`issue_number`: Issue number to update (number, optional)
932
932
-`labels`: Labels to apply to this issue (string[], optional)
@@ -941,7 +941,7 @@ The following sets of tools are available:
941
941
-`state`: New state (string, optional)
942
942
-`state_reason`: Reason for the state change. Ignored unless state is changed. (string, optional)
943
943
-`title`: Issue title (string, optional)
944
-
-`type`: Type of this issue. Only use if issue types are enabled for this repository. Use list_issue_types tool to get valid type values for this repository or its owner organization. If the repository doesn't support issue types, omit this parameter. (string, optional)
944
+
-`type`: Type of this issue. For updates, pass null to remove the current type. Only use if issue types are enabled for this repository. Use list_issue_types to get valid type values for this repository or its owner organization. If the repository doesn't support issue types, omit this parameter. (string | null, optional)
@@ -960,6 +960,7 @@ The following sets of tools are available:
960
960
-`after`: Cursor for pagination. Use the cursor from the previous response. (string, optional)
961
961
-`direction`: Order direction. If provided, the 'orderBy' also needs to be provided. (string, optional)
962
962
-`field_filters`: Filter by custom issue field values. Each entry takes a field_name and a value; the server looks up the field and coerces the value to its type (single-select option name, text, number, or YYYY-MM-DD date). (object[], optional)
963
+
-`fields`: Subset of fields to return for each issue. If omitted, all fields are returned. Use this to reduce response size when you only need specific fields; omitting 'body' and 'field_values' in particular drops the largest per-result data. (string[], optional)
963
964
-`labels`: Filter by labels (string[], optional)
964
965
-`orderBy`: Order issues by field. If provided, the 'direction' also needs to be provided. (string, optional)
965
966
-`owner`: Repository owner (string, required)
@@ -970,11 +971,12 @@ The following sets of tools are available:
970
971
971
972
-**search_issues** - Search issues
972
973
-**Required OAuth Scopes**: `repo`
974
+
-`fields`: Subset of fields to return for each issue result. If omitted, all fields are returned. Use this to reduce response size when you only need specific fields; omitting 'body', 'reactions', and 'labels' in particular drops the largest per-result data. (string[], optional)
973
975
-`order`: Sort order (string, optional)
974
976
-`owner`: Optional repository owner. If provided with repo, only issues for this repository are listed. (string, optional)
975
977
-`page`: Page number for pagination (min 1) (number, optional)
976
978
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
977
-
-`query`: Search query using GitHub issues search syntax (string, required)
979
+
-`query`: The search query, as natural language. When the user gives alternative wordings, include them as plain words rather than joining them with OR. (string, required)
978
980
-`repo`: Optional repository name. If provided with owner, only issues for this repository are listed. (string, optional)
979
981
-`sort`: Sort field by number of matches of categories, defaults to best match (string, optional)
980
982
@@ -1121,6 +1123,7 @@ The following sets of tools are available:
1121
1123
-`item_owner`: The owner (user or organization) of the repository containing the issue or pull request. Required for 'add_project_item' method. Also accepted by 'update_project_item' when resolving the item by issue number. (string, optional)
1122
1124
-`item_repo`: The name of the repository containing the issue or pull request. Required for 'add_project_item' method. Also accepted by 'update_project_item' when resolving the item by issue number. (string, optional)
1123
1125
-`item_type`: The item's type, either issue or pull_request. Required for 'add_project_item' method. (string, optional)
1126
+
-`items`: The items to update with the top-level 'updated_field'. Required for 'update_project_items'; prefer it over calling 'update_project_item' in a loop. Each entry must match exactly one reference variant: 'node_id', numeric 'item_id', or 'item_owner' + 'item_repo' + 'issue_number'. Limit: 50 items per call. (object[], optional)
1124
1127
-`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)
1125
1128
-`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)
1126
1129
-`method`: The method to execute (string, required)
@@ -1132,7 +1135,7 @@ The following sets of tools are available:
1132
1135
-`status`: The status of the project. Used for 'create_project_status_update' method. (string, optional)
1133
1136
-`target_date`: The target date of the status update in YYYY-MM-DD format. Used for 'create_project_status_update' method. (string, optional)
1134
1137
-`title`: The project title. Required for 'create_project' method. (string, optional)
1135
-
-`updated_field`: Object describing the field to update and its new value. Required for 'update_project_item'. Two shapes are accepted: (1) by ID — {"id": 123456, "value": "..."}; (2) by name — {"name": "Status", "value": "In Progress"}. For single-select fields, option-name resolution requires the by-name shape; on the by-ID shape, pass the option ID. Set value to null to clear the field. (object, optional)
1138
+
-`updated_field`: The field/value to apply, using {"id": 123, "value": ...} or {"name": "Status", "value": ...}; null clears the field. Required for 'update_project_item' and 'update_project_items', where one top-level field/value applies to every item in a batch. For 'update_project_item' SINGLE_SELECT fields, the name form accepts option names; the ID form expects an option ID. (object, optional)
1136
1139
1137
1140
</details>
1138
1141
@@ -1178,6 +1181,7 @@ The following sets of tools are available:
1178
1181
-**Required OAuth Scopes**: `repo`
1179
1182
-`base`: Filter by base branch (string, optional)
1180
1183
-`direction`: Sort direction (string, optional)
1184
+
-`fields`: Subset of fields to return for each pull request. If omitted, all fields are returned. Use this to reduce response size when you only need specific fields; omitting 'body' in particular drops the largest per-result data. (string[], optional)
1181
1185
-`head`: Filter by head user/org and branch (string, optional)
1182
1186
-`owner`: Repository owner (string, required)
1183
1187
-`page`: Page number for pagination (min 1) (number, optional)
@@ -1229,6 +1233,7 @@ The following sets of tools are available:
1229
1233
1230
1234
-**search_pull_requests** - Search pull requests
1231
1235
-**Required OAuth Scopes**: `repo`
1236
+
-`fields`: Subset of fields to return for each pull request result. If omitted, all fields are returned. Use this to reduce response size when you only need specific fields; omitting 'body', 'reactions', and 'labels' in particular drops the largest per-result data. (string[], optional)
1232
1237
-`order`: Sort order (string, optional)
1233
1238
-`owner`: Optional repository owner. If provided with repo, only pull requests for this repository are listed. (string, optional)
1234
1239
-`page`: Page number for pagination (min 1) (number, optional)
@@ -1273,7 +1278,7 @@ The following sets of tools are available:
1273
1278
-**create_or_update_file** - Create or update file
1274
1279
-**Required OAuth Scopes**: `repo`
1275
1280
-`branch`: Branch to create/update the file in (string, required)
1276
-
-`content`: Content of the file (string, required)
1281
+
-`content`: Content of the file, exactly as it should appear once written. Do not base64-encode it; this server does that before calling the REST API. (string, required)
1277
1282
-`message`: Commit message (string, required)
1278
1283
-`owner`: Repository owner (username or organization) (string, required)
1279
1284
-`path`: Path where to create/update the file (string, required)
@@ -1313,6 +1318,7 @@ The following sets of tools are available:
1313
1318
1314
1319
-**get_file_contents** - Get file or directory contents
1315
1320
-**Required OAuth Scopes**: `repo`
1321
+
-`fields`: Subset of fields to return for each entry when the path is a directory. If omitted, all fields are returned. Ignored when the path is a single file. Use this to reduce response size when listing directories and you only need specific fields, e.g. just 'name' and 'type'. (string[], optional)
1316
1322
-`owner`: Repository owner (username or organization) (string, required)
1317
1323
-`path`: Path to file/directory (string, optional)
1318
1324
-`ref`: Accepts optional git refs such as `refs/tags/{tag}`, `refs/heads/{branch}` or `refs/pull/{pr_number}/head` (string, optional)
@@ -1346,6 +1352,7 @@ The following sets of tools are available:
1346
1352
-**list_commits** - List commits
1347
1353
-**Required OAuth Scopes**: `repo`
1348
1354
-`author`: Author username or email address to filter commits by (string, optional)
1355
+
-`fields`: Subset of fields to return for each commit. If omitted, all fields are returned. Use this to reduce response size when you only need specific fields, e.g. just 'sha' and 'html_url'. (string[], optional)
1349
1356
-`owner`: Repository owner (string, required)
1350
1357
-`page`: Page number for pagination (min 1) (number, optional)
1351
1358
-`path`: Only commits containing this file path will be returned (string, optional)
@@ -1357,6 +1364,7 @@ The following sets of tools are available:
1357
1364
1358
1365
-**list_releases** - List releases
1359
1366
-**Required OAuth Scopes**: `repo`
1367
+
-`fields`: Subset of fields to return for each release. If omitted, all fields are returned. Use this to reduce response size when you only need specific fields; omitting 'body' in particular drops the largest per-release data. (string[], optional)
1360
1368
-`owner`: Repository owner (string, required)
1361
1369
-`page`: Page number for pagination (min 1) (number, optional)
1362
1370
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
@@ -1387,6 +1395,7 @@ The following sets of tools are available:
1387
1395
1388
1396
-**search_code** - Search code
1389
1397
-**Required OAuth Scopes**: `repo`
1398
+
-`fields`: Subset of fields to return for each code search result. If omitted, all fields are returned. Use this to reduce response size when you only need specific fields; omitting 'repository' and 'text_matches' in particular drops the largest per-result data. (string[], optional)
1390
1399
-`order`: Sort order for results (string, optional)
1391
1400
-`page`: Page number for pagination (min 1) (number, optional)
1392
1401
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
0 commit comments