Spaces:
Sleeping
Sleeping
| --- | |
| title: messages | |
| sidebarTitle: messages | |
| --- | |
| # `fastmcp.client.messages` | |
| ## Classes | |
| ### `MessageHandler` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L16" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| This class is used to handle MCP messages sent to the client. It is used to handle all messages, | |
| requests, notifications, and exceptions. Users can override any of the hooks | |
| **Methods:** | |
| #### `dispatch` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L30" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| dispatch(self, message: Message) -> None | |
| ``` | |
| #### `on_message` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L74" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| on_message(self, message: Message) -> None | |
| ``` | |
| #### `on_request` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L77" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| on_request(self, message: RequestResponder[mcp.types.ServerRequest, mcp.types.ClientResult]) -> None | |
| ``` | |
| #### `on_ping` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L82" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| on_ping(self, message: mcp.types.PingRequest) -> None | |
| ``` | |
| #### `on_list_roots` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| on_list_roots(self, message: mcp.types.ListRootsRequest) -> None | |
| ``` | |
| #### `on_create_message` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L88" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| on_create_message(self, message: mcp.types.CreateMessageRequest) -> None | |
| ``` | |
| #### `on_notification` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L91" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| on_notification(self, message: mcp.types.ServerNotification) -> None | |
| ``` | |
| #### `on_exception` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L94" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| on_exception(self, message: Exception) -> None | |
| ``` | |
| #### `on_progress` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L97" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| on_progress(self, message: mcp.types.ProgressNotification) -> None | |
| ``` | |
| #### `on_logging_message` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L100" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| on_logging_message(self, message: mcp.types.LoggingMessageNotification) -> None | |
| ``` | |
| #### `on_tool_list_changed` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L105" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| on_tool_list_changed(self, message: mcp.types.ToolListChangedNotification) -> None | |
| ``` | |
| #### `on_resource_list_changed` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L110" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| on_resource_list_changed(self, message: mcp.types.ResourceListChangedNotification) -> None | |
| ``` | |
| #### `on_prompt_list_changed` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L115" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| on_prompt_list_changed(self, message: mcp.types.PromptListChangedNotification) -> None | |
| ``` | |
| #### `on_resource_updated` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L120" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| on_resource_updated(self, message: mcp.types.ResourceUpdatedNotification) -> None | |
| ``` | |
| #### `on_cancelled` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/messages.py#L125" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| on_cancelled(self, message: mcp.types.CancelledNotification) -> None | |
| ``` | |