ws

package

v1.2.2 Latest Latest Go to latest Published: May 21, 2025 License: MIT Imports: 10 Imported by: 0

Details

Package ws provides a WebSocket implementation of the MCP transport.

This package implements the Transport interface using WebSockets, suitable for web applications requiring bidirectional communication.

View Source

const DefaultShutdownTimeout = 10 * time.Second

DefaultShutdownTimeout is the default timeout for graceful shutdown

View Source

const DefaultWSPath = "/ws"

DefaultWSPath is the default endpoint path for WebSocket connections

This section is empty.

This section is empty.

type Transport struct {
	transport.BaseTransport
	// contains filtered or unexported fields
}

Transport implements the transport.Transport interface for WebSocket

func NewTransport(addr string) *Transport

NewTransport creates a new WebSocket transport

func (t *Transport) GetFullWSPath() string

GetFullWSPath returns the complete path for the WebSocket endpoint

func (t *Transport) Initialize() error

Initialize initializes the transport

func (t *Transport) Receive() ([]byte, error)

Receive receives a message (client mode only)

func (t *Transport) Send(message []byte) error

Send sends a message

func (t *Transport) SetPathPrefix(prefix string) *Transport

SetPathPrefix sets a prefix for the endpoint path For example, SetPathPrefix("/mcp") will result in endpoint like "/mcp/ws"

func (t *Transport) SetWSPath(path string) *Transport

SetWSPath sets the path for the WebSocket endpoint

func (t *Transport) Start() error

Start starts the transport

func (t *Transport) Stop() error

Stop stops the transport