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
34 35 36 37 38 39 40 | |
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.
Source code in src/mcp/client/session.py
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 | |
send_request
async
send_request(
request: ClientRequest,
result_type: type[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. |
Source code in src/mcp/client/session.py
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 | |
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
249 250 251 252 253 254 255 256 | |
initialize_result
property
initialize_result: InitializeResult | None
The server's InitializeResult. None until initialize() has been called.
Contains server_info, capabilities, instructions, and the negotiated protocol_version.
send_ping
async
send_ping(
*, meta: RequestParamsMeta | None = None
) -> EmptyResult
Send a ping request.
Source code in src/mcp/client/session.py
311 312 313 | |
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
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 | |
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
337 338 339 340 341 342 343 344 345 346 347 | |
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
349 350 351 352 353 354 355 | |
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
357 358 359 360 361 362 363 364 365 366 367 368 | |
read_resource
async
read_resource(
uri: str, *, meta: RequestParamsMeta | None = None
) -> ReadResourceResult
Send a resources/read request.
Source code in src/mcp/client/session.py
370 371 372 373 374 375 | |
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
377 378 379 380 381 382 | |
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
384 385 386 387 388 389 | |
call_tool
async
call_tool(
name: str,
arguments: dict[str, Any] | None = None,
read_timeout_seconds: float | None = None,
progress_callback: ProgressFnT | None = None,
*,
meta: RequestParamsMeta | None = None
) -> CallToolResult
Send a tools/call request with optional progress callback support.
Source code in src/mcp/client/session.py
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 | |
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
440 441 442 443 444 445 446 | |
get_prompt
async
get_prompt(
name: str,
arguments: dict[str, str] | None = None,
*,
meta: RequestParamsMeta | None = None
) -> GetPromptResult
Send a prompts/get request.
Source code in src/mcp/client/session.py
448 449 450 451 452 453 454 455 456 457 458 459 | |
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
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 | |
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
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 | |
send_roots_list_changed
async
send_roots_list_changed() -> None
Send a roots/list_changed notification.
Source code in src/mcp/client/session.py
501 502 503 | |