Skip to content

docs(client): complete the Args blocks in ClientSession #3848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lxcxjxhx wants to merge 1 commit into from
Closed

docs(client): complete the Args blocks in ClientSession #3848

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/mcp/client/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -548,7 +548,11 @@ async def send_request(
"""Send a request and wait for its typed result.

Args:
request: The request to send.
result_type: The expected result type, or a `TypeAdapter` for it.
request_read_timeout_seconds: Per-request read timeout in seconds.
metadata: Streamable HTTP resumption hints.
progress_callback: Called with progress notifications for this request.

Raises:
MCPError: Error response, read timeout, or connection closed.
Expand Down Expand Up @@ -942,8 +946,10 @@ async def read_resource(
"""Send a resources/read request.

Args:
uri: The resource URI to read.
input_responses: Responses to a prior `InputRequiredResult.input_requests`.
request_state: Opaque state echoed from a prior `InputRequiredResult`.
meta: Request metadata, forwarded as `_meta`.
allow_input_required: When `False` (default), an `InputRequiredResult`
from the server raises `RuntimeError`; when `True`, it is returned
so the caller can resolve the requests and retry.
Expand Down Expand Up @@ -1070,8 +1076,13 @@ async def call_tool(
the tool before calling it to enable header emission.

Args:
name: The tool name.
arguments: The tool arguments, or `None` for a tool that takes none.
read_timeout_seconds: Per-request read timeout in seconds.
progress_callback: Called with progress notifications for this call.
input_responses: Responses to a prior `InputRequiredResult.input_requests`.
request_state: Opaque state echoed from a prior `InputRequiredResult`.
meta: Request metadata, forwarded as `_meta`.
allow_input_required: When ``False`` (default), an `InputRequiredResult`
from the server raises `RuntimeError`; when ``True``, it is returned
so the caller can resolve the requests and retry.
Expand Down Expand Up @@ -1227,8 +1238,11 @@ async def get_prompt(
"""Send a prompts/get request.

Args:
name: The prompt name.
arguments: The prompt arguments, or `None` for a prompt that takes none.
input_responses: Responses to a prior `InputRequiredResult.input_requests`.
request_state: Opaque state echoed from a prior `InputRequiredResult`.
meta: Request metadata, forwarded as `_meta`.
allow_input_required: When `False` (default), an `InputRequiredResult`
from the server raises `RuntimeError`; when `True`, it is returned
so the caller can resolve the requests and retry.
Expand Down
Loading