- 
                Notifications
    You must be signed in to change notification settings 
- Fork 2.7k
feat: add message to ProgressNotification #435
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
          
     Merged
      
      
            ihrpr
  merged 13 commits into
  modelcontextprotocol:main
from
aksheyd:feat-progress-message
  
      
      
   
  May 13, 2025 
      
    
  
     Merged
                    Changes from 4 commits
      Commits
    
    
            Show all changes
          
          
            13 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      71a9418
              
                add message type
              
              
                aksheyd 80ad862
              
                more type and test case updates
              
              
                aksheyd d8373c4
              
                Merge branch 'main' into feat-progress-message
              
              
                aksheyd 51adce8
              
                Merge branch 'main' into feat-progress-message
              
              
                aksheyd aa92533
              
                remove message from context manager
              
              
                aksheyd 380e2c3
              
                set default for message in progress() method
              
              
                aksheyd 115a9bf
              
                remove message from context
              
              
                aksheyd fcdad58
              
                use progress() method's message param not context
              
              
                aksheyd c9e32ae
              
                Merge branch 'main' into feat-progress-message
              
              
                aksheyd 198f96a
              
                resolve pyright failure
              
              
                aksheyd 97d3902
              
                test progress context manager
              
              
                aksheyd e4a7108
              
                remove unnecessary sleeps
              
              
                aksheyd 0bde946
              
                Merge branch 'main' into feat-progress-message
              
              
                aksheyd 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
    
  
  
    
              
  
    
      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,214 @@ | ||
| import anyio | ||
| import pytest | ||
|  | ||
| import mcp.types as types | ||
| from mcp.client.session import ClientSession | ||
| from mcp.server import Server | ||
| from mcp.server.lowlevel import NotificationOptions | ||
| from mcp.server.models import InitializationOptions | ||
| from mcp.server.session import ServerSession | ||
| from mcp.shared.session import RequestResponder | ||
| from mcp.types import ( | ||
| JSONRPCMessage, | ||
| ) | ||
|  | ||
|  | ||
| @pytest.mark.anyio | ||
| async def test_bidirectional_progress_notifications(): | ||
| """Test that both client and server can send progress notifications.""" | ||
| # Create memory streams for client/server | ||
| server_to_client_send, server_to_client_receive = anyio.create_memory_object_stream[ | ||
| JSONRPCMessage | ||
| ](5) | ||
| client_to_server_send, client_to_server_receive = anyio.create_memory_object_stream[ | ||
| JSONRPCMessage | ||
| ](5) | ||
|  | ||
| # Run a server session so we can send progress updates in tool | ||
| async def run_server(): | ||
| # Create a server session | ||
| async with ServerSession( | ||
| client_to_server_receive, | ||
| server_to_client_send, | ||
| InitializationOptions( | ||
| server_name="ProgressTestServer", | ||
| server_version="0.1.0", | ||
| capabilities=server.get_capabilities(NotificationOptions(), {}), | ||
| ), | ||
| ) as server_session: | ||
| global serv_sesh | ||
|  | ||
| serv_sesh = server_session | ||
| async for message in server_session.incoming_messages: | ||
| try: | ||
| await server._handle_message(message, server_session, ()) | ||
| except Exception as e: | ||
| raise e | ||
|  | ||
| # Track progress updates | ||
| server_progress_updates = [] | ||
| client_progress_updates = [] | ||
|  | ||
| # Progress tokens | ||
| server_progress_token = "server_token_123" | ||
| client_progress_token = "client_token_456" | ||
|  | ||
| # Create a server with progress capability | ||
| server = Server(name="ProgressTestServer") | ||
|  | ||
| # Register progress handler | ||
| @server.progress_notification() | ||
| async def handle_progress( | ||
| progress_token: str | int, | ||
| progress: float, | ||
| total: float | None, | ||
| message: str | None, | ||
| ): | ||
| server_progress_updates.append( | ||
| { | ||
| "token": progress_token, | ||
| "progress": progress, | ||
| "total": total, | ||
| "message": message, | ||
| } | ||
| ) | ||
|  | ||
| # Register list tool handler | ||
| @server.list_tools() | ||
| async def handle_list_tools() -> list[types.Tool]: | ||
| return [ | ||
| types.Tool( | ||
| name="test_tool", | ||
| description="A tool that sends progress notifications <o/", | ||
| inputSchema={}, | ||
| ) | ||
| ] | ||
|  | ||
| # Register tool handler | ||
| @server.call_tool() | ||
| async def handle_call_tool(name: str, arguments: dict | None) -> list: | ||
| # Make sure we received a progress token | ||
| if name == "test_tool": | ||
| if arguments and "_meta" in arguments: | ||
| progressToken = arguments["_meta"]["progressToken"] | ||
|  | ||
| if not progressToken: | ||
| raise ValueError("Empty progress token received") | ||
|  | ||
| if progressToken != client_progress_token: | ||
| raise ValueError("Server sending back incorrect progressToken") | ||
|  | ||
| # Send progress notifications | ||
| await serv_sesh.send_progress_notification( | ||
| progress_token=progressToken, | ||
| progress=0.25, | ||
| total=1.0, | ||
| message="Server progress 25%", | ||
| ) | ||
| await anyio.sleep(0.2) | ||
|         
                  aksheyd marked this conversation as resolved.
              Outdated
          
            Show resolved
            Hide resolved | ||
