Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit20c8a40

Browse files
Update documentation for cursor-based pagination
1 parent72ff44f commit20c8a40

File tree

1 file changed

+21
-42
lines changed

1 file changed

+21
-42
lines changed

‎README.md‎

Lines changed: 21 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -468,35 +468,31 @@ The following sets of tools are available:
468468
-`run_id`: The unique identifier of the workflow run (number, required)
469469

470470
-**list_workflow_jobs** - List workflow jobs
471+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
471472
-`filter`: Filters jobs by their completed_at timestamp (string, optional)
472473
-`owner`: Repository owner (string, required)
473-
-`page`: Page number for pagination (min 1) (number, optional)
474-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
475474
-`repo`: Repository name (string, required)
476475
-`run_id`: The unique identifier of the workflow run (number, required)
477476

478477
-**list_workflow_run_artifacts** - List workflow artifacts
478+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
479479
-`owner`: Repository owner (string, required)
480-
-`page`: Page number for pagination (min 1) (number, optional)
481-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
482480
-`repo`: Repository name (string, required)
483481
-`run_id`: The unique identifier of the workflow run (number, required)
484482

485483
-**list_workflow_runs** - List workflow runs
486484
-`actor`: Returns someone's workflow runs. Use the login for the user who created the workflow run. (string, optional)
487485
-`branch`: Returns workflow runs associated with a branch. Use the name of the branch. (string, optional)
486+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
488487
-`event`: Returns workflow runs for a specific event type (string, optional)
489488
-`owner`: Repository owner (string, required)
490-
-`page`: Page number for pagination (min 1) (number, optional)
491-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
492489
-`repo`: Repository name (string, required)
493490
-`status`: Returns workflow runs with the check run status (string, optional)
494491
-`workflow_id`: The workflow ID or workflow file name (string, required)
495492

496493
-**list_workflows** - List workflows
494+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
497495
-`owner`: Repository owner (string, required)
498-
-`page`: Page number for pagination (min 1) (number, optional)
499-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
500496
-`repo`: Repository name (string, required)
501497

502498
-**rerun_failed_jobs** - Rerun failed jobs
@@ -615,8 +611,7 @@ The following sets of tools are available:
615611
-`gist_id`: The ID of the gist (string, required)
616612

617613
-**list_gists** - List Gists
618-
-`page`: Page number for pagination (min 1) (number, optional)
619-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
614+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
620615
-`since`: Only gists updated after this time (ISO 8601 timestamp) (string, optional)
621616
-`username`: GitHub username (omit for authenticated user's gists) (string, optional)
622617

@@ -649,6 +644,7 @@ The following sets of tools are available:
649644
-`repo`: Repository name (string, required)
650645

651646
-**issue_read** - Get issue details
647+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
652648
-`issue_number`: The number of the issue (number, required)
653649
-`method`: The read operation to perform on a single issue.
654650
Options are:
@@ -658,8 +654,6 @@ Options are:
658654
4. get_labels - Get labels assigned to the issue.
659655
(string, required)
660656
-`owner`: The owner of the repository (string, required)
661-
-`page`: Page number for pagination (min 1) (number, optional)
662-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
663657
-`repo`: The name of the repository (string, required)
664658

665659
-**issue_write** - Create or update issue.
@@ -696,10 +690,9 @@ Options are:
696690
-`state`: Filter by state, by default both open and closed issues are returned when not provided (string, optional)
697691

698692
-**search_issues** - Search issues
693+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
699694
-`order`: Sort order (string, optional)
700695
-`owner`: Optional repository owner. If provided with repo, only issues for this repository are listed. (string, optional)
701-
-`page`: Page number for pagination (min 1) (number, optional)
702-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
703696
-`query`: Search query using GitHub issues search syntax (string, required)
704697
-`repo`: Optional repository name. If provided with owner, only issues for this repository are listed. (string, optional)
705698
-`sort`: Sort field by number of matches of categories, defaults to best match (string, optional)
@@ -758,10 +751,9 @@ Options are:
758751

759752
-**list_notifications** - List notifications
760753
-`before`: Only show notifications updated before the given time (ISO 8601 format) (string, optional)
754+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
761755
-`filter`: Filter notifications to, use default unless specified. Read notifications are ones that have already been acknowledged by the user. Participating notifications are those that the user is directly involved in, such as issues or pull requests they have commented on or created. (string, optional)
762756
-`owner`: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional)
763-
-`page`: Page number for pagination (min 1) (number, optional)
764-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
765757
-`repo`: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional)
766758
-`since`: Only show notifications updated after the given time (ISO 8601 format) (string, optional)
767759

@@ -786,9 +778,8 @@ Options are:
786778
<summary>Organizations</summary>
787779

788780
-**search_orgs** - Search organizations
781+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
789782
-`order`: Sort order (string, optional)
790-
-`page`: Page number for pagination (min 1) (number, optional)
791-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
792783
-`query`: Organization search query. Examples: 'microsoft', 'location:california', 'created:>=2025-01-01'. Search is automatically scoped to type:org. (string, required)
793784
-`sort`: Sort field by category (string, optional)
794785

@@ -886,11 +877,10 @@ Options are:
886877

887878
-**list_pull_requests** - List pull requests
888879
-`base`: Filter by base branch (string, optional)
880+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
889881
-`direction`: Sort direction (string, optional)
890882
-`head`: Filter by head user/org and branch (string, optional)
891883
-`owner`: Repository owner (string, required)
892-
-`page`: Page number for pagination (min 1) (number, optional)
893-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
894884
-`repo`: Repository name (string, required)
895885
-`sort`: Sort by (string, optional)
896886
-`state`: Filter by state (string, optional)
@@ -904,6 +894,7 @@ Options are:
904894
-`repo`: Repository name (string, required)
905895

