feat: client-side support for SEP-1577 sampling with tools (#1722)

tests/client/test_session.py

@@ -497,6 +497,8 @@ async def test_client_capabilities_with_custom_callbacks():
     # Custom sampling callback provided
     assert received_capabilities.sampling is not None
     assert isinstance(received_capabilities.sampling, types.SamplingCapability)
+    # Default sampling capabilities (no tools)
+    assert received_capabilities.sampling.tools is None
     # Custom list_roots callback provided
     assert received_capabilities.roots is not None
     assert isinstance(received_capabilities.roots, types.RootsCapability)
@@ -504,6 +506,84 @@ async def test_client_capabilities_with_custom_callbacks():
     assert received_capabilities.roots.listChanged is True
 
 
+@pytest.mark.anyio
+async def test_client_capabilities_with_sampling_tools():
+    """Test that sampling capabilities with tools are properly advertised"""
+    client_to_server_send, client_to_server_receive = anyio.create_memory_object_stream[SessionMessage](1)
+    server_to_client_send, server_to_client_receive = anyio.create_memory_object_stream[SessionMessage](1)
+
+    received_capabilities = None
+
+    async def custom_sampling_callback(  # pragma: no cover
+        context: RequestContext["ClientSession", Any],
+        params: types.CreateMessageRequestParams,
+    ) -> types.CreateMessageResult | types.ErrorData:
+        return types.CreateMessageResult(
+            role="assistant",
+            content=types.TextContent(type="text", text="test"),
+            model="test-model",
+        )
+
+    async def mock_server():
+        nonlocal received_capabilities
+
+        session_message = await client_to_server_receive.receive()
+        jsonrpc_request = session_message.message
+        assert isinstance(jsonrpc_request.root, JSONRPCRequest)
+        request = ClientRequest.model_validate(
+            jsonrpc_request.model_dump(by_alias=True, mode="json", exclude_none=True)
+        )
+        assert isinstance(request.root, InitializeRequest)
+        received_capabilities = request.root.params.capabilities
+
+        result = ServerResult(
+            InitializeResult(
+                protocolVersion=LATEST_PROTOCOL_VERSION,
+                capabilities=ServerCapabilities(),
+                serverInfo=Implementation(name="mock-server", version="0.1.0"),
+            )
+        )
+
+        async with server_to_client_send:
+            await server_to_client_send.send(
+                SessionMessage(
+                    JSONRPCMessage(
+                        JSONRPCResponse(
+                            jsonrpc="2.0",
+                            id=jsonrpc_request.root.id,
+                            result=result.model_dump(by_alias=True, mode="json", exclude_none=True),
+                        )
+                    )
+                )
+            )
+            # Receive initialized notification
+            await client_to_server_receive.receive()
+
+    async with (
+        ClientSession(
+            server_to_client_receive,
+            client_to_server_send,
+            sampling_callback=custom_sampling_callback,
+            sampling_capabilities=types.SamplingCapability(tools=types.SamplingToolsCapability()),
+        ) as session,
+        anyio.create_task_group() as tg,
+        client_to_server_send,
+        client_to_server_receive,
+        server_to_client_send,
+        server_to_client_receive,
+    ):
+        tg.start_soon(mock_server)
+        await session.initialize()
+
+    # Assert that sampling capabilities with tools are properly advertised
+    assert received_capabilities is not None
+    assert received_capabilities.sampling is not None
+    assert isinstance(received_capabilities.sampling, types.SamplingCapability)
+    # Tools capability should be present
+    assert received_capabilities.sampling.tools is not None
+    assert isinstance(received_capabilities.sampling.tools, types.SamplingToolsCapability)
+
+
 @pytest.mark.anyio
 async def test_get_server_capabilities():
     """Test that get_server_capabilities returns None before init and capabilities after"""