ik dZddlmZddlmZmZmZddlZddlZddl m Z m Z ddl m Z ddlmZddlmZddlmZdd lmZmZdd lmZdd lmZdd lmZmZdd lmZm Z ddl!m"Z"GddeZ#eddZ$e ejJejLfejNze(zZ)GddeejTejVejLejJejNfZ,y)a ServerSession Module This module provides the ServerSession class, which manages communication between the server and client in the MCP (Model Context Protocol) framework. It is most commonly used in MCP servers to interact with the client. Common usage pattern: ``` server = Server(name) @server.call_tool() async def handle_tool_call(ctx: RequestContext, arguments: dict[str, Any]) -> Any: # Check client capabilities before proceeding if ctx.session.check_client_capability( types.ClientCapabilities(experimental={"advanced_tools": dict()}) ): # Perform advanced tool operations result = await perform_advanced_tool_operation(arguments) else: # Fall back to basic tool operations result = await perform_basic_tool_operation(arguments) return result @server.list_prompts() async def handle_list_prompts(ctx: RequestContext) -> list[types.Prompt]: # Access session for any necessary checks or operations if ctx.session.client_params: # Customize prompts based on client initialization parameters return generate_custom_prompts(ctx.session.client_params) else: return default_prompts ``` The ServerSession class is typically used internally by the Server class and should not be instantiated directly by users of the MCP framework. )Enum)AnyTypeVaroverloadN)MemoryObjectReceiveStreamMemoryObjectSendStream)AnyUrl)!ExperimentalServerSessionFeatures)InitializationOptions)validate_sampling_tools!validate_tool_use_result_messages)check_tasks_capability)RELATED_TASK_METADATA_KEY)ServerMessageMetadataSessionMessage) BaseSessionRequestResponder)SUPPORTED_PROTOCOL_VERSIONSceZdZdZdZdZy)InitializationStateN)__name__ __module__ __qualname__NotInitialized Initializing InitializedR/root/aria/mcps/aria-brain/venv/lib/python3.12/site-packages/mcp/server/session.pyrr>sNLKr!rServerSessionT ServerSession)boundc^ eZdZUejZeed<dZejdzed<dZ e dzed< dEde e ezdee deded df fd Zed ejdzfd Zed e fd Zd ej,d efdZdFfd Zdeej4ej6ffdZdej:d dfdZ dGdej>de de!dzdejDdzd df dZ#de$d dfdZ%e&dddddddddd de'ejPde)de!dzdejTdzd e+dzd!e'e!dzd"e,e!e fdzd#ejZdzd$dd%ej\dzdejDdzd ej^fd&Z0e&ddddddddd'de'ejPde)de!dzdejTdzd e+dzd!e'e!dzd"e,e!e fdzd#ejZdzd$e'ejbd%ej\dzdejDdzd ejdfd(Z0dddddddddd de'ejPde)de!dzdejTdzd e+dzd!e'e!dzd"e,e!e fdzd#ejZdzd$e'ejbdzd%ej\dzdejDdzd ej^ejdzfd)Z0d ejffd*Z4 dHd+e!d,ejjdejDdzd ejlfd-Z7 dHd+e!d,ejjdejDdzd ejlfd.Z8 dHd+e!d/e!d0e!dejDdzd ejlf d1Z9d ejtfd2Z; dId3e!e)zd4e+d5e+dzd+e!dzde!dzd df d6ZdFd9Z? dHd0e!dejDdzd dfd:Z@ dGd+e!d,ejjd;e!dzdZDddddddddddd? de'ejPde)de!dzdejTdzd e+dzd!e'e!dzd"e,e!e fdzd#ejZdzd$e'ejbdzd%ej\dzd;e!dzdz(ServerSession.__init__..hsT5Y5Y5`5`5br!)super__init__types ClientRequestClientNotificationrrr_initialization_state _init_optionsanyiocreate_memory_object_streamServerRequestResponder_incoming_message_stream_writerr2 _exit_stackpush_async_callback)r5r*r+r,r- __class__s` r"r8zServerSession.__init__Xs lE4G4GIaIab/8  + +>Q>`>` "*UZUvUv "V V R,d.R ,,-bcr!c|jSr1)r(r4s r" client_paramszServerSession.client_paramsjs"""r!cR|jt||_|jS)uExperimental APIs for server→client task operations. WARNING: These APIs are experimental and may change without notice. )r)r r4s r" experimentalzServerSession.experimentalns)  & & .*KD*QD '***r! capabilityc|jy|jj}|j:|jy|jjr|jjsy|jg|jy|jj |jj y|jj |jj y|j |jy|jQ|jy|jjD]'\}}||jvs|j||k7s'y|j.|jyt|j|jsyy)z3Check if the client supports a specific capability.FT) r( capabilitiesroots listChangedsamplingcontexttools elicitationrHitemstasksr)r5rI client_capsexp_key exp_values r"check_client_capabilityz%ServerSession.check_client_capabilityxsz    &))66    '  (++K4E4E4Q4Q    *##+""**6;;O;O;W;W;_""((49M9M9S9S9[  ! ! -+2I2I2Q  " " .''/&0&=&=&C&C&E !"+":"::k>V>VW^>_cl>l  !    '  ()**:*:K,>,M,M/3/A/A/M/M*.*<*<*B*B ," .2-?-?-L-L $.A-L-L*-8.""$%--1D1P1PP&'\]]Q-s2AF4C&F(F&F(A F4&F((F1-F4 notificationcKtjjd{|jtj dx\t j|_y |jt jk7r tdy7ew)Nr z8Received notification before initialization was complete) r>lowlevel checkpointrfr9InitializedNotificationrrr<rq)r5rts r"_received_notificationz$ServerSession._received_notificationssnn'')))..0-@-L-L*1--1D1P1PP&'abbQ *s"B B A&B leveldataloggerrelated_request_idc K|jtjtjtj||||d{y7w)z Send a log message notification.)rzr{r|r\N)send_notificationr9ServerNotificationLoggingMessageNotification LoggingMessageNotificationParams)r5rzr{r|r}s r"send_log_messagezServerSession.send_log_messagesX$$  $ $00 AA#!%    sAAAAuric K|jtjtjtj|d{y7w)z%Send a resource updated notification.)rr\N)rr9rResourceUpdatedNotification!ResourceUpdatedNotificationParams)r5rs r"send_resource_updatedz#ServerSession.send_resource_updatedsH$$  $ $11 BBsK    sAAAA) system_promptinclude_context temperaturestop_sequencesmetadatamodel_preferencesrP tool_choicer}messages max_tokensrrrrrrrPrc  Kyw)z0Overload: Without tools, returns single content.Nr r5rrrrrrrrrPrr}s r"create_messagezServerSession.create_message " )rrrrrrrr}c  Kyw)z4Overload: With tools, returns array-capable content.Nr rs r"rzServerSession.create_messagerrc K|jr|jjnd} t| | | t|t j t j t j||||||||| |  } t| }| *|j| tj|d{S|j| tj|d{S7.7w)aSend a sampling/create_message request. Args: messages: The conversation messages to send. max_tokens: Maximum number of tokens to generate. system_prompt: Optional system prompt. include_context: Optional context inclusion setting. Should only be set to "thisServer" or "allServers" if the client has sampling.context capability. temperature: Optional sampling temperature. stop_sequences: Optional stop sequences. metadata: Optional metadata to pass through to the LLM provider. model_preferences: Optional model selection preferences. tools: Optional list of tools the LLM can use during sampling. Requires client to have sampling.tools capability. tool_choice: Optional control over tool usage behavior. Requires client to have sampling.tools capability. related_request_id: Optional ID of a related request. Returns: The sampling result from the client. Raises: McpError: If tools are provided but client doesn't support them. ValueError: If tool_use or tool_result message structure is invalid. N) r systemPromptincludeContextr maxTokens stopSequencesrmodelPreferencesrP toolChoicer\r})re result_typer) r(rKr r r9 ServerRequestCreateMessageRequestCreateMessageRequestParamsr send_requestCreateMessageResultWithToolsCreateMessageResult)r5rrrrrrrrrPrr}rTre metadata_objs r"rzServerSession.create_messagesR;?:M:Md))66SW  UK@)(3%%  & &77%!.#2 +("0%%6*    -@RS   **!>>%+  &&11!'     s$B6C+8C'9)C+"C)#C+)C+cK|jtjtjtjd{S7w)zSend a roots/list request.N)rr9rListRootsRequestListRootsResultr4s r" list_rootszServerSession.list_roots^sC&&    6 6 8 9  ! !    A A A AmessagerequestedSchemacDK|j|||d{S7w)aSend a form mode elicitation/create request. Args: message: The message to present to the user requestedSchema: Schema defining the expected response structure related_request_id: Optional ID of the request that triggered this elicitation Returns: The client's response Note: This method is deprecated in favor of elicit_form(). It remains for backward compatibility but new code should use elicit_form(). N) elicit_formr5rrr}s r"elicitzServerSession.elicites$(%%g@RSSSSs   c K|jtjtjtj||tj t |d{S7w)agSend a form mode elicitation/create request. Args: message: The message to present to the user requestedSchema: Schema defining the expected response structure related_request_id: Optional ID of the request that triggered this elicitation Returns: The client's response with form data )rrr\rrN)rr9r ElicitRequestElicitRequestFormParams ElicitResultrrs r"rzServerSession.elicit_form{sn &&   ## 88 '(7    *>PQ'    sA,A5.A3/A5urlelicitation_idc K|jtjtjtj|||tj t |d{S7w)akSend a URL mode elicitation/create request. This directs the user to an external URL for out-of-band interactions like OAuth flows, credential collection, or payment processing. Args: message: Human-readable explanation of why the interaction is needed url: The URL the user should navigate to elicitation_id: Unique identifier for tracking this elicitation related_request_id: Optional ID of the request that triggered this elicitation Returns: The client's response indicating acceptance, decline, or cancellation rr elicitationIdr\rrN)rr9rrElicitRequestURLParamsrr)r5rrrr}s r" elicit_urlzServerSession.elicit_urlsq*&&   ## 77 '&4    *>PQ'    sA-A6/A40A6cK|jtjtjtjd{S7w)zSend a ping request.N)rr9rrp EmptyResultr4s r" send_pingzServerSession.send_pingsC&&    1 1 3 4       rprogress_tokenprogresstotalc K|jtjtjtj|||||d{y7w)zSend a progress notification.) progressTokenrrrr\N)rr9rProgressNotificationProgressNotificationParams)r5rrrrr}s r"send_progress_notificationz(ServerSession.send_progress_notifications[$$  $ $** ;;&4!)# '     sAAAAcK|jtjtjd{y7w)z*Send a resource list changed notification.N)rr9rResourceListChangedNotificationr4s r"send_resource_list_changedz(ServerSession.send_resource_list_changeds.$$U%=%=e>c>c>e%fggg:AAAcK|jtjtjd{y7w)z&Send a tool list changed notification.N)rr9rToolListChangedNotificationr4s r"send_tool_list_changedz$ServerSession.send_tool_list_changeds.$$U%=%=e>_>_>a%bcccrcK|jtjtjd{y7w)z(Send a prompt list changed notification.N)rr9rPromptListChangedNotificationr4s r"send_prompt_list_changedz&ServerSession.send_prompt_list_changeds.$$U%=%=e>a>a>c%deeerc K|jtjtjtj||d{y7w)aSend an elicitation completion notification. This should be sent when a URL mode elicitation has been completed out-of-band to inform the client that it may retry any requests that were waiting for this elicitation. Args: elicitation_id: The unique identifier of the completed elicitation related_request_id: Optional ID of the request that triggered this )rr\N)rr9rElicitCompleteNotification ElicitCompleteNotificationParams)r5rr}s r"send_elicit_completez"ServerSession.send_elicit_completesP$$  $ $00 AAP^_      sAAAArelated_task_idtaskcntj|||}|jddd}|9d|vri|d<tj|jd|dt<|rd|d t |n |j }||xj d z c_tjd |d | S)aBuild a form mode elicitation request without sending it. Args: message: The message to present to the user requestedSchema: Schema defining the expected response structure related_task_id: If provided, adds io.modelcontextprotocol/related-task metadata task: If provided, makes this a task-augmented request Returns: A JSONRPCRequest ready to be sent or queued )rrrTjsonby_aliasmode exclude_none_metataskIdrtask--r2.0elicitation/createjsonrpcidmethodr])r9r model_dumpRelatedTaskMetadatarr _request_idJSONRPCRequest)r5rrrrr] params_data request_ids r"_build_elicit_form_requestz(ServerSession._build_elicit_form_requests$..+  ''FQU'V   &k)') G$>C>W>W&?j$j'  !: ;@Ou_-Qr&zl;TXTdTd  "    ! ##'   r!cntj|||}|jddd}|9d|vri|d<tj|jd|dt<|rd|d t |n |j }||xj d z c_tjd |d | S)aBuild a URL mode elicitation request without sending it. Args: message: Human-readable explanation of why the interaction is needed url: The URL the user should navigate to elicitation_id: Unique identifier for tracking this elicitation related_task_id: If provided, adds io.modelcontextprotocol/related-task metadata Returns: A JSONRPCRequest ready to be sent or queued rTrrrrrrrrrrr)r9rrrrrrr)r5rrrrr]rrs r"_build_elicit_url_requestz'ServerSession._build_elicit_url_request*s$--(  ''FQU'V   &k)') G$>C>W>W&?j$j'  !: ;@Ou_-Qr&zl;TXTdTd  "    ! ##'   r!) rrrrrrrPrrrc ~tj||||||||| | |  } | jddd}| 9d|vri|d<tj| jd|dt<| rd| d t | n |j }| |xj d z c_tjd |d | S)aBuild a sampling/createMessage request without sending it. Args: messages: The conversation messages to send max_tokens: Maximum number of tokens to generate system_prompt: Optional system prompt include_context: Optional context inclusion setting temperature: Optional sampling temperature stop_sequences: Optional stop sequences metadata: Optional metadata to pass through to the LLM provider model_preferences: Optional model selection preferences tools: Optional list of tools the LLM can use during sampling tool_choice: Optional control over tool usage behavior related_task_id: If provided, adds io.modelcontextprotocol/related-task metadata task: If provided, makes this a task-augmented request Returns: A JSONRPCRequest ready to be sent or queued ) rrrrrrrrrPrrTrrrrrrrrrzsampling/createMessager)r9rrrrrrr)r5rrrrrrrrrPrrrr]rrs r"_build_create_message_requestz+ServerSession._build_create_message_requestWsF11&*# (."  ''FQU'V   &k)') G$>C>W>W&?j$j'  !: ;@Ou_-Qr&zl;TXTdTd  "    ! ##+   r!cVK|jj|d{y7w)aSend a raw session message. This is primarily used by TaskResultHandler to deliver queued messages (elicitation/sampling requests) to the client during task execution. WARNING: This is a low-level experimental method that may change without notice. Prefer using higher-level methods like send_notification() or send_request() for normal operations. Args: message: The session message to send N) _write_streamsend)r5rs r" send_messagezServerSession.send_messages"  %%g... )')reqcVK|jj|d{y7wr1)rAr)r5rs r"_handle_incomingzServerSession._handle_incomings 2277<<anyio.lowlevelanyio.streams.memoryrrpydanticr mcp.typesr9(mcp.server.experimental.session_featuresr mcp.server.modelsr mcp.server.validationr r *mcp.shared.experimental.tasks.capabilitiesr%mcp.shared.experimental.tasks.helpersrmcp.shared.messagerrmcp.shared.sessionrrmcp.shared.versionrrr#r:rir;rr@rrr$r r!r"r%s%N)) RV3\MKD;$ )AU((%*<*<<=@X@XX[dd h 4          "h 4r!