906896
-**pull_request_read** - Get details for a single pull request
897+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
907898
-`method`: Action to specify what pull request data needs to be retrieved from GitHub.
908899
Possible options:
909900
1. get - Get details of a specific pull request.
@@ -915,8 +906,6 @@ Possible options:
915906
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.
916907
(string, required)
917908
-`owner`: Repository owner (string, required)
918-
-`page`: Page number for pagination (min 1) (number, optional)
919-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
920909
-`pullNumber`: Pull request number (number, required)
921910
-`repo`: Repository name (string, required)
922911

@@ -935,10 +924,9 @@ Possible options:
935924
-`repo`: Repository name (string, required)
936925

937926
-**search_pull_requests** - Search pull requests
927+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
938928
-`order`: Sort order (string, optional)
939929
-`owner`: Optional repository owner. If provided with repo, only pull requests for this repository are listed. (string, optional)
940-
-`page`: Page number for pagination (min 1) (number, optional)
941-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
942930
-`query`: Search query using GitHub pull request search syntax (string, required)
943931
-`repo`: Optional repository name. If provided with owner, only pull requests for this repository are listed. (string, optional)
944932
-`sort`: Sort field by number of matches of categories, defaults to best match (string, optional)
@@ -1002,10 +990,9 @@ Possible options:
1002990
-`repo`: Repository name (string, required)
1003991

1004992
-**get_commit** - Get commit details
993+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
1005994
-`include_diff`: Whether to include file diffs and stats in the response. Default is true. (boolean, optional)
1006995
-`owner`: Repository owner (string, required)
1007-
-`page`: Page number for pagination (min 1) (number, optional)
1008-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
1009996
-`repo`: Repository name (string, required)
1010997
-`sha`: Commit SHA, branch name, or tag name (string, required)
1011998

@@ -1031,29 +1018,25 @@ Possible options:
10311018
-`tag`: Tag name (string, required)
10321019

10331020
-**list_branches** - List branches
1021+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
10341022
-`owner`: Repository owner (string, required)
1035-
-`page`: Page number for pagination (min 1) (number, optional)
1036-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
10371023
-`repo`: Repository name (string, required)
10381024

10391025
-**list_commits** - List commits
10401026
-`author`: Author username or email address to filter commits by (string, optional)
1027+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
10411028
-`owner`: Repository owner (string, required)
1042-
-`page`: Page number for pagination (min 1) (number, optional)
1043-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
10441029
-`repo`: Repository name (string, required)
10451030
-`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)
10461031

10471032
-**list_releases** - List releases
1033+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
10481034
-`owner`: Repository owner (string, required)
1049-
-`page`: Page number for pagination (min 1) (number, optional)
1050-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
10511035
-`repo`: Repository name (string, required)
10521036

10531037
-**list_tags** - List tags
1038+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
10541039
-`owner`: Repository owner (string, required)
1055-
-`page`: Page number for pagination (min 1) (number, optional)
1056-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
10571040
-`repo`: Repository name (string, required)
10581041

10591042
-**push_files** - Push files to repository
@@ -1064,17 +1047,15 @@ Possible options:
10641047
-`repo`: Repository name (string, required)
10651048

10661049
-**search_code** - Search code
1050+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
10671051
-`order`: Sort order for results (string, optional)
1068-
-`page`: Page number for pagination (min 1) (number, optional)
1069-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
10701052
-`query`: Search query using GitHub's powerful code search syntax. Examples: 'content:Skill language:Java org:github', 'NOT is:archived language:Python OR language:go', 'repo:github/github-mcp-server'. Supports exact matching, language filters, path filters, and more. (string, required)
10711053
-`sort`: Sort field ('indexed' only) (string, optional)
10721054

10731055
-**search_repositories** - Search repositories
1056+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
10741057
-`minimal_output`: Return minimal repository information (default: true). When false, returns full GitHub API repository objects. (boolean, optional)
10751058
-`order`: Sort order (string, optional)
1076-
-`page`: Page number for pagination (min 1) (number, optional)
1077-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
10781059
-`query`: Repository search query. Examples: 'machine learning in:name stars:>1000 language:python', 'topic:react', 'user:facebook'. Supports advanced search syntax for precise filtering. (string, required)
10791060
-`sort`: Sort repositories by field, defaults to best match (string, optional)
10801061

@@ -1138,9 +1119,8 @@ Possible options:
11381119
<summary>Stargazers</summary>
11391120

11401121
-**list_starred_repositories** - List starred repositories
1122+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
11411123
-`direction`: The direction to sort the results by. (string, optional)
1142-
-`page`: Page number for pagination (min 1) (number, optional)
1143-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
11441124
-`sort`: How to sort the results. Can be either 'created' (when the repository was starred) or 'updated' (when the repository was last pushed to). (string, optional)
11451125
-`username`: Username to list starred repositories for. Defaults to the authenticated user. (string, optional)
11461126

@@ -1159,9 +1139,8 @@ Possible options:
11591139
<summary>Users</summary>
11601140

11611141
-**search_users** - Search users
1142+
-`cursor`: Cursor for pagination. Use the cursor value from the previous response's pagination metadata to retrieve the next page. Leave blank for the first page. (string, optional)
11621143
-`order`: Sort order (string, optional)
1163-
-`page`: Page number for pagination (min 1) (number, optional)
1164-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
11651144
-`query`: User search query. Examples: 'john smith', 'location:seattle', 'followers:>100'. Search is automatically scoped to type:user. (string, required)
11661145
-`sort`: Sort users by number of followers or repositories, or when the person joined GitHub. (string, optional)
11671146

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp