-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Add the client-side subscriptions/listen driver #3047
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
maxisbey
wants to merge
7
commits into
listen-client-plumbing
Choose a base branch
from
listen-client-driver
base: listen-client-plumbing
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.
+2,036
−185
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
eb6a578
Add the client-side subscriptions/listen driver
maxisbey dcdd2b8
Keep the docs watch-loop snippet ASCII
maxisbey a3faba3
Harden the listen driver against receive-order races and hostile peers
maxisbey d7f83bc
Trim comments and docstrings in the listen driver changes
maxisbey 6573774
Point moved docs pages at the client driver section
maxisbey d971680
Move the docs watch-loop example into docs_src and prove it
maxisbey d7c16b1
Deep-link the migration guide and spell out the watcher test choreogr…
maxisbey 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
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
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
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,14 @@ | ||
| from mcp import Client | ||
| from mcp.client.subscriptions import ResourceUpdated | ||
|
|
||
| from .tutorial001 import mcp | ||
|
|
||
|
|
||
| async def watch_todo() -> str: | ||
| """Wait for the todo note to change once, then stop listening.""" | ||
| async with Client(mcp) as client: | ||
| async with client.listen(resource_subscriptions=["note://todo"]) as sub: | ||
| async for event in sub: | ||
| assert isinstance(event, ResourceUpdated) | ||
| return f"changed: {event.uri}" | ||
| return "the server closed the stream before any change" |
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,20 @@ | ||
| import anyio | ||
|
|
||
| from mcp import Client | ||
| from mcp.client.subscriptions import SubscriptionLost | ||
|
|
||
|
|
||
| async def watch(client: Client, uri: str) -> None: | ||
| """Keep one resource fresh for as long as the client lives.""" | ||
| while True: | ||
| try: | ||
| async with client.listen(resource_subscriptions=[uri]) as sub: | ||
| await client.read_resource(uri) # refetch: no replay across streams | ||
| async for _event in sub: | ||
| await client.read_resource(uri) | ||
| except SubscriptionLost: | ||
| pass | ||
| # Graceful close or abrupt drop, the stream is gone either way. Back | ||
| # off before re-listening - a graceful close may be the server | ||
| # shedding load, and reconnecting instantly recreates the pressure. | ||
| await anyio.sleep(1) |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P2: The client docs now give conflicting filter semantics: this line says a subscription may receive sub-resource URIs, while the same page says resource subscriptions match exact URI strings. Consider keeping the event description aligned with exact-match delivery so clients do not build watchers that expect broader notifications.
Prompt for AI agents