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
+10-1Lines changed: 10 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -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,6 +971,7 @@ 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)
@@ -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)
@@ -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)
- 'blocked_by' - the subject issue is blocked by the related issue.
339
339
- 'blocking' - the subject issue blocks the related issue. (string, required)
340
340
341
-
### `fields_param`
342
-
343
-
-**get_file_contents** - Get file or directory contents
344
-
-**Required OAuth Scopes**: `repo`
345
-
-`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)
346
-
-`owner`: Repository owner (username or organization) (string, required)
347
-
-`path`: Path to file/directory (string, optional)
348
-
-`ref`: Accepts optional git refs such as `refs/tags/{tag}`, `refs/heads/{branch}` or `refs/pull/{pr_number}/head` (string, optional)
349
-
-`repo`: Repository name (string, required)
350
-
-`sha`: Accepts optional commit SHA. If specified, it will be used instead of ref (string, optional)
351
-
352
-
-**list_commits** - List commits
353
-
-**Required OAuth Scopes**: `repo`
354
-
-`author`: Author username or email address to filter commits by (string, optional)
355
-
-`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)
356
-
-`owner`: Repository owner (string, required)
357
-
-`page`: Page number for pagination (min 1) (number, optional)
358
-
-`path`: Only commits containing this file path will be returned (string, optional)
359
-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
360
-
-`repo`: Repository name (string, required)
361
-
-`sha`: Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA. (string, optional)
362
-
-`since`: Only commits after this date will be returned (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DD) (string, optional)
363
-
-`until`: Only commits before this date will be returned (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DD) (string, optional)
364
-
365
-
-**list_issues** - List issues
366
-
-**Required OAuth Scopes**: `repo`
367
-
-`after`: Cursor for pagination. Use the cursor from the previous response. (string, optional)
368
-
-`direction`: Order direction. If provided, the 'orderBy' also needs to be provided. (string, optional)
369
-
-`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)
370
-
-`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)
371
-
-`labels`: Filter by labels (string[], optional)
372
-
-`orderBy`: Order issues by field. If provided, the 'direction' also needs to be provided. (string, optional)
373
-
-`owner`: Repository owner (string, required)
374
-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
375
-
-`repo`: Repository name (string, required)
376
-
-`since`: Filter by date (ISO 8601 timestamp) (string, optional)
377
-
-`state`: Filter by state, by default both open and closed issues are returned when not provided (string, optional)
378
-
379
-
-**list_pull_requests** - List pull requests
380
-
-**Required OAuth Scopes**: `repo`
381
-
-`base`: Filter by base branch (string, optional)
382
-
-`direction`: Sort direction (string, optional)
383
-
-`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)
384
-
-`head`: Filter by head user/org and branch (string, optional)
385
-
-`owner`: Repository owner (string, required)
386
-
-`page`: Page number for pagination (min 1) (number, optional)
387
-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
388
-
-`repo`: Repository name (string, required)
389
-
-`sort`: Sort by (string, optional)
390
-
-`state`: Filter by state (string, optional)
391
-
392
-
-**list_releases** - List releases
393
-
-**Required OAuth Scopes**: `repo`
394
-
-`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)
395
-
-`owner`: Repository owner (string, required)
396
-
-`page`: Page number for pagination (min 1) (number, optional)
397
-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
398
-
-`repo`: Repository name (string, required)
399
-
400
-
-**search_code** - Search code
401
-
-**Required OAuth Scopes**: `repo`
402
-
-`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)
403
-
-`order`: Sort order for results (string, optional)
404
-
-`page`: Page number for pagination (min 1) (number, optional)
405
-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
406
-
-`query`: Search query (GitHub code search REST). Implicit AND between terms; supports `OR`, `NOT`, and `"quoted phrase"` for exact match. Qualifiers: `repo:owner/repo`, `org:`, `user:`, `language:`, `path:dir` (prefix match), `filename:exact.ext`, `extension:`, `in:file`, `in:path`, `size:`, `is:archived`, `is:fork`. Max 256 chars. Examples: `WithContext language:go org:github`; `"package main" repo:o/r`; `func extension:go path:cmd repo:o/r`; `NOT TODO language:go repo:o/r`. (string, required)
407
-
-`sort`: Sort field ('indexed' only) (string, optional)
408
-
409
-
-**search_issues** - Search issues
410
-
-**Required OAuth Scopes**: `repo`
411
-
-`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)
412
-
-`order`: Sort order (string, optional)
413
-
-`owner`: Optional repository owner. If provided with repo, only issues for this repository are listed. (string, optional)
414
-
-`page`: Page number for pagination (min 1) (number, optional)
415
-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
416
-
-`query`: Search query using GitHub issues search syntax (string, required)
417
-
-`repo`: Optional repository name. If provided with owner, only issues for this repository are listed. (string, optional)
418
-
-`sort`: Sort field by number of matches of categories, defaults to best match (string, optional)
419
-
420
-
-**search_pull_requests** - Search pull requests
421
-
-**Required OAuth Scopes**: `repo`
422
-
-`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)
423
-
-`order`: Sort order (string, optional)
424
-
-`owner`: Optional repository owner. If provided with repo, only pull requests for this repository are listed. (string, optional)
425
-
-`page`: Page number for pagination (min 1) (number, optional)
426
-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
0 commit comments