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 MCP transport operations

Index

• Constants
• func GenerateMCPServerURL(transportType string, host string, port int, containerName, remoteURL string) string
• type Factory
  • func NewFactory() *Factory
  • func (*Factory) Create(config types.Config) (types.Transport, error)
• type HTTPTransport
  • func NewHTTPTransport(transportType types.TransportType, host string, proxyPort int, targetPort int, ...) *HTTPTransport
  • func (t *HTTPTransport) IsRunning(_ context.Context) (bool, error)
  • func (t *HTTPTransport) Mode() types.TransportType
  • func (t *HTTPTransport) ProxyPort() int
  • func (t *HTTPTransport) SetRemoteURL(remoteURL string)
  • func (t *HTTPTransport) SetTokenSource(tokenSource *oauth2.TokenSource)
  • func (t *HTTPTransport) Setup(ctx context.Context, runtime rt.Deployer, containerName string, image string, ...) error
  • func (t *HTTPTransport) Start(ctx context.Context) error
  • func (t *HTTPTransport) Stop(ctx context.Context) error
• type StdioBridge
  • func NewStdioBridge(name, rawURL string, mode types.TransportType) (*StdioBridge, error)
  • func (b *StdioBridge) Shutdown()
  • func (b *StdioBridge) Start(ctx context.Context)
• type StdioTransport
  • func NewStdioTransport(host string, proxyPort int, deployer rt.Deployer, debug bool, ...) *StdioTransport
  • func (t *StdioTransport) IsRunning(_ context.Context) (bool, error)
  • func (*StdioTransport) Mode() types.TransportType
  • func (t *StdioTransport) ProxyPort() int
  • func (t *StdioTransport) SetProxyMode(mode types.ProxyMode)
  • func (t *StdioTransport) Setup(ctx context.Context, runtime rt.Deployer, containerName string, image string, ...) error
  • func (t *StdioTransport) Start(ctx context.Context) error
  • func (t *StdioTransport) Stop(ctx context.Context) 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"
)

Functions

func GenerateMCPServerURL

func GenerateMCPServerURL(transportType string, host string, port int, containerName, remoteURL string) string

GenerateMCPServerURL generates the URL for an MCP server. If remoteURL is provided, the remote server's path will be used as the path of the proxy. For SSE/STDIO transports, a "#<containerName>" fragment is appended. For StreamableHTTP, no fragment is appended.

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,
	proxyPort int,
	targetPort int,
	deployer rt.Deployer,
	debug bool,
	targetHost string,
	authInfoHandler http.Handler,
	prometheusHandler http.Handler,
	middlewares ...types.MiddlewareFunction,
) *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) ProxyPort

func (t *HTTPTransport) ProxyPort() int

ProxyPort returns the proxy port used by the transport.

func (*HTTPTransport) SetRemoteURL

func (t *HTTPTransport) SetRemoteURL(remoteURL string)

SetRemoteURL sets the remote URL for the MCP server

func (*HTTPTransport) SetTokenSource

func (t *HTTPTransport) SetTokenSource(tokenSource *oauth2.TokenSource)

SetTokenSource sets the OAuth token source for remote authentication

func (*HTTPTransport) Setup

func (t *HTTPTransport) Setup(
	ctx context.Context,
	runtime rt.Deployer,
	containerName string,
	image string,
	cmdArgs []string,
	envVars map[string]string,
	labels map[string]string,
	permissionProfile *permissions.Profile,
	k8sPodTemplatePatch string,
	isolateNetwork bool,
	ignoreConfig *ignore.Config,
) 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 StdioBridge

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

StdioBridge connects stdin/stdout to a target MCP server using the specified transport type.

func NewStdioBridge

func NewStdioBridge(name, rawURL string, mode types.TransportType) (*StdioBridge, error)

NewStdioBridge creates a new StdioBridge instance for the given target URL and transport type.

func (*StdioBridge) Shutdown

func (b *StdioBridge) Shutdown()

Shutdown gracefully stops the bridge, closing connections and waiting for cleanup.

func (*StdioBridge) Start

func (b *StdioBridge) Start(ctx context.Context)

Start initializes the bridge and connects to the upstream MCP server.

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,
	proxyPort int,
	deployer rt.Deployer,
	debug bool,
	prometheusHandler http.Handler,
	middlewares ...types.MiddlewareFunction,
) *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) ProxyPort

func (t *StdioTransport) ProxyPort() int

ProxyPort returns the proxy 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.Deployer,
	containerName string,
	image string,
	cmdArgs []string,
	envVars, labels map[string]string,
	permissionProfile *permissions.Profile,
	k8sPodTemplatePatch string,
	isolateNetwork bool,
	ignoreConfig *ignore.Config,
) 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.