httptransport

package
v1.0.178 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 11, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package httptransport implements stateless HTTP transports for MCP: a server transport that accepts JSON-RPC requests on an endpoint, and a client transport that posts them.

Server

HTTPTransport implements both transport.Transport and http.Handler. Prefer mounting it on your own server so it inherits your middleware, TLS and address:

tr := httptransport.NewHTTPTransport("/mcp")
srv := mcp.NewServer(tr)
if err := srv.Serve(); err != nil {
    return err
}

mux := http.NewServeMux()
mux.Handle("/mcp", tr)

HTTPTransport.Start is the standalone alternative: it creates its own http.Server on the address set by HTTPTransport.WithAddr (":8080" by default) and blocks in ListenAndServe.

Client

tr := httptransport.NewHTTPClientTransport("/mcp").
    WithBaseURL("https://example.com").
    WithHeader("Authorization", "Bearer "+token)

cli := mcp.NewClient(tr)
if _, err := cli.Initialize(ctx); err != nil {
    return err
}

Supply a custom HTTP client with HTTPClientTransport.WithClient to add timeouts, retries or instrumentation.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type HTTPClient

type HTTPClient interface {
	Do(r *http.Request) (*http.Response, error)
}

type HTTPClientTransport

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

HTTPClientTransport implements a client-side HTTP transport for MCP

func NewHTTPClientTransport

func NewHTTPClientTransport(endpoint string) *HTTPClientTransport

NewHTTPClientTransport creates a new HTTP client transport that connects to the specified endpoint

func (*HTTPClientTransport) Close

func (t *HTTPClientTransport) Close() error

Close implements Transport.Close

func (*HTTPClientTransport) Send

Send implements Transport.Send

func (*HTTPClientTransport) SetCloseHandler

func (t *HTTPClientTransport) SetCloseHandler(handler func())

SetCloseHandler implements Transport.SetCloseHandler

func (*HTTPClientTransport) SetErrorHandler

func (t *HTTPClientTransport) SetErrorHandler(handler func(error))

SetErrorHandler implements Transport.SetErrorHandler

func (*HTTPClientTransport) SetMessageHandler

func (t *HTTPClientTransport) SetMessageHandler(handler func(ctx context.Context, message *transport.BaseJsonRpcMessage))

SetMessageHandler implements Transport.SetMessageHandler

func (*HTTPClientTransport) Start

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

Start implements Transport.Start

func (*HTTPClientTransport) WithBaseURL

func (t *HTTPClientTransport) WithBaseURL(baseURL string) *HTTPClientTransport

WithBaseURL sets the base URL to connect to

func (*HTTPClientTransport) WithClient

WithClient allows to set a custom HTTP client

func (*HTTPClientTransport) WithHeader

func (t *HTTPClientTransport) WithHeader(key, value string) *HTTPClientTransport

WithHeader adds a header to the request

type HTTPTransport

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

HTTPTransport implements a stateless HTTP transport for MCP

func NewHTTPTransport

func NewHTTPTransport(endpoint string) *HTTPTransport

NewHTTPTransport creates a new HTTP transport that listens on the specified endpoint

func (*HTTPTransport) Close

func (t *HTTPTransport) Close() error

Close implements Transport.Close

func (*HTTPTransport) Send

Send implements Transport.Send

func (*HTTPTransport) ServeHTTP added in v0.16.125

func (t *HTTPTransport) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements http.Handler, allowing HTTPTransport to be used directly

func (*HTTPTransport) SetCloseHandler

func (t *HTTPTransport) SetCloseHandler(handler func())

SetCloseHandler implements Transport.SetCloseHandler

func (*HTTPTransport) SetErrorHandler

func (t *HTTPTransport) SetErrorHandler(handler func(error))

SetErrorHandler implements Transport.SetErrorHandler

func (*HTTPTransport) SetMessageHandler

func (t *HTTPTransport) SetMessageHandler(handler func(ctx context.Context, message *transport.BaseJsonRpcMessage))

SetMessageHandler implements Transport.SetMessageHandler

func (*HTTPTransport) Start

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

Start implements Transport.Start

func (*HTTPTransport) WithAddr

func (t *HTTPTransport) WithAddr(addr string) *HTTPTransport

WithAddr sets the address to listen on

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址