Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mcp-use.com/llms.txt

Use this file to discover all available pages before exploring further.

View the source code for this module on GitHub: https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp_use/client/connectors/websocket.py
WebSocket connector for MCP implementations. This module provides a connector for communicating with MCP implementations through WebSocket connections.

​
WebSocketConnector

from mcp_use.client.connectors.websocket import WebSocketConnector

​
method init

Initialize a new WebSocket connector.Parameters
​
url
str
required
The WebSocket URL to connect to.
​
headers
dict[str, str] | None
default:"None"
Optional additional headers.
​
auth
str | dict[str, typing.Any] | httpx.Auth | None
default:"None"
Authentication method - can be:
Signature
def __init__(url: str, headers: dict[str, str] | None = None, auth: str | dict[str, typing.Any] | httpx.Auth | None = None):

​
method request

Send a raw request to the MCP implementation.Parameters
​
method
str
required
String value
​
params
dict[str, typing.Any] | None
default:"None"
Dictionary of key-value pairs
Returns
​
returns
Any
Signature
def request(method: str, params: dict[str, typing.Any] | None = None):