Skip to content

Commit 873590d

Browse files
committed
docs: update sse_client and streamablehttp_client inline docs
1 parent aa1b6ce commit 873590d

File tree

3 files changed

+12
-2
lines changed

3 files changed

+12
-2
lines changed

src/mcp/client/sse.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ async def sse_client(
4040
headers: Optional headers to include in requests.
4141
timeout: HTTP timeout for regular operations.
4242
sse_read_timeout: Timeout for SSE read operations.
43+
httpx_client_factory: McpHttpClientFactory.
4344
auth: Optional HTTPX authentication handler.
4445
"""
4546
read_stream: MemoryObjectReceiveStream[SessionMessage | Exception]

src/mcp/client/streamable_http.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -460,6 +460,15 @@ async def streamablehttp_client(
460460
`sse_read_timeout` determines how long (in seconds) the client will wait for a new
461461
event before disconnecting. All other HTTP operations are controlled by `timeout`.
462462
463+
Args:
464+
url: The SSE endpoint URL.
465+
headers: Optional headers to include in requests.
466+
timeout: HTTP timeout for regular operations.
467+
sse_read_timeout: Timeout for SSE read operations.
468+
terminate_on_close: Terminate session when stream closes.
469+
httpx_client_factory: McpHttpClientFactory.
470+
auth: Optional HTTPX authentication handler.
471+
463472
Yields:
464473
Tuple containing:
465474
- read_stream: Stream for reading messages from the server

tests/client/test_session_group.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -272,12 +272,12 @@ async def test_disconnect_non_existent_server(self):
272272
SseServerParameters(url="http://test.com/sse", timeout=10),
273273
"sse",
274274
"mcp.client.session_group.sse_client",
275-
), # url, headers, timeout, sse_read_timeout
275+
), # url, headers, timeout, sse_read_timeout, auth
276276
(
277277
StreamableHttpParameters(url="http://test.com/stream", terminate_on_close=False),
278278
"streamablehttp",
279279
"mcp.client.session_group.streamablehttp_client",
280-
), # url, headers, timeout, sse_read_timeout, terminate_on_close
280+
), # url, headers, timeout, sse_read_timeout, terminate_on_close, auth
281281
],
282282
)
283283
async def test_establish_session_parameterized(

0 commit comments

Comments
 (0)