Rate this page:

ClientParameters

MCP.Client parameters. Can be passed as arguments to the MCP.createClient method.

Props

mcpServerConnectionConfig
Copy URL
mcpServerConnectionConfig: 

MCPServerConnectionConfig

The MCP server connection configuration.

onWebSocketClose
Optional
Copy URL
onWebSocketClose: 

(event: WebSocketEvents.CLOSE) => void

Optional. A callback function that is called when the WebSocket connection is closed.

privacy
Optional
Copy URL
privacy: 

boolean

Optional. Whether to enable the privacy functionality.

If privacy is enabled, the logging for the WebSocket connection is disabled.

NOTE: the default value is false.

statistics
Optional
Copy URL
statistics: 

boolean

Optional. Enables statistics functionality.

trace
Optional
Copy URL
trace: 

boolean

Optional. Whether to enable the tracing functionality.

If tracing is enabled, a URL to the trace file appears in the 'websocket.created' message. The file contains all sent and received WebSocket messages in the plain text format. The file is uploaded to the S3 storage.

NOTE: enable this only for diagnostic purposes. You can provide the trace file to our support team to help investigate issues.

Rate this page: