transport

Documentation

Overview

Package transport contains implementatations for different transport options for MCP.

Index

• type Error
• type HTTP
  • func NewHTTP(address string) (*HTTP, error)
  • func (t *HTTP) Execute(method string, params any) (map[string]any, error)
• type Request
• type Response
  • func ParseResponse(r io.Reader) (*Response, error)
• type Stdio
  • func NewStdio(command []string) *Stdio
  • func (t *Stdio) Execute(method string, params any) (map[string]any, error)
  • func (t *Stdio) SetCloseAfterExecute(v bool)
  • func (t *Stdio) SetShowServerLogs(v bool)
• type Transport

Types

type Error

type Error struct {
	Message string `json:"message"`
	Code    int    `json:"code"`
}

Error represents a JSON-RPC 2.0 error.

type HTTP

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

HTTP implements the Transport interface by communicating with a MCP server over HTTP using JSON-RPC.

func NewHTTP

func NewHTTP(address string) (*HTTP, error)

NewHTTP creates a new Http transport that will execute the given command. It communicates with the command using JSON-RPC over HTTP. Currently Http transport is implements MCP's Final draft version 2024-11-05, https://spec.modelcontextprotocol.io/specification/2024-11-05/basic/transports/#http-with-sse

func (*HTTP) Execute

func (t *HTTP) Execute(method string, params any) (map[string]any, error)

Execute implements the Transport via JSON-RPC over HTTP.

type Request

type Request struct {
	Params  any    `json:"params,omitempty"`
	JSONRPC string `json:"jsonrpc"`
	Method  string `json:"method"`
	ID      int    `json:"id,omitempty"`
}

Request represents a JSON-RPC 2.0 request.

type Response

type Response struct {
	Result  map[string]any `json:"result,omitempty"`
	Error   *Error         `json:"error,omitempty"`
	JSONRPC string         `json:"jsonrpc"`
	ID      int            `json:"id"`
}

Response represents a JSON-RPC 2.0 response.

func ParseResponse

func ParseResponse(r io.Reader) (*Response, error)

ParseResponse reads and parses a JSON-RPC response from a reader.

type Stdio

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

Stdio implements the Transport interface by executing a command and communicating with it via stdin/stdout using JSON-RPC.

func NewStdio

func NewStdio(command []string) *Stdio

NewStdio creates a new Stdio transport that will execute the given command. It communicates with the command using JSON-RPC over stdin/stdout.

func (*Stdio) Execute

func (t *Stdio) Execute(method string, params any) (map[string]any, error)

Execute implements the Transport interface by spawning a subprocess and communicating with it via JSON-RPC over stdin/stdout.

func (*Stdio) SetCloseAfterExecute

func (t *Stdio) SetCloseAfterExecute(v bool)

SetCloseAfterExecute toggles whether the underlying process should be closed or kept alive after each call to Execute.

func (*Stdio) SetShowServerLogs

func (t *Stdio) SetShowServerLogs(v bool)

SetShowServerLogs toggles whether to print server logs.

type Transport

type Transport interface {
	Execute(method string, params any) (map[string]any, error)
}

Transport defines the interface for communicating with MCP servers. Implementations should handle the specifics of communication protocols.