session
ClientRequestContext
dataclass
Context for a server-initiated request, passed to the sampling/elicitation/list-roots callbacks.
Source code in src/mcp/client/session.py
112 113 114 115 116 117 118 | |
ClientSession
Client half of an MCP connection, running on a Dispatcher.
Construct it over a transport's stream pair (or pass a pre-built
dispatcher=), enter as an async context manager, then call
initialize(). The dispatcher owns the receive loop and request
correlation; this class owns the typed MCP layer and the constructor
callbacks. Transport Exception items reach message_handler only when
the session builds its own dispatcher from a stream pair.
Extension result_claims fold into tools/call parsing at adopt();
notification_bindings observe vendor notifications via bounded FIFOs.
Source code in src/mcp/client/session.py
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 | |
send_request
async
send_request(
request: ClientRequest | Request[Any, Any],
result_type: (
type[ReceiveResultT] | TypeAdapter[ReceiveResultT]
),
request_read_timeout_seconds: float | None = None,
metadata: ClientMessageMetadata | None = None,
progress_callback: ProgressFnT | None = None,
) -> ReceiveResultT
Send a request and wait for its typed result.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
metadata
|
ClientMessageMetadata | None
|
Streamable HTTP resumption hints. |
None
|
Raises:
| Type | Description |
|---|---|
MCPError
|
Error response, read timeout, or connection closed. |
RuntimeError
|
Called before entering the context manager. |
ValueError
|
The request declares |
ValidationError
|
The server returned a result that does not conform to the negotiated protocol version. |
Source code in src/mcp/client/session.py
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 | |
send_notification
async
send_notification(notification: ClientNotification) -> None
Send a one-way notification. Usable before entering the context manager.
Fire-and-forget: after the connection has closed, the notification is dropped with a debug log instead of raising.
Source code in src/mcp/client/session.py
496 497 498 499 500 501 502 503 504 505 | |
adopt
adopt(result: InitializeResult | DiscoverResult) -> None
Install negotiated state from a result the caller already holds (no wire traffic).
Clears the opposite slot, so at most one of initialize_result /
discover_result is ever non-None.
Raises:
| Type | Description |
|---|---|
RuntimeError
|
|
Source code in src/mcp/client/session.py
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 | |
send_discover
async
Send a single server/discover at version and return the raw result dict.
No retry, no adopt(). The _meta envelope and the
Mcp-Protocol-Version header are stamped at version so the
server-side era router sees a coherent probe. Used by discover() and
the connect-time auto-negotiation policy.
Raises:
| Type | Description |
|---|---|
MCPError
|
The server returned a JSON-RPC error, or the transport bounced the request at its own layer (a bare HTTP 4xx is synthesized into a JSON-RPC error by the transport). |
Source code in src/mcp/client/session.py
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 | |
discover
async
discover() -> DiscoverResult
Probe server/discover and adopt the result.
Sends a single server/discover proposing the newest modern protocol
version. On UNSUPPORTED_PROTOCOL_VERSION (-32022) the server's
supported list is intersected with MODERN_PROTOCOL_VERSIONS and the
probe is retried once at the highest mutual version. Any other error —
including METHOD_NOT_FOUND (-32601) and REQUEST_TIMEOUT (-32001) —
propagates; the legacy initialize() fallback is the caller's policy.
Raises:
| Type | Description |
|---|---|
MCPError
|
The server rejected |
RuntimeError
|
|
Source code in src/mcp/client/session.py
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 | |
initialize_result
property
initialize_result: InitializeResult | None
The server's InitializeResult. None unless initialize() ran (or was adopted).
discover_result
property
discover_result: DiscoverResult | None
The server's DiscoverResult. None unless discover() ran (or was adopted).
Retained intact (supported_versions, ttl_ms, cache_scope) so callers
can round-trip it as prior_discover=.
protocol_version
property
protocol_version: str | None
Negotiated protocol version. None until initialize(), discover(), or adopt().
server_info
property
server_info: Implementation | None
Server name/version. None until initialize(), discover(), or adopt().
server_capabilities
property
server_capabilities: ServerCapabilities | None
Server capabilities. None until initialize(), discover(), or adopt().
send_ping
async
send_ping(
*, meta: RequestParamsMeta | None = None
) -> EmptyResult
Send a ping request.
Source code in src/mcp/client/session.py
730 731 732 | |
send_progress_notification
async
send_progress_notification(
progress_token: str | int,
progress: float,
total: float | None = None,
message: str | None = None,
*,
meta: RequestParamsMeta | None = None
) -> None
Send a progress notification.
Source code in src/mcp/client/session.py
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 | |
set_logging_level
async
set_logging_level(
level: LoggingLevel,
*,
meta: RequestParamsMeta | None = None
) -> EmptyResult
Send a logging/setLevel request.
Source code in src/mcp/client/session.py
760 761 762 763 764 765 766 767 768 769 770 771 | |
list_resources
async
list_resources(
*, params: PaginatedRequestParams | None = None
) -> ListResourcesResult
Send a resources/list request.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
params
|
PaginatedRequestParams | None
|
Full pagination parameters including cursor and any future fields |
None
|
Source code in src/mcp/client/session.py
773 774 775 776 777 778 779 | |
list_resource_templates
async
list_resource_templates(
*, params: PaginatedRequestParams | None = None
) -> ListResourceTemplatesResult
Send a resources/templates/list request.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
params
|
PaginatedRequestParams | None
|
Full pagination parameters including cursor and any future fields |
None
|
Source code in src/mcp/client/session.py
781 782 783 784 785 786 787 788 789 790 791 792 | |
read_resource
async
read_resource(
uri: str,
*,
input_responses: InputResponses | None = None,
request_state: str | None = None,
meta: RequestParamsMeta | None = None,
allow_input_required: Literal[False] = False
) -> ReadResourceResult
read_resource(
uri: str,
*,
input_responses: InputResponses | None = None,
request_state: str | None = None,
meta: RequestParamsMeta | None = None,
allow_input_required: bool
) -> ReadResourceResult | InputRequiredResult
read_resource(
uri: str,
*,
input_responses: InputResponses | None = None,
request_state: str | None = None,
meta: RequestParamsMeta | None = None,
allow_input_required: bool = False
) -> ReadResourceResult | InputRequiredResult
Send a resources/read request.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input_responses
|
InputResponses | None
|
Responses to a prior |
None
|
request_state
|
str | None
|
Opaque state echoed from a prior |
None
|
allow_input_required
|
bool
|
When |
False
|
Raises:
| Type | Description |
|---|---|
RuntimeError
|
If the server returns an |
Source code in src/mcp/client/session.py
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 | |
subscribe_resource
async
subscribe_resource(
uri: str, *, meta: RequestParamsMeta | None = None
) -> EmptyResult
Send a resources/subscribe request.
Source code in src/mcp/client/session.py
853 854 855 856 857 858 | |
unsubscribe_resource
async
unsubscribe_resource(
uri: str, *, meta: RequestParamsMeta | None = None
) -> EmptyResult
Send a resources/unsubscribe request.
Source code in src/mcp/client/session.py
860 861 862 863 864 865 | |
call_tool
async
call_tool(
name: str,
arguments: dict[str, Any] | None = None,
read_timeout_seconds: float | None = None,
progress_callback: ProgressFnT | None = None,
*,
input_responses: InputResponses | None = None,
request_state: str | None = None,
meta: RequestParamsMeta | None = None,
allow_input_required: Literal[False] = False,
allow_claimed: Literal[False] = False
) -> CallToolResult
call_tool(
name: str,
arguments: dict[str, Any] | None = None,
read_timeout_seconds: float | None = None,
progress_callback: ProgressFnT | None = None,
*,
input_responses: InputResponses | None = None,
request_state: str | None = None,
meta: RequestParamsMeta | None = None,
allow_input_required: bool,
allow_claimed: Literal[False] = False
) -> CallToolResult | InputRequiredResult
call_tool(
name: str,
arguments: dict[str, Any] | None = None,
read_timeout_seconds: float | None = None,
progress_callback: ProgressFnT | None = None,
*,
input_responses: InputResponses | None = None,
request_state: str | None = None,
meta: RequestParamsMeta | None = None,
allow_input_required: Literal[False] = False,
allow_claimed: bool
) -> CallToolResult | Result
call_tool(
name: str,
arguments: dict[str, Any] | None = None,
read_timeout_seconds: float | None = None,
progress_callback: ProgressFnT | None = None,
*,
input_responses: InputResponses | None = None,
request_state: str | None = None,
meta: RequestParamsMeta | None = None,
allow_input_required: bool,
allow_claimed: bool
) -> CallToolResult | InputRequiredResult | Result
call_tool(
name: str,
arguments: dict[str, Any] | None = None,
read_timeout_seconds: float | None = None,
progress_callback: ProgressFnT | None = None,
*,
input_responses: InputResponses | None = None,
request_state: str | None = None,
meta: RequestParamsMeta | None = None,
allow_input_required: bool = False,
allow_claimed: bool = False
) -> CallToolResult | InputRequiredResult | Result
Send a tools/call request with optional progress callback support.
On a modern (2026-07-28) connection, arguments annotated with x-mcp-header
in the tool's input schema are mirrored into Mcp-Param-* request headers.
The annotations are read from the tool's last list_tools entry, so list
the tool before calling it to enable header emission.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input_responses
|
InputResponses | None
|
Responses to a prior |
None
|
request_state
|
str | None
|
Opaque state echoed from a prior |
None
|
allow_input_required
|
bool
|
When |
False
|
allow_claimed
|
bool
|
When |
False
|
Raises:
| Type | Description |
|---|---|
RuntimeError
|
If the server returns an |
UnexpectedClaimedResult
|
Claimed result with |
Source code in src/mcp/client/session.py
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 | |
validate_tool_result
async
validate_tool_result(
name: str, result: CallToolResult
) -> None
Revalidate a CallToolResult against the tool's declared output schema.
Raises:
| Type | Description |
|---|---|
RuntimeError
|
Structured content is missing or does not conform to the schema. |
Source code in src/mcp/client/session.py
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 | |
list_prompts
async
list_prompts(
*, params: PaginatedRequestParams | None = None
) -> ListPromptsResult
Send a prompts/list request.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
params
|
PaginatedRequestParams | None
|
Full pagination parameters including cursor and any future fields |
None
|
Source code in src/mcp/client/session.py
1021 1022 1023 1024 1025 1026 1027 | |
get_prompt
async
get_prompt(
name: str,
arguments: dict[str, str] | None = None,
*,
input_responses: InputResponses | None = None,
request_state: str | None = None,
meta: RequestParamsMeta | None = None,
allow_input_required: Literal[False] = False
) -> GetPromptResult
get_prompt(
name: str,
arguments: dict[str, str] | None = None,
*,
input_responses: InputResponses | None = None,
request_state: str | None = None,
meta: RequestParamsMeta | None = None,
allow_input_required: bool
) -> GetPromptResult | InputRequiredResult
get_prompt(
name: str,
arguments: dict[str, str] | None = None,
*,
input_responses: InputResponses | None = None,
request_state: str | None = None,
meta: RequestParamsMeta | None = None,
allow_input_required: bool = False
) -> GetPromptResult | InputRequiredResult
Send a prompts/get request.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input_responses
|
InputResponses | None
|
Responses to a prior |
None
|
request_state
|
str | None
|
Opaque state echoed from a prior |
None
|
allow_input_required
|
bool
|
When |
False
|
Raises:
| Type | Description |
|---|---|
RuntimeError
|
If the server returns an |
Source code in src/mcp/client/session.py
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 | |
complete
async
complete(
ref: ResourceTemplateReference | PromptReference,
argument: dict[str, str],
context_arguments: dict[str, str] | None = None,
) -> CompleteResult
Send a completion/complete request.
Source code in src/mcp/client/session.py
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 | |
list_tools
async
list_tools(
*, params: PaginatedRequestParams | None = None
) -> ListToolsResult
Send a tools/list request.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
params
|
PaginatedRequestParams | None
|
Full pagination parameters including cursor and any future fields |
None
|
Source code in src/mcp/client/session.py
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 | |
send_roots_list_changed
async
send_roots_list_changed() -> None
Send a roots/list_changed notification.
Source code in src/mcp/client/session.py
1161 1162 1163 1164 | |
dispatch_input_request
async
dispatch_input_request(
ctx: ClientRequestContext, request: InputRequest
) -> InputResponse | ErrorData
Route an input request through the client's callback table.
Shared by the legacy server→client RPC path (_on_request) and the
2026-07-28 multi-round-trip driver, which dispatches the embedded
InputRequiredResult.input_requests through the same callbacks.
Returns the callback's InputResponse, or ErrorData when the callback declines.
Source code in src/mcp/client/session.py
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 | |