|  | ||
| await serv_sesh.send_progress_notification( | ||
| progress_token=progressToken, | ||
| progress=0.5, | ||
| total=1.0, | ||
| message="Server progress 50%", | ||
| ) | ||
| await anyio.sleep(0.2) | ||
|  | ||
| await serv_sesh.send_progress_notification( | ||
| progress_token=progressToken, | ||
| progress=1.0, | ||
| total=1.0, | ||
| message="Server progress 100%", | ||
| ) | ||
|  | ||
| else: | ||
| raise ValueError("Progress token not sent.") | ||
|  | ||
| return ["Tool executed successfully"] | ||
|  | ||
| raise ValueError(f"Unknown tool: {name}") | ||
|  | ||
| # Client message handler to store progress notifications | ||
| async def handle_client_message( | ||
| message: RequestResponder[types.ServerRequest, types.ClientResult] | ||
| | types.ServerNotification | ||
| | Exception, | ||
| ) -> None: | ||
| if isinstance(message, Exception): | ||
| raise message | ||
|  | ||
| if isinstance(message, types.ServerNotification): | ||
| if isinstance(message.root, types.ProgressNotification): | ||
| params = message.root.params | ||
| client_progress_updates.append( | ||
| { | ||
| "token": params.progressToken, | ||
| "progress": params.progress, | ||
| "total": params.total, | ||
| "message": params.message, | ||
| } | ||
| ) | ||
|  | ||
| # Test using client | ||
| async with ( | ||
| ClientSession( | ||
| server_to_client_receive, | ||
| client_to_server_send, | ||
| message_handler=handle_client_message, | ||
| ) as client_session, | ||
| anyio.create_task_group() as tg, | ||
| ): | ||
| # Start the server in a background task | ||
| tg.start_soon(run_server) | ||
|  | ||
| # Initialize the client connection | ||
| await client_session.initialize() | ||
|  | ||
| # Call list_tools with progress token | ||
| await client_session.list_tools() | ||
|  | ||
| # Call test_tool with progress token | ||
| await client_session.call_tool( | ||
| "test_tool", {"_meta": {"progressToken": client_progress_token}} | ||
| ) | ||
|  | ||
| # Send progress notifications from client to server | ||
| await client_session.send_progress_notification( | ||
| progress_token=server_progress_token, | ||
| progress=0.33, | ||
| total=1.0, | ||
| message="Client progress 33%", | ||
| ) | ||
|  | ||
| await client_session.send_progress_notification( | ||
| progress_token=server_progress_token, | ||
| progress=0.66, | ||
| total=1.0, | ||
| message="Client progress 66%", | ||
| ) | ||
|  | ||
| await client_session.send_progress_notification( | ||
| progress_token=server_progress_token, | ||
| progress=1.0, | ||
| total=1.0, | ||
| message="Client progress 100%", | ||
| ) | ||
|  | ||
| # Wait and exit | ||
| await anyio.sleep(1.0) | ||
| tg.cancel_scope.cancel() | ||
|  | ||
| # Verify client received progress updates from server | ||
| assert len(client_progress_updates) == 3 | ||
| assert client_progress_updates[0]["token"] == client_progress_token | ||
| assert client_progress_updates[0]["progress"] == 0.25 | ||
| assert client_progress_updates[0]["message"] == "Server progress 25%" | ||
| assert client_progress_updates[2]["progress"] == 1.0 | ||
|  | ||
| # Verify server received progress updates from client | ||
| assert len(server_progress_updates) == 3 | ||
| assert server_progress_updates[0]["token"] == server_progress_token | ||
| assert server_progress_updates[0]["progress"] == 0.33 | ||
| assert server_progress_updates[0]["message"] == "Client progress 33%" | ||
| assert server_progress_updates[2]["progress"] == 1.0 | ||
      
      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.