forked from modelcontextprotocol/python-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_streamable_http_modern.py
More file actions
1198 lines (960 loc) · 54.9 KB
/
Copy pathtest_streamable_http_modern.py
File metadata and controls
1198 lines (960 loc) · 54.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Unit tests for the 2026-07-28 single-exchange HTTP serving entry.
The interaction suite under ``tests/interaction/transports/test_hosting_http_modern.py`` pins
the wire contract end to end; these tests cover the module's internal seams directly --
the closed back-channel on the dispatch context, and the request-validation ladder in
``handle_modern_request``.
"""
import json
import logging
from collections.abc import Callable
from typing import Any
import anyio
import httpx2
import pytest
from mcp_types import (
CLIENT_CAPABILITIES_META_KEY,
CLIENT_INFO_META_KEY,
HEADER_MISMATCH,
INTERNAL_ERROR,
INVALID_PARAMS,
INVALID_REQUEST,
METHOD_NOT_FOUND,
PARSE_ERROR,
PROTOCOL_VERSION_META_KEY,
SERVER_INFO_META_KEY,
CallToolRequestParams,
CallToolResult,
ClientCapabilities,
ErrorData,
JSONRPCError,
JSONRPCResponse,
ListToolsResult,
LoggingMessageNotification,
LoggingMessageNotificationParams,
PaginatedRequestParams,
Tool,
)
from mcp_types.version import LATEST_MODERN_VERSION
from starlette.types import Message, Receive, Scope, Send
from trio.testing import MockClock
from mcp.server import Server, ServerRequestContext, _streamable_http_modern, runner
from mcp.server._streamable_http_modern import (
_SingleExchangeDispatchContext,
_to_jsonrpc_response,
handle_modern_request,
)
from mcp.server.subscriptions import InMemorySubscriptionBus, ListenHandler, ServerEvent
from mcp.server.transport_security import TransportSecuritySettings
from mcp.shared.exceptions import MCPError, NoBackChannelError
from mcp.shared.inbound import MCP_METHOD_HEADER, MCP_NAME_HEADER, MCP_PROTOCOL_VERSION_HEADER
from mcp.shared.transport_context import TransportContext
from tests.interaction.transports import StreamingASGITransport
pytestmark = pytest.mark.anyio
@pytest.fixture(autouse=True)
def _module_runner_lease() -> None:
"""Opt out of the shared per-module event loop: this module parametrizes `anyio_backend`."""
async def test_single_exchange_dispatch_context_has_no_back_channel() -> None:
"""The per-request dispatch context refuses server-initiated requests; without an SSE sink,
notify/progress are no-ops."""
dctx = _SingleExchangeDispatchContext(
transport=TransportContext(kind="streamable-http", can_send_request=False),
request_id=1,
message_metadata=None,
)
assert dctx.can_send_request is False
with pytest.raises(NoBackChannelError):
await dctx.send_raw_request("roots/list", None)
assert await dctx.notify("notifications/message", None) is None
assert await dctx.progress(0.5, total=1.0, message="half") is None
def _asgi_client(
server: Server[Any],
security_settings: TransportSecuritySettings | None = None,
*,
json_response: bool = True,
accept: str = "application/json, text/event-stream",
) -> httpx2.AsyncClient:
async def app(scope: Scope, receive: Receive, send: Send) -> None:
async with server.lifespan(server) as lifespan_state:
await handle_modern_request(server, security_settings, json_response, lifespan_state, scope, receive, send)
return httpx2.AsyncClient(
transport=StreamingASGITransport(app),
base_url="http://testserver",
headers={
MCP_PROTOCOL_VERSION_HEADER: LATEST_MODERN_VERSION,
"content-type": "application/json",
"accept": accept,
},
)
async def test_handle_modern_request_rejects_non_post_with_http_405_and_allow_header() -> None:
"""SDK-defined: a GET on the modern entry is an HTTP-verb mismatch — 405 Method Not
Allowed with ``Allow: POST`` per RFC 9110. This is HTTP-layer (before JSON-RPC parsing)
so there is no JSON-RPC body."""
async with _asgi_client(Server("test")) as http:
response = await http.get("/mcp")
assert response.status_code == 405
assert response.headers["allow"] == "POST"
assert response.content == b""
async def test_handle_modern_request_rejects_a_notification_body_with_invalid_request() -> None:
"""SDK-defined: well-formed JSON that isn't a single JSON-RPC request object (e.g. a
notification, which lacks ``id``) is ``INVALID_REQUEST`` — distinct from ``PARSE_ERROR``,
which is for malformed JSON."""
async with _asgi_client(Server("test")) as http:
response = await http.post(
"/mcp",
content=b'{"jsonrpc":"2.0","method":"notifications/cancelled","params":{"requestId":1}}',
headers={"content-type": "application/json"},
)
assert response.status_code == 400
assert response.json()["error"]["code"] == INVALID_REQUEST
async def test_handle_modern_request_rejects_malformed_body_with_parse_error() -> None:
"""An unparseable POST body yields HTTP 400 with a ``PARSE_ERROR`` JSON-RPC error envelope.
SDK-defined: the 400 status comes from the SDK's error-code→HTTP-status table; spec-mandated: the
body is a full JSON-RPC error object with ``id: null`` and code ``-32700``.
"""
async with _asgi_client(Server("test")) as http:
response = await http.post("/mcp", content=b"not json", headers={"content-type": "application/json"})
assert response.status_code == 400
assert response.headers["content-type"].split(";", 1)[0] == "application/json"
assert response.json() == {
"jsonrpc": "2.0",
"id": None,
"error": {"code": PARSE_ERROR, "message": "Parse error"},
}
async def test_handle_modern_request_returns_transport_security_error_response() -> None:
"""The transport-security middleware's error response is sent verbatim and short-circuits."""
settings = TransportSecuritySettings(enable_dns_rebinding_protection=True, allowed_hosts=["good.example"])
async with _asgi_client(Server("test"), security_settings=settings) as http:
response = await http.post("/mcp", json={}, headers={"content-type": "application/json"})
assert response.status_code == 421
assert response.text == "Invalid Host header"
def _list_tools_body() -> dict[str, Any]:
"""A minimal valid 2026-07-28 ``tools/list`` request body, including the required ``_meta`` envelope."""
meta = {
PROTOCOL_VERSION_META_KEY: LATEST_MODERN_VERSION,
CLIENT_INFO_META_KEY: {"name": "raw", "version": "0.0.0"},
CLIENT_CAPABILITIES_META_KEY: {},
}
return {"jsonrpc": "2.0", "id": 1, "method": "tools/list", "params": {"_meta": meta}}
async def test_handle_modern_request_serves_pair_only_envelope_without_client_info() -> None:
"""Spec-mandated (spec PR #3002): `clientInfo` is optional - a request whose
`_meta` carries only the protocol-version + client-capabilities pair is
served, with the declared capabilities recorded and `client_params` None."""
seen: list[tuple[object, object]] = []
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
seen.append((ctx.session.client_params, ctx.session.client_capabilities))
return ListToolsResult(tools=[], ttl_ms=0, cache_scope="public")
server: Server[Any] = Server("test", on_list_tools=list_tools)
body = _list_tools_body()
del body["params"]["_meta"][CLIENT_INFO_META_KEY]
async with _asgi_client(server) as http:
response = await http.post("/mcp", json=body, headers={MCP_METHOD_HEADER: "tools/list"})
assert response.status_code == 200
assert response.json()["result"]["tools"] == []
assert seen == [(None, ClientCapabilities())]
async def test_handle_modern_request_missing_capabilities_rejects_naming_the_key() -> None:
"""Spec-mandated (basic/index.mdx): the protocol version without the
required client-capabilities key is malformed - INVALID_PARAMS (HTTP 400)
with a message naming the missing key."""
body = _list_tools_body()
del body["params"]["_meta"][CLIENT_CAPABILITIES_META_KEY]
async with _asgi_client(Server("test")) as http:
response = await http.post("/mcp", json=body, headers={MCP_METHOD_HEADER: "tools/list"})
assert response.status_code == 400
error = response.json()["error"]
assert error["code"] == INVALID_PARAMS
assert CLIENT_CAPABILITIES_META_KEY in error["message"]
async def test_handle_modern_request_routes_with_mis_shaped_envelope_client_info() -> None:
"""SDK-defined: a mis-shaped ``clientInfo`` envelope value is treated as not supplied —
the request still routes (200 + result) and the handler observes ``client_params is None``
rather than the request being rejected at the validation ladder. A non-spec method is
used so the kernel's per-method params validation does not re-reject the envelope."""
seen: list[object] = []
async def greet(ctx: ServerRequestContext, params: PaginatedRequestParams) -> dict[str, Any]:
seen.append(ctx.session.client_params)
return {"ok": True}
server: Server[Any] = Server("test")
server.add_request_handler("custom/greet", PaginatedRequestParams, greet)
body = _list_tools_body()
body["method"] = "custom/greet"
body["params"]["_meta"][CLIENT_INFO_META_KEY] = "not-an-object"
async with _asgi_client(server) as http:
response = await http.post("/mcp", json=body, headers={MCP_METHOD_HEADER: "custom/greet"})
assert response.status_code == 200
result = response.json()["result"]
assert result == {
"_meta": {SERVER_INFO_META_KEY: {"name": "test", "version": ""}},
"ok": True,
"resultType": "complete",
}
assert seen == [None]
async def test_handle_modern_request_sends_response_when_exit_stack_cleanup_raises(
caplog: pytest.LogCaptureFixture,
) -> None:
"""A raising ``connection.exit_stack`` callback is logged and swallowed; the computed result still ships.
The exit-stack guard is `aclose_shielded`: cleanup runs in `serve_one`'s ``finally`` after
the handler, and an exception there must not displace the JSON-RPC response that was already
built.
"""
async def boom() -> None:
raise RuntimeError("cleanup failed")
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
ctx.session._connection.exit_stack.push_async_callback(boom)
return ListToolsResult(tools=[], ttl_ms=0, cache_scope="public")
with caplog.at_level(logging.ERROR, logger=runner.__name__):
async with _asgi_client(Server("test", on_list_tools=list_tools)) as http:
response = await http.post("/mcp", json=_list_tools_body(), headers={MCP_METHOD_HEADER: "tools/list"})
assert response.status_code == 200
assert response.json()["result"]["tools"] == []
assert "connection exit_stack cleanup raised" in caplog.text
async def test_handle_modern_request_sends_response_when_exit_stack_cleanup_hangs(
monkeypatch: pytest.MonkeyPatch, caplog: pytest.LogCaptureFixture
) -> None:
"""A blocking ``connection.exit_stack`` callback is abandoned at the grace deadline; the response still ships.
Grace patched to 0 so the deadline is already expired on entry: the bounded unwind cancels the
blocker at its first checkpoint, the abandonment warning is logged, and the JSON-RPC response
that was built before cleanup is sent unchanged.
"""
monkeypatch.setattr(runner, "_EXIT_STACK_CLOSE_TIMEOUT", 0)
async def block() -> None:
await anyio.Event().wait()
raise AssertionError("unreachable") # pragma: no cover
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
ctx.session._connection.exit_stack.push_async_callback(block)
return ListToolsResult(tools=[], ttl_ms=0, cache_scope="public")
with anyio.fail_after(5), caplog.at_level(logging.WARNING, logger=runner.__name__):
async with _asgi_client(Server("test", on_list_tools=list_tools)) as http:
response = await http.post("/mcp", json=_list_tools_body(), headers={MCP_METHOD_HEADER: "tools/list"})
# coverage.py on Python 3.11 misreports the lines below as unhit (the test passes there);
# the shielded-cancel path inside the request task disrupts the tracer in this frame.
assert response.status_code == 200 # pragma: lax no cover
assert response.json()["result"]["tools"] == [] # pragma: lax no cover
assert "abandoning remaining callbacks" in caplog.text # pragma: lax no cover
# --- _to_jsonrpc_response ------------------------------------------------------
async def test_to_jsonrpc_response_wraps_success_as_jsonrpc_response() -> None:
"""SDK-defined: a handler coroutine resolving to a result dict is wrapped as a
`JSONRPCResponse` carrying the supplied id and the dict verbatim as `result`."""
async def ok() -> dict[str, Any]:
return {"k": "v"}
reply = await _to_jsonrpc_response(7, ok())
assert isinstance(reply, JSONRPCResponse)
assert reply.id == 7
assert reply.result == {"k": "v"}
async def test_to_jsonrpc_response_maps_mcp_error_to_jsonrpc_error() -> None:
"""SDK-defined: an `MCPError` raised by the handler coroutine is wrapped as a
`JSONRPCError` whose `error` carries the same code, message, and data."""
async def fail() -> dict[str, Any]:
raise MCPError(code=METHOD_NOT_FOUND, message="nope", data="x")
reply = await _to_jsonrpc_response("rid", fail())
assert isinstance(reply, JSONRPCError)
assert reply.id == "rid"
assert reply.error == ErrorData(code=METHOD_NOT_FOUND, message="nope", data="x")
async def test_to_jsonrpc_response_maps_validation_error_to_invalid_params() -> None:
"""SDK-defined: a pydantic `ValidationError` escaping the handler coroutine is
mapped to `INVALID_PARAMS` with a generic message (validator detail does not
reach the wire)."""
async def fail() -> dict[str, Any]:
Tool.model_validate({"name": 123}) # raises ValidationError
raise NotImplementedError
reply = await _to_jsonrpc_response(1, fail())
assert isinstance(reply, JSONRPCError)
assert reply.error == ErrorData(code=INVALID_PARAMS, message="Invalid request parameters", data="")
async def test_to_jsonrpc_response_maps_unmapped_exception_to_internal_error_and_logs(
caplog: pytest.LogCaptureFixture,
) -> None:
"""SDK-defined: an unmapped exception is logged server-side and surfaced as
`INTERNAL_ERROR` with a generic message; the exception text never reaches the
wire."""
async def fail() -> dict[str, Any]:
raise RuntimeError("boom")
reply = await _to_jsonrpc_response(1, fail())
assert isinstance(reply, JSONRPCError)
assert reply.error.code == INTERNAL_ERROR
# Handler internals never reach the wire.
assert "boom" not in reply.error.message
assert "request handler raised" in caplog.text
# --- header cross-check at the wire --------------------------------------------
async def test_handle_modern_request_rejects_mismatched_method_header_with_400_and_header_mismatch() -> None:
"""Spec-mandated: an `Mcp-Method` header that disagrees with `body.method` is rejected at the
boundary as HTTP 400 with JSON-RPC error code HEADER_MISMATCH; the handler never runs."""
async with _asgi_client(Server("test")) as http:
response = await http.post("/mcp", json=_list_tools_body(), headers={MCP_METHOD_HEADER: "prompts/list"})
assert response.status_code == 400
assert response.json()["error"]["code"] == HEADER_MISMATCH
async def test_handle_modern_request_rejects_mismatched_name_header_with_400_and_header_mismatch() -> None:
"""Spec-mandated: for a name-bearing method, an `Mcp-Name` header that disagrees with the body's
named param is rejected as HTTP 400 with JSON-RPC error code HEADER_MISMATCH."""
body = _list_tools_body()
body["method"] = "tools/call"
body["params"]["name"] = "real"
body["params"]["arguments"] = {}
async with _asgi_client(Server("test")) as http:
response = await http.post(
"/mcp", json=body, headers={MCP_METHOD_HEADER: "tools/call", MCP_NAME_HEADER: "wrong"}
)
assert response.status_code == 400
assert response.json()["error"]["code"] == HEADER_MISMATCH
# --- SSE response mode ---------------------------------------------------------
def _sse_payloads(body: str) -> list[dict[str, Any]]:
"""Parse an SSE body into the list of JSON `data:` payloads, in delivery order."""
return [
json.loads(line.removeprefix("data:").strip())
for line in body.replace("\r\n", "\n").splitlines()
if line.startswith("data:")
]
def _list_tools_body_with_token(token: str | int) -> dict[str, Any]:
body = _list_tools_body()
body["params"]["_meta"]["progressToken"] = token
return body
async def test_sse_mode_streams_progress_then_result() -> None:
"""SSE mode: a handler's `report_progress` calls stream as `notifications/progress` events
(carrying the request's progressToken) before the terminal JSON-RPC response event.
Spec-mandated: `notifications/progress` carries the caller's token; the per-request SSE stream
closes after the terminal response. Asserted at the wire because Content-Type and event order
are the contract.
"""
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
await ctx.session.report_progress(1.0, total=3.0)
await ctx.session.report_progress(2.0, total=3.0, message="almost")
return ListToolsResult(tools=[], ttl_ms=0, cache_scope="public")
async with _asgi_client(Server("test", on_list_tools=list_tools), json_response=False) as http:
with anyio.fail_after(5):
response = await http.post(
"/mcp", json=_list_tools_body_with_token("tok-1"), headers={MCP_METHOD_HEADER: "tools/list"}
)
assert response.status_code == 200
assert response.headers["content-type"].split(";", 1)[0] == "text/event-stream"
events = _sse_payloads(response.text)
assert len(events) == 3
assert events[0] == {
"jsonrpc": "2.0",
"method": "notifications/progress",
"params": {"progressToken": "tok-1", "progress": 1.0, "total": 3.0},
}
assert events[1] == {
"jsonrpc": "2.0",
"method": "notifications/progress",
"params": {"progressToken": "tok-1", "progress": 2.0, "total": 3.0, "message": "almost"},
}
assert events[2]["id"] == 1
assert events[2]["result"]["tools"] == []
@pytest.mark.parametrize(
"anyio_backend",
[pytest.param(("trio", {"clock": MockClock(autojump_threshold=0)}), id="trio-mockclock")],
)
async def test_sse_mode_emits_keepalive_comment_between_events(monkeypatch: pytest.MonkeyPatch) -> None:
"""SSE mode: while the stream is idle between events the server emits an SSE comment line so a
proxy idle-read timeout does not close the stream (which would cancel the handler).
SDK-defined: spec encourages keepalive comments for long-lived streams.
Runs on trio's autojumping MockClock so the `move_on_after(_SSE_PING_INTERVAL)` deadlines and
the handler's `anyio.sleep` advance without wall-clock time."""
monkeypatch.setattr("mcp.server._streamable_http_modern._SSE_PING_INTERVAL", 1.0)
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
await ctx.session.report_progress(1.0)
await anyio.sleep(2.5)
return ListToolsResult(tools=[], ttl_ms=0, cache_scope="public")
async with _asgi_client(Server("test", on_list_tools=list_tools), json_response=False) as http:
with anyio.fail_after(5):
response = await http.post(
"/mcp", json=_list_tools_body_with_token("tok"), headers={MCP_METHOD_HEADER: "tools/list"}
)
assert response.headers["content-type"].split(";", 1)[0] == "text/event-stream"
assert response.content.count(b": ping\r\n\r\n") == 2
events = _sse_payloads(response.text)
assert len(events) == 2
assert events[0]["method"] == "notifications/progress"
assert events[1]["result"]["tools"] == []
@pytest.mark.parametrize(
"anyio_backend",
[pytest.param(("trio", {"clock": MockClock(autojump_threshold=0)}), id="trio-mockclock")],
)
async def test_sse_mode_silent_handler_commits_sse_after_ping_interval(monkeypatch: pytest.MonkeyPatch) -> None:
"""SSE mode: a handler that runs silent past the deferral window commits `text/event-stream`
and starts pinging — even though it never emits a notification — so a proxy idle-read timeout
does not close the connection and cancel it. SDK-defined: the deferral window is bounded by
`_SSE_PING_INTERVAL`.
Runs on trio's autojumping MockClock; the 2.5s handler sleep takes no wall-clock time."""
monkeypatch.setattr("mcp.server._streamable_http_modern._SSE_PING_INTERVAL", 1.0)
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
await anyio.sleep(2.5)
return ListToolsResult(tools=[], ttl_ms=0, cache_scope="public")
async with _asgi_client(Server("test", on_list_tools=list_tools), json_response=False) as http:
with anyio.fail_after(5):
response = await http.post("/mcp", json=_list_tools_body(), headers={MCP_METHOD_HEADER: "tools/list"})
assert response.status_code == 200
assert response.headers["content-type"].split(";", 1)[0] == "text/event-stream"
assert response.content.count(b": ping\r\n\r\n") == 2
events = _sse_payloads(response.text)
assert len(events) == 1
assert events[0]["result"]["tools"] == []
async def test_sse_mode_streams_log_notification() -> None:
"""SSE mode: a request-scoped `notifications/message` emitted by the handler precedes the
terminal response on the same stream. SDK-defined: notifications sent on the request's outbound
channel reach the per-request SSE response."""
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
await ctx.session.send_notification(
LoggingMessageNotification(params=LoggingMessageNotificationParams(level="info", data="hello")),
related_request_id=ctx.request_id,
)
return ListToolsResult(tools=[], ttl_ms=0, cache_scope="public")
async with _asgi_client(Server("test", on_list_tools=list_tools), json_response=False) as http:
with anyio.fail_after(5):
response = await http.post("/mcp", json=_list_tools_body(), headers={MCP_METHOD_HEADER: "tools/list"})
assert response.headers["content-type"].split(";", 1)[0] == "text/event-stream"
events = _sse_payloads(response.text)
assert len(events) == 2
assert events[0]["method"] == "notifications/message"
assert events[0]["params"] == {"level": "info", "data": "hello"}
assert events[1]["result"]["tools"] == []
async def test_json_mode_drops_progress() -> None:
"""JSON mode: `report_progress` is a no-op (no sink); the response is a plain
`application/json` body carrying only the terminal result. SDK-defined."""
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
await ctx.session.report_progress(1, total=2)
return ListToolsResult(tools=[], ttl_ms=0, cache_scope="public")
async with _asgi_client(Server("test", on_list_tools=list_tools), json_response=True) as http:
response = await http.post(
"/mcp", json=_list_tools_body_with_token("tok"), headers={MCP_METHOD_HEADER: "tools/list"}
)
assert response.headers["content-type"].split(";", 1)[0] == "application/json"
body = response.json()
assert body["id"] == 1
assert body["result"]["tools"] == []
assert "notifications/progress" not in response.text
async def test_sse_mode_error_before_any_notify_is_json_with_mapped_status() -> None:
"""SSE mode: an error raised before the handler emits any notification is written as
`application/json` with the table-mapped HTTP status — SSE has not committed yet.
Spec-mandated: METHOD_NOT_FOUND MUST be `404 Not Found`."""
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
raise MCPError(code=METHOD_NOT_FOUND, message="nope")
async with _asgi_client(Server("test", on_list_tools=list_tools), json_response=False) as http:
with anyio.fail_after(5):
response = await http.post("/mcp", json=_list_tools_body(), headers={MCP_METHOD_HEADER: "tools/list"})
assert response.status_code == 404
assert response.headers["content-type"].split(";", 1)[0] == "application/json"
assert response.json() == {"jsonrpc": "2.0", "id": 1, "error": {"code": METHOD_NOT_FOUND, "message": "nope"}}
async def test_sse_mode_error_after_notify_is_sse_event() -> None:
"""SSE mode: an error raised after the handler has emitted is delivered as the terminal SSE
event (HTTP 200) — `text/event-stream` headers were committed on the first notification."""
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
await ctx.session.report_progress(1.0)
raise MCPError(code=INTERNAL_ERROR, message="boom")
async with _asgi_client(Server("test", on_list_tools=list_tools), json_response=False) as http:
with anyio.fail_after(5):
response = await http.post(
"/mcp", json=_list_tools_body_with_token("tok"), headers={MCP_METHOD_HEADER: "tools/list"}
)
assert response.status_code == 200
assert response.headers["content-type"].split(";", 1)[0] == "text/event-stream"
events = _sse_payloads(response.text)
assert len(events) == 2
assert events[0]["method"] == "notifications/progress"
assert events[1] == {"jsonrpc": "2.0", "id": 1, "error": {"code": INTERNAL_ERROR, "message": "boom"}}
async def test_sse_mode_no_notify_response_is_json() -> None:
"""SSE mode: a handler that emits nothing (here `report_progress` is a no-op because no
`progressToken` was supplied) gets a plain `application/json` response. SDK-defined: SSE only
commits once there is something to stream."""
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
await ctx.session.report_progress(1, total=2)
return ListToolsResult(tools=[], ttl_ms=0, cache_scope="public")
async with _asgi_client(Server("test", on_list_tools=list_tools), json_response=False) as http:
with anyio.fail_after(5):
response = await http.post("/mcp", json=_list_tools_body(), headers={MCP_METHOD_HEADER: "tools/list"})
assert response.status_code == 200
assert response.headers["content-type"].split(";", 1)[0] == "application/json"
assert response.json()["result"]["tools"] == []
async def test_accept_missing_sse_406_in_sse_mode() -> None:
"""SDK-defined: in SSE mode the client must accept both `application/json` and
`text/event-stream`; an Accept header naming only JSON is rejected at HTTP 406 before any
JSON-RPC parsing."""
async with _asgi_client(Server("test"), json_response=False, accept="application/json") as http:
response = await http.post("/mcp", json=_list_tools_body(), headers={MCP_METHOD_HEADER: "tools/list"})
assert response.status_code == 406
assert response.content == b""
async def test_accept_missing_sse_ok_in_json_mode() -> None:
"""SDK-defined: in JSON mode only `application/json` need be acceptable; an Accept header that
omits `text/event-stream` still routes (200 + result)."""
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
return ListToolsResult(tools=[], ttl_ms=0, cache_scope="public")
async with _asgi_client(
Server("test", on_list_tools=list_tools), json_response=True, accept="application/json"
) as http:
response = await http.post("/mcp", json=_list_tools_body(), headers={MCP_METHOD_HEADER: "tools/list"})
assert response.status_code == 200
assert response.headers["content-type"].split(";", 1)[0] == "application/json"
@pytest.mark.parametrize("json_response", [True, False])
async def test_accept_wildcard_satisfies_both_response_modes(json_response: bool) -> None:
"""SDK-defined: `Accept: */*` satisfies both representations (RFC 7231 wildcard) in either
response mode."""
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
return ListToolsResult(tools=[], ttl_ms=0, cache_scope="public")
async with _asgi_client(
Server("test", on_list_tools=list_tools), json_response=json_response, accept="*/*"
) as http:
with anyio.fail_after(5):
response = await http.post("/mcp", json=_list_tools_body(), headers={MCP_METHOD_HEADER: "tools/list"})
assert response.status_code == 200
async def test_accept_q0_for_the_required_type_is_not_acceptable() -> None:
"""RFC 7231 5.3.1: a media-range weighted q=0 is explicitly "not acceptable" -- a client
that sends `application/json;q=0` has ruled JSON out even though it's the only other type
on the line, so a JSON-mode request must get 406, not 200."""
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
return ListToolsResult(tools=[], ttl_ms=0, cache_scope="public") # pragma: no cover
async with _asgi_client(
Server("test", on_list_tools=list_tools),
json_response=True,
accept="application/json;q=0, text/event-stream;q=1.0",
) as http:
response = await http.post("/mcp", json=_list_tools_body(), headers={MCP_METHOD_HEADER: "tools/list"})
assert response.status_code == 406
async def test_accept_q0_for_a_specific_type_overrides_a_present_wildcard() -> None:
"""A specific "not acceptable" entry is more specific than `*/*` and must win: the client
is still rejecting JSON even though it also (redundantly) accepts everything."""
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
return ListToolsResult(tools=[], ttl_ms=0, cache_scope="public") # pragma: no cover
async with _asgi_client(
Server("test", on_list_tools=list_tools),
json_response=True,
accept="application/json;q=0, */*",
) as http:
response = await http.post("/mcp", json=_list_tools_body(), headers={MCP_METHOD_HEADER: "tools/list"})
assert response.status_code == 406
async def test_accept_nonzero_q_for_the_required_type_is_still_acceptable() -> None:
"""A low but nonzero weight is still a "yes" -- q only gates acceptability at 0, this SDK
doesn't rank multiple acceptable representations by preference."""
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
return ListToolsResult(tools=[], ttl_ms=0, cache_scope="public")
async with _asgi_client(
Server("test", on_list_tools=list_tools),
json_response=True,
accept="application/json;q=0.1",
) as http:
response = await http.post("/mcp", json=_list_tools_body(), headers={MCP_METHOD_HEADER: "tools/list"})
assert response.status_code == 200
async def test_late_notify_after_terminal_dropped() -> None:
"""SDK-defined: a `notify()` after the SSE sink has closed is silently dropped — the closed
stream must not propagate as an exception out of the dispatch context."""
send_ch, recv_ch = anyio.create_memory_object_stream[bytes](0)
dctx = _SingleExchangeDispatchContext(
transport=TransportContext(kind="streamable-http", can_send_request=False),
request_id=1,
message_metadata=None,
sink=send_ch,
)
await recv_ch.aclose()
# Neither raises despite the receiver being gone (BrokenResourceError caught and dropped).
assert await dctx.notify("notifications/message", {"level": "info", "data": "late"}) is None
dctx.progress_token = "tok"
assert await dctx.progress(1.0) is None
await send_ch.aclose()
async def test_disconnect_cancels_handler_and_runs_exit_stack() -> None:
"""SSE mode: when the client disconnects mid-stream the handler task is cancelled and
`connection.exit_stack` still unwinds. SDK-defined: `serve_one`'s shielded cleanup runs in the
cancellation path so handler-registered teardown is not skipped on disconnect."""
handler_started = anyio.Event()
cleanup_ran = anyio.Event()
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
ctx.session._connection.exit_stack.callback(cleanup_ran.set)
handler_started.set()
await anyio.Event().wait()
raise AssertionError("unreachable") # pragma: no cover
server: Server[Any] = Server("test", on_list_tools=list_tools)
body = json.dumps(_list_tools_body()).encode()
scope: Scope = {
"type": "http",
"asgi": {"version": "3.0"},
"http_version": "1.1",
"method": "POST",
"scheme": "http",
"server": ("testserver", 80),
"client": ("127.0.0.1", 1234),
"path": "/mcp",
"raw_path": b"/mcp",
"query_string": b"",
"root_path": "",
"headers": [
(b"host", b"testserver"),
(b"content-type", b"application/json"),
(b"accept", b"application/json, text/event-stream"),
(MCP_PROTOCOL_VERSION_HEADER.encode(), LATEST_MODERN_VERSION.encode()),
(MCP_METHOD_HEADER.encode(), b"tools/list"),
],
}
request_delivered = anyio.Event()
async def receive() -> Message:
# First call delivers the request body; once the handler is parked, deliver disconnect.
if not request_delivered.is_set():
request_delivered.set()
return {"type": "http.request", "body": body, "more_body": False}
await handler_started.wait()
return {"type": "http.disconnect"}
async def send(message: Message) -> None: # pragma: no cover
pass
with anyio.fail_after(5):
async with server.lifespan(server) as lifespan_state:
await handle_modern_request(server, None, False, lifespan_state, scope, receive, send)
await cleanup_ran.wait()
assert handler_started.is_set()
# --- Mcp-Param-* validation (SEP-2243 server half) -------------------------------
_REGION_TOOL = Tool(
name="search",
input_schema={
"type": "object",
"properties": {"region": {"type": "string", "x-mcp-header": "Region"}},
},
)
def _tool_call_body(arguments: dict[str, Any] | None = None, *, name: str | None = "search") -> dict[str, Any]:
"""A valid 2026-07-28 `tools/call` body; `name=None` omits the name entirely."""
body = _list_tools_body()
body["method"] = "tools/call"
if name is not None:
body["params"]["name"] = name
if arguments is not None:
body["params"]["arguments"] = arguments
return body
_TOOL_CALL_HEADERS = {MCP_METHOD_HEADER: "tools/call", MCP_NAME_HEADER: "search"}
async def _ok_call_tool(ctx: ServerRequestContext, params: CallToolRequestParams) -> CallToolResult:
return CallToolResult(content=[])
def _x_mcp_server(tools: list[Tool] | None = None) -> Server[Any]:
"""A lowlevel server whose `tools/list` handler advertises an `x-mcp-header` tool."""
async def list_tools(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
return ListToolsResult(tools=tools if tools is not None else [_REGION_TOOL], ttl_ms=0, cache_scope="public")
return Server("test", on_list_tools=list_tools, on_call_tool=_ok_call_tool)
async def test_modern_tools_call_accepts_matching_mcp_param_header() -> None:
"""A `Mcp-Param-*` header that agrees with the body argument after sentinel decoding dispatches normally."""
async with _asgi_client(_x_mcp_server()) as http:
response = await http.post(
"/mcp",
json=_tool_call_body({"region": "Tōkyō"}),
headers=_TOOL_CALL_HEADERS | {"mcp-param-region": "=?base64?VMWNa3nFjQ==?="},
)
assert response.status_code == 200
assert response.json()["result"]["content"] == []
async def test_modern_tools_call_validates_mcp_param_headers_for_a_pair_only_envelope() -> None:
"""The schema-resolving `tools/list` walk builds its synthetic envelope from the caller's:
a pair-only caller (spec PR #3002, no clientInfo) omits the optional key rather than sending
null, so header validation still runs and a mismatched header is still rejected."""
body = _tool_call_body({"region": "east"})
del body["params"]["_meta"][CLIENT_INFO_META_KEY]
async with _asgi_client(_x_mcp_server()) as http:
matched = await http.post("/mcp", json=body, headers=_TOOL_CALL_HEADERS | {"mcp-param-region": "east"})
mismatched = await http.post("/mcp", json=body, headers=_TOOL_CALL_HEADERS | {"mcp-param-region": "west"})
assert matched.status_code == 200
assert mismatched.status_code == 400
assert mismatched.json()["error"]["code"] == HEADER_MISMATCH
@pytest.mark.parametrize("json_response", [True, False])
async def test_modern_tools_call_rejects_mcp_param_mismatch_with_400_and_header_mismatch(
json_response: bool,
) -> None:
"""Spec MUST: a header/body mismatch is HTTP 400 + `HEADER_MISMATCH`, plain JSON even in SSE mode."""
async with _asgi_client(_x_mcp_server(), json_response=json_response) as http:
response = await http.post(
"/mcp",
json=_tool_call_body({"region": "us"}),
headers=_TOOL_CALL_HEADERS | {"mcp-param-region": "eu"},
)
assert response.status_code == 400
assert response.headers["content-type"].split(";", 1)[0] == "application/json"
error = response.json()["error"]
assert error["code"] == HEADER_MISMATCH
assert "Mcp-Param-Region" in error["message"]
async def test_modern_tools_call_rejects_missing_mcp_param_header_for_present_argument() -> None:
"""Spec table: a missing header for a present annotated argument MUST be rejected."""
async with _asgi_client(_x_mcp_server()) as http:
response = await http.post("/mcp", json=_tool_call_body({"region": "test-value"}), headers=_TOOL_CALL_HEADERS)
assert response.status_code == 400
assert response.json()["error"]["code"] == HEADER_MISMATCH
async def test_modern_tools_call_rejects_orphan_mcp_param_header() -> None:
"""SDK posture: a header for an absent argument is the routing-spoof case the gate exists to stop."""
async with _asgi_client(_x_mcp_server()) as http:
response = await http.post(
"/mcp", json=_tool_call_body({}), headers=_TOOL_CALL_HEADERS | {"mcp-param-region": "eu"}
)
assert response.status_code == 400
assert response.json()["error"]["code"] == HEADER_MISMATCH
async def test_modern_tools_call_skips_validation_without_a_tools_list_handler() -> None:
"""Without a `tools/list` handler no annotations were ever advertised, so `Mcp-Param-*` headers are ignored."""
server: Server[Any] = Server("test")
server.add_request_handler("tools/call", CallToolRequestParams, _ok_call_tool)
async with _asgi_client(server) as http:
response = await http.post(
"/mcp",
json=_tool_call_body({"region": "us"}),
headers=_TOOL_CALL_HEADERS | {"mcp-param-region": "eu"},
)
assert response.status_code == 200
assert response.json()["result"]["content"] == []
async def test_modern_tools_call_skips_validation_when_tool_not_listed_to_this_caller() -> None:
"""A tool absent from this caller's listing was never advertised to it, so its headers go unvalidated."""
other = Tool(name="other", input_schema={"type": "object"})
async with _asgi_client(_x_mcp_server(tools=[other])) as http:
response = await http.post(
"/mcp",
json=_tool_call_body({"region": "us"}),
headers=_TOOL_CALL_HEADERS | {"mcp-param-region": "eu"},
)
assert response.status_code == 200
async def test_modern_tools_call_skips_validation_when_list_handler_raises(
caplog: pytest.LogCaptureFixture,
) -> None:
"""A raising `tools/list` handler fails open — validation is skipped and the skip logged at error level."""
async def broken_list(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
raise RuntimeError("catalog backend down")
server: Server[Any] = Server("test", on_list_tools=broken_list, on_call_tool=_ok_call_tool)
with caplog.at_level(logging.ERROR, logger=_streamable_http_modern.__name__):
async with _asgi_client(server) as http:
response = await http.post(
"/mcp",
json=_tool_call_body({"region": "us"}),
headers=_TOOL_CALL_HEADERS | {"mcp-param-region": "eu"},
)
assert response.status_code == 200
assert "Mcp-Param header validation skipped: the tools/list listing failed" in caplog.text
async def test_modern_tools_call_walks_pagination_to_find_the_tool() -> None:
"""The schema lookup follows `nextCursor` pages; a tool on a later page is still validated."""
cursors_seen: list[str | None] = []
async def paged_list(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
cursor = params.cursor if params is not None else None
cursors_seen.append(cursor)
if cursor is None:
return ListToolsResult(tools=[], next_cursor="page-2", ttl_ms=0, cache_scope="public")
return ListToolsResult(tools=[_REGION_TOOL], ttl_ms=0, cache_scope="public")
server: Server[Any] = Server("test", on_list_tools=paged_list, on_call_tool=_ok_call_tool)
async with _asgi_client(server) as http:
response = await http.post(
"/mcp",
json=_tool_call_body({"region": "us"}),
headers=_TOOL_CALL_HEADERS | {"mcp-param-region": "eu"},
)
assert response.status_code == 400
assert response.json()["error"]["code"] == HEADER_MISMATCH
assert cursors_seen == [None, "page-2"]
async def test_modern_tools_call_skips_validation_on_a_cursor_cycle(
caplog: pytest.LogCaptureFixture,
) -> None:
"""A repeated cursor stops the walk with a logged skip instead of hanging the request."""
async def cycling_list(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
return ListToolsResult(tools=[], next_cursor="loop", ttl_ms=0, cache_scope="public")
server: Server[Any] = Server("test", on_list_tools=cycling_list, on_call_tool=_ok_call_tool)
with caplog.at_level(logging.WARNING, logger=_streamable_http_modern.__name__):
async with _asgi_client(server) as http:
response = await http.post(
"/mcp",
json=_tool_call_body({"region": "us"}),
headers=_TOOL_CALL_HEADERS | {"mcp-param-region": "eu"},
)
assert response.status_code == 200
assert "cursor cycle" in caplog.text
async def test_modern_tools_call_skips_validation_at_the_pagination_cap(
monkeypatch: pytest.MonkeyPatch, caplog: pytest.LogCaptureFixture
) -> None:
"""A non-terminating cursor chain stops at the page cap: logged skip, never a hang."""
monkeypatch.setattr(_streamable_http_modern, "_MCP_PARAM_LIST_PAGE_CAP", 3)
pages = iter(range(1_000_000))
async def endless_list(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
return ListToolsResult(tools=[], next_cursor=f"page-{next(pages)}", ttl_ms=0, cache_scope="public")
server: Server[Any] = Server("test", on_list_tools=endless_list, on_call_tool=_ok_call_tool)
with caplog.at_level(logging.WARNING, logger=_streamable_http_modern.__name__):
async with _asgi_client(server) as http:
response = await http.post(
"/mcp",
json=_tool_call_body({"region": "us"}),
headers=_TOOL_CALL_HEADERS | {"mcp-param-region": "eu"},
)
assert response.status_code == 200
assert "did not terminate within 3 pages" in caplog.text
async def test_modern_tools_call_threads_the_callers_envelope_into_the_synthetic_listing() -> None:
"""The synthetic `tools/list` runs as this caller, so a visibility-scoped handler produces its view."""
seen: list[Any] = []
async def recording_list(ctx: ServerRequestContext, params: PaginatedRequestParams | None) -> ListToolsResult:
seen.append(ctx.session.client_params)
return ListToolsResult(tools=[_REGION_TOOL], ttl_ms=0, cache_scope="public")
server: Server[Any] = Server("test", on_list_tools=recording_list, on_call_tool=_ok_call_tool)
async with _asgi_client(server) as http:
response = await http.post(
"/mcp",
json=_tool_call_body({"region": "eu"}),
headers=_TOOL_CALL_HEADERS | {"mcp-param-region": "eu"},
)
assert response.status_code == 200
assert len(seen) == 1
assert seen[0] is not None
assert seen[0].client_info.name == "raw"
async def test_modern_tools_call_leaves_mis_shaped_name_and_arguments_to_dispatch() -> None:
"""A missing `name` or non-mapping `arguments` is dispatch's INVALID_PARAMS, never a header mismatch."""
async with _asgi_client(_x_mcp_server()) as http:
nameless = await http.post("/mcp", json=_tool_call_body(name=None), headers={MCP_METHOD_HEADER: "tools/call"})
bad_arguments_body = _tool_call_body()
bad_arguments_body["params"]["arguments"] = ["not", "a", "mapping"]
bad_arguments = await http.post(
"/mcp",
json=bad_arguments_body,
headers=_TOOL_CALL_HEADERS | {"mcp-param-region": "eu"},
)
assert nameless.json()["error"]["code"] == INVALID_PARAMS
assert bad_arguments.json()["error"]["code"] == INVALID_PARAMS
async def test_modern_tools_call_rejects_a_duplicated_mcp_param_header() -> None:
"""A duplicated recognized header is rejected even if one copy matches: readers may disagree on which wins."""