Add streamable_http_client which accepts httpx.AsyncClient instead of httpx_client_factory (#1177)
Co-authored-by: Felix Weinberger <fweinberger@anthropic.com>
This commit is contained in:
parent
cc8382ce3e
commit
a3a4b8d11a
5 changed files with 488 additions and 221 deletions
|
|
@ -12,7 +12,7 @@ from collections.abc import Generator
|
|||
import pytest
|
||||
|
||||
from mcp.client.session import ClientSession
|
||||
from mcp.client.streamable_http import streamablehttp_client
|
||||
from mcp.client.streamable_http import streamable_http_client
|
||||
from tests.test_helpers import wait_for_server
|
||||
|
||||
# Test constants with various Unicode characters
|
||||
|
|
@ -178,7 +178,7 @@ async def test_streamable_http_client_unicode_tool_call(running_unicode_server:
|
|||
base_url = running_unicode_server
|
||||
endpoint_url = f"{base_url}/mcp"
|
||||
|
||||
async with streamablehttp_client(endpoint_url) as (read_stream, write_stream, _get_session_id):
|
||||
async with streamable_http_client(endpoint_url) as (read_stream, write_stream, _get_session_id):
|
||||
async with ClientSession(read_stream, write_stream) as session:
|
||||
await session.initialize()
|
||||
|
||||
|
|
@ -210,7 +210,7 @@ async def test_streamable_http_client_unicode_prompts(running_unicode_server: st
|
|||
base_url = running_unicode_server
|
||||
endpoint_url = f"{base_url}/mcp"
|
||||
|
||||
async with streamablehttp_client(endpoint_url) as (read_stream, write_stream, _get_session_id):
|
||||
async with streamable_http_client(endpoint_url) as (read_stream, write_stream, _get_session_id):
|
||||
async with ClientSession(read_stream, write_stream) as session:
|
||||
await session.initialize()
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ from starlette.responses import JSONResponse, Response
|
|||
from starlette.routing import Route
|
||||
|
||||
from mcp import ClientSession, types
|
||||
from mcp.client.streamable_http import streamablehttp_client
|
||||
from mcp.client.streamable_http import streamable_http_client
|
||||
from mcp.shared.session import RequestResponder
|
||||
from mcp.types import ClientNotification, RootsListChangedNotification
|
||||
from tests.test_helpers import wait_for_server
|
||||
|
|
@ -127,7 +127,7 @@ async def test_non_compliant_notification_response(non_sdk_server: None, non_sdk
|
|||
if isinstance(message, Exception):
|
||||
returned_exception = message
|
||||
|
||||
async with streamablehttp_client(server_url) as (read_stream, write_stream, _):
|
||||
async with streamable_http_client(server_url) as (read_stream, write_stream, _):
|
||||
async with ClientSession(
|
||||
read_stream,
|
||||
write_stream,
|
||||
|
|
|
|||
|
|
@ -280,7 +280,7 @@ class TestClientSessionGroup:
|
|||
(
|
||||
StreamableHttpParameters(url="http://test.com/stream", terminate_on_close=False),
|
||||
"streamablehttp",
|
||||
"mcp.client.session_group.streamablehttp_client",
|
||||
"mcp.client.session_group.streamable_http_client",
|
||||
), # url, headers, timeout, sse_read_timeout, terminate_on_close
|
||||
],
|
||||
)
|
||||
|
|
@ -296,7 +296,7 @@ class TestClientSessionGroup:
|
|||
mock_read_stream = mock.AsyncMock(name=f"{client_type_name}Read")
|
||||
mock_write_stream = mock.AsyncMock(name=f"{client_type_name}Write")
|
||||
|
||||
# streamablehttp_client's __aenter__ returns three values
|
||||
# streamable_http_client's __aenter__ returns three values
|
||||
if client_type_name == "streamablehttp":
|
||||
mock_extra_stream_val = mock.AsyncMock(name="StreamableExtra")
|
||||
mock_client_cm_instance.__aenter__.return_value = (
|
||||
|
|
@ -354,13 +354,14 @@ class TestClientSessionGroup:
|
|||
)
|
||||
elif client_type_name == "streamablehttp": # pragma: no branch
|
||||
assert isinstance(server_params_instance, StreamableHttpParameters)
|
||||
mock_specific_client_func.assert_called_once_with(
|
||||
url=server_params_instance.url,
|
||||
headers=server_params_instance.headers,
|
||||
timeout=server_params_instance.timeout,
|
||||
sse_read_timeout=server_params_instance.sse_read_timeout,
|
||||
terminate_on_close=server_params_instance.terminate_on_close,
|
||||
)
|
||||
# Verify streamable_http_client was called with url, httpx_client, and terminate_on_close
|
||||
# The http_client is created by the real create_mcp_http_client
|
||||
import httpx
|
||||
|
||||
call_args = mock_specific_client_func.call_args
|
||||
assert call_args.kwargs["url"] == server_params_instance.url
|
||||
assert call_args.kwargs["terminate_on_close"] == server_params_instance.terminate_on_close
|
||||
assert isinstance(call_args.kwargs["http_client"], httpx.AsyncClient)
|
||||
|
||||
mock_client_cm_instance.__aenter__.assert_awaited_once()
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ from examples.snippets.servers import (
|
|||
)
|
||||
from mcp.client.session import ClientSession
|
||||
from mcp.client.sse import sse_client
|
||||
from mcp.client.streamable_http import GetSessionIdCallback, streamablehttp_client
|
||||
from mcp.client.streamable_http import GetSessionIdCallback, streamable_http_client
|
||||
from mcp.shared.context import RequestContext
|
||||
from mcp.shared.message import SessionMessage
|
||||
from mcp.shared.session import RequestResponder
|
||||
|
|
@ -179,7 +179,7 @@ def create_client_for_transport(transport: str, server_url: str):
|
|||
return sse_client(endpoint)
|
||||
elif transport == "streamable-http":
|
||||
endpoint = f"{server_url}/mcp"
|
||||
return streamablehttp_client(endpoint)
|
||||
return streamable_http_client(endpoint)
|
||||
else: # pragma: no cover
|
||||
raise ValueError(f"Invalid transport: {transport}")
|
||||
|
||||
|
|
|
|||
|
|
@ -9,6 +9,7 @@ import multiprocessing
|
|||
import socket
|
||||
import time
|
||||
from collections.abc import Generator
|
||||
from datetime import timedelta
|
||||
from typing import Any
|
||||
from unittest.mock import MagicMock
|
||||
|
||||
|
|
@ -25,7 +26,11 @@ from starlette.routing import Mount
|
|||
|
||||
import mcp.types as types
|
||||
from mcp.client.session import ClientSession
|
||||
from mcp.client.streamable_http import StreamableHTTPTransport, streamablehttp_client
|
||||
from mcp.client.streamable_http import (
|
||||
StreamableHTTPTransport,
|
||||
streamable_http_client,
|
||||
streamablehttp_client, # pyright: ignore[reportDeprecated]
|
||||
)
|
||||
from mcp.server import Server
|
||||
from mcp.server.streamable_http import (
|
||||
MCP_PROTOCOL_VERSION_HEADER,
|
||||
|
|
@ -40,6 +45,7 @@ from mcp.server.streamable_http import (
|
|||
)
|
||||
from mcp.server.streamable_http_manager import StreamableHTTPSessionManager
|
||||
from mcp.server.transport_security import TransportSecuritySettings
|
||||
from mcp.shared._httpx_utils import create_mcp_http_client
|
||||
from mcp.shared.context import RequestContext
|
||||
from mcp.shared.exceptions import McpError
|
||||
from mcp.shared.message import ClientMessageMetadata, ServerMessageMetadata, SessionMessage
|
||||
|
|
@ -972,7 +978,7 @@ async def http_client(basic_server: None, basic_server_url: str): # pragma: no
|
|||
@pytest.fixture
|
||||
async def initialized_client_session(basic_server: None, basic_server_url: str):
|
||||
"""Create initialized StreamableHTTP client session."""
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -986,9 +992,9 @@ async def initialized_client_session(basic_server: None, basic_server_url: str):
|
|||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_client_basic_connection(basic_server: None, basic_server_url: str):
|
||||
async def test_streamable_http_client_basic_connection(basic_server: None, basic_server_url: str):
|
||||
"""Test basic client connection with initialization."""
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -1004,7 +1010,7 @@ async def test_streamablehttp_client_basic_connection(basic_server: None, basic_
|
|||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_client_resource_read(initialized_client_session: ClientSession):
|
||||
async def test_streamable_http_client_resource_read(initialized_client_session: ClientSession):
|
||||
"""Test client resource read functionality."""
|
||||
response = await initialized_client_session.read_resource(uri=AnyUrl("foobar://test-resource"))
|
||||
assert len(response.contents) == 1
|
||||
|
|
@ -1014,7 +1020,7 @@ async def test_streamablehttp_client_resource_read(initialized_client_session: C
|
|||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_client_tool_invocation(initialized_client_session: ClientSession):
|
||||
async def test_streamable_http_client_tool_invocation(initialized_client_session: ClientSession):
|
||||
"""Test client tool invocation."""
|
||||
# First list tools
|
||||
tools = await initialized_client_session.list_tools()
|
||||
|
|
@ -1029,7 +1035,7 @@ async def test_streamablehttp_client_tool_invocation(initialized_client_session:
|
|||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_client_error_handling(initialized_client_session: ClientSession):
|
||||
async def test_streamable_http_client_error_handling(initialized_client_session: ClientSession):
|
||||
"""Test error handling in client."""
|
||||
with pytest.raises(McpError) as exc_info:
|
||||
await initialized_client_session.read_resource(uri=AnyUrl("unknown://test-error"))
|
||||
|
|
@ -1038,9 +1044,9 @@ async def test_streamablehttp_client_error_handling(initialized_client_session:
|
|||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_client_session_persistence(basic_server: None, basic_server_url: str):
|
||||
async def test_streamable_http_client_session_persistence(basic_server: None, basic_server_url: str):
|
||||
"""Test that session ID persists across requests."""
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -1066,9 +1072,9 @@ async def test_streamablehttp_client_session_persistence(basic_server: None, bas
|
|||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_client_json_response(json_response_server: None, json_server_url: str):
|
||||
async def test_streamable_http_client_json_response(json_response_server: None, json_server_url: str):
|
||||
"""Test client with JSON response mode."""
|
||||
async with streamablehttp_client(f"{json_server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{json_server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -1094,7 +1100,7 @@ async def test_streamablehttp_client_json_response(json_response_server: None, j
|
|||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_client_get_stream(basic_server: None, basic_server_url: str):
|
||||
async def test_streamable_http_client_get_stream(basic_server: None, basic_server_url: str):
|
||||
"""Test GET stream functionality for server-initiated messages."""
|
||||
import mcp.types as types
|
||||
|
||||
|
|
@ -1107,7 +1113,7 @@ async def test_streamablehttp_client_get_stream(basic_server: None, basic_server
|
|||
if isinstance(message, types.ServerNotification): # pragma: no branch
|
||||
notifications_received.append(message)
|
||||
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -1134,13 +1140,13 @@ async def test_streamablehttp_client_get_stream(basic_server: None, basic_server
|
|||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_client_session_termination(basic_server: None, basic_server_url: str):
|
||||
async def test_streamable_http_client_session_termination(basic_server: None, basic_server_url: str):
|
||||
"""Test client session termination functionality."""
|
||||
|
||||
captured_session_id = None
|
||||
|
||||
# Create the streamablehttp_client with a custom httpx client to capture headers
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp") as (
|
||||
# Create the streamable_http_client with a custom httpx client to capture headers
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
get_session_id,
|
||||
|
|
@ -1160,22 +1166,23 @@ async def test_streamablehttp_client_session_termination(basic_server: None, bas
|
|||
if captured_session_id: # pragma: no cover
|
||||
headers[MCP_SESSION_ID_HEADER] = captured_session_id
|
||||
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp", headers=headers) as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
):
|
||||
async with ClientSession(read_stream, write_stream) as session:
|
||||
# Attempt to make a request after termination
|
||||
with pytest.raises( # pragma: no branch
|
||||
McpError,
|
||||
match="Session terminated",
|
||||
):
|
||||
await session.list_tools()
|
||||
async with create_mcp_http_client(headers=headers) as httpx_client:
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp", http_client=httpx_client) as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
):
|
||||
async with ClientSession(read_stream, write_stream) as session: # pragma: no branch
|
||||
# Attempt to make a request after termination
|
||||
with pytest.raises( # pragma: no branch
|
||||
McpError,
|
||||
match="Session terminated",
|
||||
):
|
||||
await session.list_tools()
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_client_session_termination_204(
|
||||
async def test_streamable_http_client_session_termination_204(
|
||||
basic_server: None, basic_server_url: str, monkeypatch: pytest.MonkeyPatch
|
||||
):
|
||||
"""Test client session termination functionality with a 204 response.
|
||||
|
|
@ -1205,8 +1212,8 @@ async def test_streamablehttp_client_session_termination_204(
|
|||
|
||||
captured_session_id = None
|
||||
|
||||
# Create the streamablehttp_client with a custom httpx client to capture headers
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp") as (
|
||||
# Create the streamable_http_client with a custom httpx client to capture headers
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
get_session_id,
|
||||
|
|
@ -1226,22 +1233,23 @@ async def test_streamablehttp_client_session_termination_204(
|
|||
if captured_session_id: # pragma: no cover
|
||||
headers[MCP_SESSION_ID_HEADER] = captured_session_id
|
||||
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp", headers=headers) as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
):
|
||||
async with ClientSession(read_stream, write_stream) as session:
|
||||
# Attempt to make a request after termination
|
||||
with pytest.raises( # pragma: no branch
|
||||
McpError,
|
||||
match="Session terminated",
|
||||
):
|
||||
await session.list_tools()
|
||||
async with create_mcp_http_client(headers=headers) as httpx_client:
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp", http_client=httpx_client) as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
):
|
||||
async with ClientSession(read_stream, write_stream) as session: # pragma: no branch
|
||||
# Attempt to make a request after termination
|
||||
with pytest.raises( # pragma: no branch
|
||||
McpError,
|
||||
match="Session terminated",
|
||||
):
|
||||
await session.list_tools()
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_client_resumption(event_server: tuple[SimpleEventStore, str]):
|
||||
async def test_streamable_http_client_resumption(event_server: tuple[SimpleEventStore, str]):
|
||||
"""Test client session resumption using sync primitives for reliable coordination."""
|
||||
_, server_url = event_server
|
||||
|
||||
|
|
@ -1268,7 +1276,7 @@ async def test_streamablehttp_client_resumption(event_server: tuple[SimpleEventS
|
|||
captured_resumption_token = token
|
||||
|
||||
# First, start the client session and begin the tool that waits on lock
|
||||
async with streamablehttp_client(f"{server_url}/mcp", terminate_on_close=False) as (
|
||||
async with streamable_http_client(f"{server_url}/mcp", terminate_on_close=False) as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
get_session_id,
|
||||
|
|
@ -1324,42 +1332,44 @@ async def test_streamablehttp_client_resumption(event_server: tuple[SimpleEventS
|
|||
headers[MCP_SESSION_ID_HEADER] = captured_session_id
|
||||
if captured_protocol_version: # pragma: no cover
|
||||
headers[MCP_PROTOCOL_VERSION_HEADER] = captured_protocol_version
|
||||
async with streamablehttp_client(f"{server_url}/mcp", headers=headers) as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
):
|
||||
async with ClientSession(read_stream, write_stream, message_handler=message_handler) as session:
|
||||
result = await session.send_request(
|
||||
types.ClientRequest(
|
||||
types.CallToolRequest(
|
||||
params=types.CallToolRequestParams(name="release_lock", arguments={}),
|
||||
)
|
||||
),
|
||||
types.CallToolResult,
|
||||
)
|
||||
metadata = ClientMessageMetadata(
|
||||
resumption_token=captured_resumption_token,
|
||||
)
|
||||
|
||||
result = await session.send_request(
|
||||
types.ClientRequest(
|
||||
types.CallToolRequest(
|
||||
params=types.CallToolRequestParams(name="wait_for_lock_with_notification", arguments={}),
|
||||
)
|
||||
),
|
||||
types.CallToolResult,
|
||||
metadata=metadata,
|
||||
)
|
||||
assert len(result.content) == 1
|
||||
assert result.content[0].type == "text"
|
||||
assert result.content[0].text == "Completed"
|
||||
async with create_mcp_http_client(headers=headers) as httpx_client:
|
||||
async with streamable_http_client(f"{server_url}/mcp", http_client=httpx_client) as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
):
|
||||
async with ClientSession(read_stream, write_stream, message_handler=message_handler) as session:
|
||||
result = await session.send_request(
|
||||
types.ClientRequest(
|
||||
types.CallToolRequest(
|
||||
params=types.CallToolRequestParams(name="release_lock", arguments={}),
|
||||
)
|
||||
),
|
||||
types.CallToolResult,
|
||||
)
|
||||
metadata = ClientMessageMetadata(
|
||||
resumption_token=captured_resumption_token,
|
||||
)
|
||||
|
||||
# We should have received the remaining notifications
|
||||
assert len(captured_notifications) == 1
|
||||
result = await session.send_request(
|
||||
types.ClientRequest(
|
||||
types.CallToolRequest(
|
||||
params=types.CallToolRequestParams(name="wait_for_lock_with_notification", arguments={}),
|
||||
)
|
||||
),
|
||||
types.CallToolResult,
|
||||
metadata=metadata,
|
||||
)
|
||||
assert len(result.content) == 1
|
||||
assert result.content[0].type == "text"
|
||||
assert result.content[0].text == "Completed"
|
||||
|
||||
assert isinstance(captured_notifications[0].root, types.LoggingMessageNotification)
|
||||
assert captured_notifications[0].root.params.data == "Second notification after lock"
|
||||
# We should have received the remaining notifications
|
||||
assert len(captured_notifications) == 1
|
||||
|
||||
assert isinstance(captured_notifications[0].root, types.LoggingMessageNotification) # pragma: no cover
|
||||
assert captured_notifications[0].root.params.data == "Second notification after lock" # pragma: no cover
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
|
|
@ -1391,7 +1401,7 @@ async def test_streamablehttp_server_sampling(basic_server: None, basic_server_u
|
|||
)
|
||||
|
||||
# Create client with sampling callback
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -1536,28 +1546,29 @@ async def test_streamablehttp_request_context_propagation(context_aware_server:
|
|||
"X-Trace-Id": "trace-123",
|
||||
}
|
||||
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp", headers=custom_headers) as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
):
|
||||
async with ClientSession(read_stream, write_stream) as session:
|
||||
result = await session.initialize()
|
||||
assert isinstance(result, InitializeResult)
|
||||
assert result.serverInfo.name == "ContextAwareServer"
|
||||
async with create_mcp_http_client(headers=custom_headers) as httpx_client:
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp", http_client=httpx_client) as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
):
|
||||
async with ClientSession(read_stream, write_stream) as session: # pragma: no branch
|
||||
result = await session.initialize()
|
||||
assert isinstance(result, InitializeResult)
|
||||
assert result.serverInfo.name == "ContextAwareServer"
|
||||
|
||||
# Call the tool that echoes headers back
|
||||
tool_result = await session.call_tool("echo_headers", {})
|
||||
# Call the tool that echoes headers back
|
||||
tool_result = await session.call_tool("echo_headers", {})
|
||||
|
||||
# Parse the JSON response
|
||||
assert len(tool_result.content) == 1
|
||||
assert isinstance(tool_result.content[0], TextContent)
|
||||
headers_data = json.loads(tool_result.content[0].text)
|
||||
# Parse the JSON response
|
||||
assert len(tool_result.content) == 1
|
||||
assert isinstance(tool_result.content[0], TextContent)
|
||||
headers_data = json.loads(tool_result.content[0].text)
|
||||
|
||||
# Verify headers were propagated
|
||||
assert headers_data.get("authorization") == "Bearer test-token"
|
||||
assert headers_data.get("x-custom-header") == "test-value"
|
||||
assert headers_data.get("x-trace-id") == "trace-123"
|
||||
# Verify headers were propagated
|
||||
assert headers_data.get("authorization") == "Bearer test-token"
|
||||
assert headers_data.get("x-custom-header") == "test-value"
|
||||
assert headers_data.get("x-trace-id") == "trace-123"
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
|
|
@ -1573,17 +1584,22 @@ async def test_streamablehttp_request_context_isolation(context_aware_server: No
|
|||
"Authorization": f"Bearer token-{i}",
|
||||
}
|
||||
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp", headers=headers) as (read_stream, write_stream, _):
|
||||
async with ClientSession(read_stream, write_stream) as session:
|
||||
await session.initialize()
|
||||
async with create_mcp_http_client(headers=headers) as httpx_client:
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp", http_client=httpx_client) as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
):
|
||||
async with ClientSession(read_stream, write_stream) as session: # pragma: no branch
|
||||
await session.initialize()
|
||||
|
||||
# Call the tool that echoes context
|
||||
tool_result = await session.call_tool("echo_context", {"request_id": f"request-{i}"})
|
||||
# Call the tool that echoes context
|
||||
tool_result = await session.call_tool("echo_context", {"request_id": f"request-{i}"})
|
||||
|
||||
assert len(tool_result.content) == 1
|
||||
assert isinstance(tool_result.content[0], TextContent)
|
||||
context_data = json.loads(tool_result.content[0].text)
|
||||
contexts.append(context_data)
|
||||
assert len(tool_result.content) == 1
|
||||
assert isinstance(tool_result.content[0], TextContent)
|
||||
context_data = json.loads(tool_result.content[0].text)
|
||||
contexts.append(context_data)
|
||||
|
||||
# Verify each request had its own context
|
||||
assert len(contexts) == 3 # pragma: no cover
|
||||
|
|
@ -1597,7 +1613,7 @@ async def test_streamablehttp_request_context_isolation(context_aware_server: No
|
|||
@pytest.mark.anyio
|
||||
async def test_client_includes_protocol_version_header_after_init(context_aware_server: None, basic_server_url: str):
|
||||
"""Test that client includes mcp-protocol-version header after initialization."""
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -1713,7 +1729,7 @@ async def test_client_crash_handled(basic_server: None, basic_server_url: str):
|
|||
# Simulate bad client that crashes after init
|
||||
async def bad_client():
|
||||
"""Client that triggers ClosedResourceError"""
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -1731,7 +1747,7 @@ async def test_client_crash_handled(basic_server: None, basic_server_url: str):
|
|||
await anyio.sleep(0.1)
|
||||
|
||||
# Try a good client, it should still be able to connect and list tools
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -1880,7 +1896,7 @@ async def test_close_sse_stream_callback_not_provided_for_old_protocol_version()
|
|||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_client_receives_priming_event(
|
||||
async def test_streamable_http_client_receives_priming_event(
|
||||
event_server: tuple[SimpleEventStore, str],
|
||||
) -> None:
|
||||
"""Client should receive priming event (resumption token update) on POST SSE stream."""
|
||||
|
|
@ -1891,7 +1907,7 @@ async def test_streamablehttp_client_receives_priming_event(
|
|||
async def on_resumption_token_update(token: str) -> None:
|
||||
captured_resumption_tokens.append(token)
|
||||
|
||||
async with streamablehttp_client(f"{server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -1932,7 +1948,7 @@ async def test_server_close_sse_stream_via_context(
|
|||
"""Server tool can call ctx.close_sse_stream() to close connection."""
|
||||
_, server_url = event_server
|
||||
|
||||
async with streamablehttp_client(f"{server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -1953,7 +1969,7 @@ async def test_server_close_sse_stream_via_context(
|
|||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_client_auto_reconnects(
|
||||
async def test_streamable_http_client_auto_reconnects(
|
||||
event_server: tuple[SimpleEventStore, str],
|
||||
) -> None:
|
||||
"""Client should auto-reconnect with Last-Event-ID when server closes after priming event."""
|
||||
|
|
@ -1969,7 +1985,7 @@ async def test_streamablehttp_client_auto_reconnects(
|
|||
if isinstance(message.root, types.LoggingMessageNotification): # pragma: no branch
|
||||
captured_notifications.append(str(message.root.params.data))
|
||||
|
||||
async with streamablehttp_client(f"{server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -1998,13 +2014,13 @@ async def test_streamablehttp_client_auto_reconnects(
|
|||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_client_respects_retry_interval(
|
||||
async def test_streamable_http_client_respects_retry_interval(
|
||||
event_server: tuple[SimpleEventStore, str],
|
||||
) -> None:
|
||||
"""Client MUST respect retry field, waiting specified ms before reconnecting."""
|
||||
_, server_url = event_server
|
||||
|
||||
async with streamablehttp_client(f"{server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -2029,7 +2045,7 @@ async def test_streamablehttp_client_respects_retry_interval(
|
|||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_sse_polling_full_cycle(
|
||||
async def test_streamable_http_sse_polling_full_cycle(
|
||||
event_server: tuple[SimpleEventStore, str],
|
||||
) -> None:
|
||||
"""End-to-end test: server closes stream, client reconnects, receives all events."""
|
||||
|
|
@ -2045,7 +2061,7 @@ async def test_streamablehttp_sse_polling_full_cycle(
|
|||
if isinstance(message.root, types.LoggingMessageNotification): # pragma: no branch
|
||||
all_notifications.append(str(message.root.params.data))
|
||||
|
||||
async with streamablehttp_client(f"{server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -2077,7 +2093,7 @@ async def test_streamablehttp_sse_polling_full_cycle(
|
|||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_events_replayed_after_disconnect(
|
||||
async def test_streamable_http_events_replayed_after_disconnect(
|
||||
event_server: tuple[SimpleEventStore, str],
|
||||
) -> None:
|
||||
"""Events sent while client is disconnected should be replayed on reconnect."""
|
||||
|
|
@ -2093,7 +2109,7 @@ async def test_streamablehttp_events_replayed_after_disconnect(
|
|||
if isinstance(message.root, types.LoggingMessageNotification): # pragma: no branch
|
||||
notification_data.append(str(message.root.params.data))
|
||||
|
||||
async with streamablehttp_client(f"{server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -2125,7 +2141,7 @@ async def test_streamablehttp_events_replayed_after_disconnect(
|
|||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_multiple_reconnections(
|
||||
async def test_streamable_http_multiple_reconnections(
|
||||
event_server: tuple[SimpleEventStore, str],
|
||||
):
|
||||
"""Verify multiple close_sse_stream() calls each trigger a client reconnect.
|
||||
|
|
@ -2145,7 +2161,7 @@ async def test_streamablehttp_multiple_reconnections(
|
|||
async def on_resumption_token(token: str) -> None:
|
||||
resumption_tokens.append(token)
|
||||
|
||||
async with streamablehttp_client(f"{server_url}/mcp") as (read_stream, write_stream, _):
|
||||
async with streamable_http_client(f"{server_url}/mcp") as (read_stream, write_stream, _):
|
||||
async with ClientSession(read_stream, write_stream) as session:
|
||||
await session.initialize()
|
||||
|
||||
|
|
@ -2205,7 +2221,7 @@ async def test_standalone_get_stream_reconnection(
|
|||
if isinstance(message.root, types.ResourceUpdatedNotification): # pragma: no branch
|
||||
received_notifications.append(str(message.root.params.uri))
|
||||
|
||||
async with streamablehttp_client(f"{server_url}/mcp") as (
|
||||
async with streamable_http_client(f"{server_url}/mcp") as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
|
|
@ -2236,3 +2252,145 @@ async def test_standalone_get_stream_reconnection(
|
|||
assert "http://notification_2/" in received_notifications, (
|
||||
f"Should receive notification 2 after reconnect, got: {received_notifications}"
|
||||
)
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamable_http_client_does_not_mutate_provided_client(
|
||||
basic_server: None, basic_server_url: str
|
||||
) -> None:
|
||||
"""Test that streamable_http_client does not mutate the provided httpx client's headers."""
|
||||
# Create a client with custom headers
|
||||
original_headers = {
|
||||
"X-Custom-Header": "custom-value",
|
||||
"Authorization": "Bearer test-token",
|
||||
}
|
||||
|
||||
async with httpx.AsyncClient(headers=original_headers, follow_redirects=True) as custom_client:
|
||||
# Use the client with streamable_http_client
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp", http_client=custom_client) as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
):
|
||||
async with ClientSession(read_stream, write_stream) as session:
|
||||
result = await session.initialize()
|
||||
assert isinstance(result, InitializeResult)
|
||||
|
||||
# Verify client headers were not mutated with MCP protocol headers
|
||||
# If accept header exists, it should still be httpx default, not MCP's
|
||||
if "accept" in custom_client.headers: # pragma: no branch
|
||||
assert custom_client.headers.get("accept") == "*/*"
|
||||
# MCP content-type should not have been added
|
||||
assert custom_client.headers.get("content-type") != "application/json"
|
||||
|
||||
# Verify custom headers are still present and unchanged
|
||||
assert custom_client.headers.get("X-Custom-Header") == "custom-value"
|
||||
assert custom_client.headers.get("Authorization") == "Bearer test-token"
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamable_http_client_mcp_headers_override_defaults(
|
||||
context_aware_server: None, basic_server_url: str
|
||||
) -> None:
|
||||
"""Test that MCP protocol headers override httpx.AsyncClient default headers."""
|
||||
# httpx.AsyncClient has default "accept: */*" header
|
||||
# We need to verify that our MCP accept header overrides it in actual requests
|
||||
|
||||
async with httpx.AsyncClient(follow_redirects=True) as client:
|
||||
# Verify client has default accept header
|
||||
assert client.headers.get("accept") == "*/*"
|
||||
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp", http_client=client) as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
):
|
||||
async with ClientSession(read_stream, write_stream) as session: # pragma: no branch
|
||||
await session.initialize()
|
||||
|
||||
# Use echo_headers tool to see what headers the server actually received
|
||||
tool_result = await session.call_tool("echo_headers", {})
|
||||
assert len(tool_result.content) == 1
|
||||
assert isinstance(tool_result.content[0], TextContent)
|
||||
headers_data = json.loads(tool_result.content[0].text)
|
||||
|
||||
# Verify MCP protocol headers were sent (not httpx defaults)
|
||||
assert "accept" in headers_data
|
||||
assert "application/json" in headers_data["accept"]
|
||||
assert "text/event-stream" in headers_data["accept"]
|
||||
|
||||
assert "content-type" in headers_data
|
||||
assert headers_data["content-type"] == "application/json"
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamable_http_client_preserves_custom_with_mcp_headers(
|
||||
context_aware_server: None, basic_server_url: str
|
||||
) -> None:
|
||||
"""Test that both custom headers and MCP protocol headers are sent in requests."""
|
||||
custom_headers = {
|
||||
"X-Custom-Header": "custom-value",
|
||||
"X-Request-Id": "req-123",
|
||||
"Authorization": "Bearer test-token",
|
||||
}
|
||||
|
||||
async with httpx.AsyncClient(headers=custom_headers, follow_redirects=True) as client:
|
||||
async with streamable_http_client(f"{basic_server_url}/mcp", http_client=client) as (
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
):
|
||||
async with ClientSession(read_stream, write_stream) as session: # pragma: no branch
|
||||
await session.initialize()
|
||||
|
||||
# Use echo_headers tool to verify both custom and MCP headers are present
|
||||
tool_result = await session.call_tool("echo_headers", {})
|
||||
assert len(tool_result.content) == 1
|
||||
assert isinstance(tool_result.content[0], TextContent)
|
||||
headers_data = json.loads(tool_result.content[0].text)
|
||||
|
||||
# Verify custom headers are present
|
||||
assert headers_data.get("x-custom-header") == "custom-value"
|
||||
assert headers_data.get("x-request-id") == "req-123"
|
||||
assert headers_data.get("authorization") == "Bearer test-token"
|
||||
|
||||
# Verify MCP protocol headers are also present
|
||||
assert "accept" in headers_data
|
||||
assert "application/json" in headers_data["accept"]
|
||||
assert "text/event-stream" in headers_data["accept"]
|
||||
|
||||
assert "content-type" in headers_data
|
||||
assert headers_data["content-type"] == "application/json"
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamable_http_transport_deprecated_params_ignored(basic_server: None, basic_server_url: str) -> None:
|
||||
"""Test that deprecated parameters passed to StreamableHTTPTransport are properly ignored."""
|
||||
with pytest.warns(DeprecationWarning):
|
||||
transport = StreamableHTTPTransport( # pyright: ignore[reportDeprecated]
|
||||
url=f"{basic_server_url}/mcp",
|
||||
headers={"X-Should-Be-Ignored": "ignored"},
|
||||
timeout=999,
|
||||
sse_read_timeout=timedelta(seconds=999),
|
||||
auth=None,
|
||||
)
|
||||
|
||||
headers = transport._prepare_headers()
|
||||
assert "X-Should-Be-Ignored" not in headers
|
||||
assert headers["accept"] == "application/json, text/event-stream"
|
||||
assert headers["content-type"] == "application/json"
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_streamablehttp_client_deprecation_warning(basic_server: None, basic_server_url: str) -> None:
|
||||
"""Test that the old streamablehttp_client() function issues a deprecation warning."""
|
||||
with pytest.warns(DeprecationWarning, match="Use `streamable_http_client` instead"):
|
||||
async with streamablehttp_client(f"{basic_server_url}/mcp") as ( # pyright: ignore[reportDeprecated]
|
||||
read_stream,
|
||||
write_stream,
|
||||
_,
|
||||
):
|
||||
async with ClientSession(read_stream, write_stream) as session: # pragma: no branch
|
||||
await session.initialize()
|
||||
tools = await session.list_tools()
|
||||
assert len(tools.tools) > 0
|
||||
|
|
|
|||
Loading…
Reference in a new issue