-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Add list_all_* helpers that drain pagination on the client #3021
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
CJGjr
wants to merge
6
commits into
modelcontextprotocol:main
Choose a base branch
from
CJGjr:list-all-pagination-v2
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
a7adecd
Add list_all_* helpers that drain pagination on the client
adityasingh2400 f0b43cb
Guard the drain loops against a non-advancing cursor
CJGjr 36ea094
Document the drain helpers in the pagination guide
CJGjr 36a8bdd
Extend the non-advancing cursor guard to ClientSessionGroup drains
CJGjr 6e250ac
Fix the session-groups cross-reference in the pagination guide
CJGjr 2b78338
Harden the drain guard against cycling pagination cursors
CJGjr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| from typing import Any | ||
|
|
||
| from mcp_types import ListResourcesResult, PaginatedRequestParams, Resource | ||
|
|
||
| from mcp import Client | ||
| from mcp.server import Server, ServerRequestContext | ||
|
|
||
| BOOKS = [f"book-{n}" for n in range(1, 101)] | ||
|
|
||
| PAGE_SIZE = 10 | ||
|
|
||
|
|
||
| async def list_books(ctx: ServerRequestContext[Any], params: PaginatedRequestParams | None) -> ListResourcesResult: | ||
| start = 0 if params is None or params.cursor is None else int(params.cursor) | ||
| end = start + PAGE_SIZE | ||
| page = [Resource(uri=f"books://catalog/{name}", name=name) for name in BOOKS[start:end]] | ||
| next_cursor = str(end) if end < len(BOOKS) else None | ||
| return ListResourcesResult(resources=page, next_cursor=next_cursor) | ||
|
|
||
|
|
||
| server = Server("Bookshop", on_list_resources=list_books) | ||
|
|
||
|
|
||
| async def main() -> None: | ||
| async with Client(server) as client: | ||
| # Every page, stitched into one list. | ||
| resources = await client.list_all_resources() | ||
| print(f"{len(resources)} resources") | ||
|
|
||
| # Or stream them, and stop as soon as you have what you need. | ||
| async for resource in client.iter_all_resources(): | ||
| print(f"first: {resource.name}") | ||
| break |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.