sse
sse_client
async
sse_client(
url: str,
headers: dict[str, Any] | None = None,
timeout: float = 5.0,
sse_read_timeout: float = 300.0,
httpx_client_factory: McpHttpClientFactory = create_mcp_http_client,
auth: Auth | None = None,
on_session_created: Callable[[str], None] | None = None,
)
Client transport for the legacy HTTP+SSE protocol.
Deprecated: HTTP+SSE was superseded by Streamable HTTP in protocol revision 2025-03-26 and
formally deprecated by SEP-2596. It remains for connecting to servers that still speak it;
use mcp.client.streamable_http.streamable_http_client for anything new.
sse_read_timeout determines how long (in seconds) the client will wait for a new
event before disconnecting. All other HTTP operations are controlled by timeout.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
url
|
str
|
The SSE endpoint URL. |
required |
headers
|
dict[str, Any] | None
|
Optional headers to include in requests. |
None
|
timeout
|
float
|
HTTP timeout for regular operations (in seconds). |
5.0
|
sse_read_timeout
|
float
|
Timeout for SSE read operations (in seconds). |
300.0
|
httpx_client_factory
|
McpHttpClientFactory
|
Factory function for creating the httpx2 client. |
create_mcp_http_client
|
auth
|
Auth | None
|
Optional httpx2 authentication handler. |
None
|
on_session_created
|
Callable[[str], None] | None
|
Optional callback invoked with the session ID when received. |
None
|
Source code in src/mcp/client/sse.py
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 | |