transport

Documentation

Overview

Package transport provides utilities for handling different transport modes for communication between the client and MCP server.

Package transport provides utilities for handling different transport modes for communication between the client and MCP server.

Index

• Constants
• Variables
• type Factory
  • func NewFactory() *Factory
  • func (*Factory) Create(config types.Config) (types.Transport, error)
• type HTTPTransport
  • func NewHTTPTransport(transportType types.TransportType, host string, port int, targetPort int, ...) *HTTPTransport
  • func (t *HTTPTransport) IsRunning(_ context.Context) (bool, error)
  • func (t *HTTPTransport) Mode() types.TransportType
  • func (t *HTTPTransport) Port() int
  • func (t *HTTPTransport) Setup(ctx context.Context, runtime rt.Runtime, containerName string, image string, ...) error
  • func (t *HTTPTransport) Start(ctx context.Context) error
  • func (t *HTTPTransport) Stop(ctx context.Context) error
• type StdioTransport
  • func NewStdioTransport(host string, port int, runtime rt.Runtime, debug bool, ...) *StdioTransport
  • func (t *StdioTransport) IsRunning(_ context.Context) (bool, error)
  • func (*StdioTransport) Mode() types.TransportType
  • func (t *StdioTransport) Port() int
  • func (t *StdioTransport) SetProxyMode(mode types.ProxyMode)
  • func (t *StdioTransport) Setup(ctx context.Context, runtime rt.Runtime, containerName string, image string, ...) error
  • func (t *StdioTransport) Start(ctx context.Context) error
  • func (t *StdioTransport) Stop(ctx context.Context) error
• type TransportError
  • func NewTransportError(err error, containerID, message string) *TransportError
  • func (e *TransportError) Error() string
  • func (e *TransportError) Unwrap() error

Constants

const (
	// LocalhostName is the standard hostname for localhost
	LocalhostName = "localhost"
	// LocalhostIPv4 is the standard IPv4 address for localhost
	LocalhostIPv4 = "127.0.0.1"
)

Variables

var (
	ErrUnsupportedTransport = errors.New("unsupported transport type")
	ErrTransportNotStarted  = errors.New("transport not started")
	ErrTransportClosed      = errors.New("transport closed")
	ErrInvalidMessage       = errors.New("invalid message")
	ErrRuntimeNotSet        = errors.New("container runtime not set")
	ErrContainerIDNotSet    = errors.New("container ID not set")
	ErrContainerNameNotSet  = errors.New("container name not set")
)

Common transport errors

Types

type Factory

type Factory struct{}

Factory creates transports

func NewFactory

func NewFactory() *Factory

NewFactory creates a new transport factory

func (*Factory) Create

func (*Factory) Create(config types.Config) (types.Transport, error)

Create creates a transport based on the provided configuration

type HTTPTransport

type HTTPTransport struct {
	// contains filtered or unexported fields
}

HTTPTransport implements the Transport interface using Server-Sent/Streamable Events.

func NewHTTPTransport

func NewHTTPTransport(
	transportType types.TransportType,
	host string,
	port int,
	targetPort int,
	runtime rt.Runtime,
	debug bool,
	targetHost string,
	prometheusHandler http.Handler,
	middlewares ...types.Middleware,
) *HTTPTransport

NewHTTPTransport creates a new HTTP transport.

func (*HTTPTransport) IsRunning

func (t *HTTPTransport) IsRunning(_ context.Context) (bool, error)

IsRunning checks if the transport is currently running.

func (*HTTPTransport) Mode

func (t *HTTPTransport) Mode() types.TransportType

Mode returns the transport mode.

func (*HTTPTransport) Port

func (t *HTTPTransport) Port() int

Port returns the port used by the transport.

func (*HTTPTransport) Setup

func (t *HTTPTransport) Setup(ctx context.Context, runtime rt.Runtime, containerName string, image string, cmdArgs []string,
	envVars, labels map[string]string, permissionProfile *permissions.Profile, k8sPodTemplatePatch string,
	isolateNetwork bool) error

Setup prepares the transport for use.

func (*HTTPTransport) Start

func (t *HTTPTransport) Start(ctx context.Context) error

Start initializes the transport and begins processing messages. The transport is responsible for starting the container.

func (*HTTPTransport) Stop

func (t *HTTPTransport) Stop(ctx context.Context) error

Stop gracefully shuts down the transport and the container.

type StdioTransport

type StdioTransport struct {
	// contains filtered or unexported fields
}

StdioTransport implements the Transport interface using standard input/output. It acts as a proxy between the MCP client and the container's stdin/stdout.

func NewStdioTransport

func NewStdioTransport(
	host string,
	port int,
	runtime rt.Runtime,
	debug bool,
	prometheusHandler http.Handler,
	middlewares ...types.Middleware,
) *StdioTransport

NewStdioTransport creates a new stdio transport.

func (*StdioTransport) IsRunning

func (t *StdioTransport) IsRunning(_ context.Context) (bool, error)

IsRunning checks if the transport is currently running.

func (*StdioTransport) Mode

func (*StdioTransport) Mode() types.TransportType

Mode returns the transport mode.

func (*StdioTransport) Port

func (t *StdioTransport) Port() int

Port returns the port used by the transport.

func (*StdioTransport) SetProxyMode

func (t *StdioTransport) SetProxyMode(mode types.ProxyMode)

SetProxyMode allows configuring the proxy mode (SSE or Streamable HTTP)

func (*StdioTransport) Setup

func (t *StdioTransport) Setup(
	ctx context.Context,
	runtime rt.Runtime,
	containerName string,
	image string,
	cmdArgs []string,
	envVars, labels map[string]string,
	permissionProfile *permissions.Profile,
	k8sPodTemplatePatch string,
	isolateNetwork bool,
) error

Setup prepares the transport for use.

func (*StdioTransport) Start

func (t *StdioTransport) Start(ctx context.Context) error

Start initializes the transport and begins processing messages. The transport is responsible for starting the container and attaching to it.

func (*StdioTransport) Stop

func (t *StdioTransport) Stop(ctx context.Context) error

Stop gracefully shuts down the transport and the container.

type TransportError

type TransportError struct {
	// Err is the underlying error
	Err error
	// ContainerID is the ID of the container
	ContainerID string
	// Message is an optional error message
	Message string
}

TransportError represents an error related to transport operations

func NewTransportError

func NewTransportError(err error, containerID, message string) *TransportError

NewTransportError creates a new transport error

func (*TransportError) Error

func (e *TransportError) Error() string

Error returns the error message

func (*TransportError) Unwrap

func (e *TransportError) Unwrap() error

Unwrap returns the underlying error