mcp

package

Go to main page

Versions in this module

v0

v0.35.0

Jul 11, 2025

Changes in this version

+ type CallToolParamsFor struct

+ Arguments In

+ Meta Meta

+ Name string

+ func (x *CallToolParamsFor[In]) GetMeta() *Meta

+ type CallToolResultFor struct

+ Content []*Content

+ IsError bool

+ Meta Meta

+ func (x *CallToolResultFor[Out]) GetMeta() *Meta

type ClientOptions

+ ProgressNotificationHandler func(context.Context, *ClientSession, *ProgressNotificationParams)

type ClientSession

+ func (cs *ClientSession) ListResourceTemplates(ctx context.Context, params *ListResourceTemplatesParams) (*ListResourceTemplatesResult, error)

+ func (cs *ClientSession) NotifyProgress(ctx context.Context, params *ProgressNotificationParams) error

+ func (cs *ClientSession) ResourceTemplates(ctx context.Context, params *ListResourceTemplatesParams) iter.Seq2[*ResourceTemplate, error]

+ type Connection interface

+ Close func() error

+ Read func(context.Context) (JSONRPCMessage, error)

+ Write func(context.Context, JSONRPCMessage) error

+ type JSONRPCID = jsonrpc2.ID

+ type JSONRPCMessage = jsonrpc2.Message

+ type JSONRPCRequest = jsonrpc2.Request

+ type JSONRPCResponse = jsonrpc2.Response

+ type ListResourceTemplatesParams struct

+ Cursor string

+ Meta Meta

+ func (x *ListResourceTemplatesParams) GetMeta() *Meta

+ type ListResourceTemplatesResult struct

+ Meta Meta

+ NextCursor string

+ ResourceTemplates []*ResourceTemplate

+ func (x *ListResourceTemplatesResult) GetMeta() *Meta

+ type ProgressNotificationParams struct

+ Message string

+ Meta Meta

+ Progress float64

+ ProgressToken any

+ Total float64

+ func (x *ProgressNotificationParams) GetMeta() *Meta

+ type ResourceTemplate struct

+ Annotations *Annotations

+ Description string

+ MIMEType string

+ Name string

+ URITemplate string

+ type SSEClientTransportOptions struct

+ HTTPClient *http.Client

type Server

+ func (s *Server) AddResourceTemplates(templates ...*ServerResourceTemplate)

+ func (s *Server) RemoveResourceTemplates(uriTemplates ...string)

type ServerOptions

+ ProgressNotificationHandler func(context.Context, *ServerSession, *ProgressNotificationParams)

+ type ServerResourceTemplate struct

+ Handler ResourceHandler

+ ResourceTemplate *ResourceTemplate

+ func (sr *ServerResourceTemplate) Matches(uri string) bool

type ServerSession

+ func (ss *ServerSession) NotifyProgress(ctx context.Context, params *ProgressNotificationParams) error

type ServerTool

+ func NewServerTool[In, Out any](name, description string, handler ToolHandlerFor[In, Out], opts ...ToolOption) *ServerTool

+ type StdioTransport struct

+ func NewStdioTransport() *StdioTransport

+ func (t *StdioTransport) Connect(context.Context) (Connection, error)

+ type StreamableClientTransport struct

+ func NewStreamableClientTransport(url string, opts *StreamableClientTransportOptions) *StreamableClientTransport

+ func (t *StreamableClientTransport) Connect(ctx context.Context) (Connection, error)

+ type StreamableClientTransportOptions struct

+ HTTPClient *http.Client

+ type StreamableHTTPHandler struct

+ func NewStreamableHTTPHandler(getServer func(*http.Request) *Server, opts *StreamableHTTPOptions) *StreamableHTTPHandler

+ func (h *StreamableHTTPHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type StreamableHTTPOptions struct

+ type StreamableServerTransport struct

+ func NewStreamableServerTransport(sessionID string) *StreamableServerTransport

+ func (s *StreamableServerTransport) Connect(context.Context) (Connection, error)

+ func (t *StreamableServerTransport) Close() error

+ func (t *StreamableServerTransport) Read(ctx context.Context) (JSONRPCMessage, error)

+ func (t *StreamableServerTransport) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ func (t *StreamableServerTransport) Write(ctx context.Context, msg JSONRPCMessage) error

+ type ToolHandlerFor func(context.Context, *ServerSession, *CallToolParamsFor[In]) (*CallToolResultFor[Out], error)

v0.34.0

Jun 5, 2025

Changes in this version

+ const CodeResourceNotFound

+ const CodeUnsupportedMethod

+ const DefaultPageSize

+ const LevelAlert

+ const LevelCritical

+ const LevelDebug

+ const LevelEmergency

+ const LevelError

+ const LevelInfo

+ const LevelNotice

+ const LevelWarning

+ func NewInMemoryTransports() (*InMemoryTransport, *InMemoryTransport)

+ func ResourceNotFoundError(uri string) error

+ type Annotations struct

+ Audience []Role

+ Priority float64

+ type CallToolParams struct

+ Arguments TArgs

+ Meta Meta

+ Name string

+ func (x *CallToolParams[TArgs]) GetMeta() *Meta

+ type CallToolResult struct

+ Content []*Content

+ IsError bool

+ Meta Meta

+ func CallTool[TArgs any](ctx context.Context, cs *ClientSession, params *CallToolParams[TArgs]) (*CallToolResult, error)

+ func (x *CallToolResult) GetMeta() *Meta

+ type CancelledParams struct

+ Meta Meta

+ Reason string

+ RequestID any

+ func (x *CancelledParams) GetMeta() *Meta

type Client

+ func (c *Client) AddReceivingMiddleware(middleware ...Middleware[*ClientSession])

+ func (c *Client) AddRoots(roots ...*Root)

+ func (c *Client) AddSendingMiddleware(middleware ...Middleware[*ClientSession])

+ func (c *Client) RemoveRoots(uris ...string)

+ type ClientCapabilities struct

+ Experimental map[string]struct{}

+ Roots struct{ ... }

+ Sampling *SamplingCapabilities

type ClientOptions

+ CreateMessageHandler func(context.Context, *ClientSession, *CreateMessageParams) (*CreateMessageResult, error)

+ LoggingMessageHandler func(context.Context, *ClientSession, *LoggingMessageParams)

+ PromptListChangedHandler func(context.Context, *ClientSession, *PromptListChangedParams)

+ ResourceListChangedHandler func(context.Context, *ClientSession, *ResourceListChangedParams)

+ ToolListChangedHandler func(context.Context, *ClientSession, *ToolListChangedParams)

+ type ClientSession struct

+ func (cs *ClientSession) CallTool(ctx context.Context, params *CallToolParams[json.RawMessage]) (*CallToolResult, error)

+ func (cs *ClientSession) Close() error

+ func (cs *ClientSession) GetPrompt(ctx context.Context, params *GetPromptParams) (*GetPromptResult, error)

+ func (cs *ClientSession) ListPrompts(ctx context.Context, params *ListPromptsParams) (*ListPromptsResult, error)

+ func (cs *ClientSession) ListResources(ctx context.Context, params *ListResourcesParams) (*ListResourcesResult, error)

+ func (cs *ClientSession) ListTools(ctx context.Context, params *ListToolsParams) (*ListToolsResult, error)

+ func (cs *ClientSession) Ping(ctx context.Context, params *PingParams) error

+ func (cs *ClientSession) Prompts(ctx context.Context, params *ListPromptsParams) iter.Seq2[Prompt, error]

+ func (cs *ClientSession) ReadResource(ctx context.Context, params *ReadResourceParams) (*ReadResourceResult, error)

+ func (cs *ClientSession) Resources(ctx context.Context, params *ListResourcesParams) iter.Seq2[Resource, error]

+ func (cs *ClientSession) SetLevel(ctx context.Context, params *SetLevelParams) error

+ func (cs *ClientSession) Tools(ctx context.Context, params *ListToolsParams) iter.Seq2[Tool, error]

+ func (cs *ClientSession) Wait() error

type Content

+ Annotations *Annotations

+ Data []byte

+ MIMEType string

+ Resource *ResourceContents

+ Text string

+ Type string

+ func NewAudioContent(data []byte, mimeType string) *Content

+ func NewImageContent(data []byte, mimeType string) *Content

+ func NewResourceContent(resource *ResourceContents) *Content

+ func NewTextContent(text string) *Content

+ func (c *Content) UnmarshalJSON(data []byte) error

+ type CreateMessageParams struct

+ IncludeContext string

+ MaxTokens int64

+ Messages []*SamplingMessage

+ Meta Meta

+ Metadata struct{}

+ ModelPreferences *ModelPreferences

+ StopSequences []string

+ SystemPrompt string

+ Temperature float64

+ func (x *CreateMessageParams) GetMeta() *Meta

+ type CreateMessageResult struct

+ Content *Content

+ Meta Meta

+ Model string

+ Role Role

+ StopReason string

+ func (x *CreateMessageResult) GetMeta() *Meta

+ type GetPromptParams struct

+ Arguments map[string]string

+ Meta Meta

+ Name string

+ func (x *GetPromptParams) GetMeta() *Meta

+ type GetPromptResult struct

+ Description string

+ Messages []*PromptMessage

+ Meta Meta

+ func (x *GetPromptResult) GetMeta() *Meta

+ type InMemoryTransport struct

+ func (t *InMemoryTransport) Connect(context.Context) (Stream, error)

+ type InitializeParams struct

+ Capabilities *ClientCapabilities

+ ClientInfo *implementation

+ Meta Meta

+ ProtocolVersion string

+ func (x *InitializeParams) GetMeta() *Meta

+ type InitializeResult struct

+ Capabilities *serverCapabilities

+ Instructions string

+ Meta Meta

+ ProtocolVersion string

+ ServerInfo *implementation

+ func (x *InitializeResult) GetMeta() *Meta

+ type InitializedParams struct

+ Meta Meta

+ func (x *InitializedParams) GetMeta() *Meta

+ type ListPromptsParams struct

+ Cursor string

+ Meta Meta

+ func (x *ListPromptsParams) GetMeta() *Meta

+ type ListPromptsResult struct

+ Meta Meta

+ NextCursor string

+ Prompts []*Prompt

+ func (x *ListPromptsResult) GetMeta() *Meta

+ type ListResourcesParams struct

+ Cursor string

+ Meta Meta

+ func (x *ListResourcesParams) GetMeta() *Meta

+ type ListResourcesResult struct

+ Meta Meta

+ NextCursor string

+ Resources []*Resource

+ func (x *ListResourcesResult) GetMeta() *Meta

+ type ListRootsParams struct

+ Meta Meta

+ func (x *ListRootsParams) GetMeta() *Meta

+ type ListRootsResult struct

+ Meta Meta

+ Roots []*Root

+ func (x *ListRootsResult) GetMeta() *Meta

+ type ListToolsParams struct

+ Cursor string

+ Meta Meta

+ func (x *ListToolsParams) GetMeta() *Meta

+ type ListToolsResult struct

+ Meta Meta

+ NextCursor string

+ Tools []*Tool

+ func (x *ListToolsResult) GetMeta() *Meta

+ type LoggingHandler struct

+ func NewLoggingHandler(ss *ServerSession, opts *LoggingHandlerOptions) *LoggingHandler

+ func (h *LoggingHandler) Enabled(ctx context.Context, level slog.Level) bool

+ func (h *LoggingHandler) Handle(ctx context.Context, r slog.Record) error

+ func (h *LoggingHandler) WithAttrs(as []slog.Attr) slog.Handler

+ func (h *LoggingHandler) WithGroup(name string) slog.Handler

+ type LoggingHandlerOptions struct

+ LoggerName string

+ MinInterval time.Duration

+ type LoggingLevel string

+ type LoggingMessageParams struct

+ Data any

+ Level LoggingLevel

+ Logger string

+ Meta Meta

+ func (x *LoggingMessageParams) GetMeta() *Meta

+ type LoggingTransport struct

+ func NewLoggingTransport(delegate Transport, w io.Writer) *LoggingTransport

+ func (t *LoggingTransport) Connect(ctx context.Context) (Stream, error)

+ type Meta struct

+ Data map[string]any

+ ProgressToken any

+ func (m *Meta) UnmarshalJSON(data []byte) error

+ func (m Meta) MarshalJSON() ([]byte, error)

+ type MethodHandler func(ctx context.Context, _ S, method string, params Params) (result Result, err error)

+ type Middleware func(MethodHandler[S]) MethodHandler[S]

+ type ModelHint struct

+ Name string

+ type ModelPreferences struct

+ CostPriority float64

+ Hints []*ModelHint

+ IntelligencePriority float64

+ SpeedPriority float64

+ type Params interface

+ GetMeta func() *Meta

+ type PingParams struct

+ Meta Meta

+ func (x *PingParams) GetMeta() *Meta

type Prompt

+ Arguments []*PromptArgument

+ Description string

+ Name string

+ type PromptArgument struct

+ Description string

+ Name string

+ Required bool

+ type PromptListChangedParams struct

+ Meta Meta

+ func (x *PromptListChangedParams) GetMeta() *Meta

+ type PromptMessage struct

+ Content *Content

+ Role Role

+ type ReadResourceParams struct

+ Meta Meta

+ URI string

+ func (x *ReadResourceParams) GetMeta() *Meta

+ type ReadResourceResult struct

+ Contents []*ResourceContents

+ Meta Meta

+ func (x *ReadResourceResult) GetMeta() *Meta

type Resource

+ Annotations *Annotations

+ Description string

+ MIMEType string

+ Name string

+ Size int64

+ URI string

+ type ResourceContents struct

+ Blob []byte

+ MIMEType string

+ Text string

+ URI string

+ func NewBlobResourceContents(uri, mimeType string, blob []byte) *ResourceContents

+ func NewTextResourceContents(uri, mimeType, text string) *ResourceContents

+ func (r ResourceContents) MarshalJSON() ([]byte, error)

+ type ResourceHandler func(context.Context, *ServerSession, *ReadResourceParams) (*ReadResourceResult, error)

+ type ResourceListChangedParams struct

+ Meta Meta

+ func (x *ResourceListChangedParams) GetMeta() *Meta

+ type Result interface

+ GetMeta func() *Meta

+ type Role string

+ type Root struct

+ Name string

+ URI string

+ type RootsListChangedParams struct

+ Meta Meta

+ func (x *RootsListChangedParams) GetMeta() *Meta

+ type SSEServerTransport struct

+ func NewSSEServerTransport(endpoint string, w http.ResponseWriter) *SSEServerTransport

+ func (t *SSEServerTransport) Connect(context.Context) (Stream, error)

+ func (t *SSEServerTransport) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type SamplingCapabilities struct

+ type SamplingMessage struct

+ Content *Content

+ Role Role

type Server

+ func (s *Server) AddReceivingMiddleware(middleware ...Middleware[*ServerSession])

+ func (s *Server) AddResources(resources ...*ServerResource)

+ func (s *Server) AddSendingMiddleware(middleware ...Middleware[*ServerSession])

+ func (s *Server) RemovePrompts(names ...string)

+ func (s *Server) RemoveResources(uris ...string)

+ func (s *Server) RemoveTools(names ...string)

+ func (s *Server) Sessions() iter.Seq[*ServerSession]

type ServerOptions

+ InitializedHandler func(context.Context, *ServerSession, *InitializedParams)

+ PageSize int

+ RootsListChangedHandler func(context.Context, *ServerSession, *RootsListChangedParams)

+ type ServerPrompt struct

+ Handler PromptHandler

+ Prompt *Prompt

+ func NewPrompt[TReq any](name, description string, ...) *ServerPrompt

+ type ServerResource struct

+ Handler ResourceHandler

+ Resource *Resource

+ type ServerSession struct

+ func (ss *ServerSession) Close() error

+ func (ss *ServerSession) CreateMessage(ctx context.Context, params *CreateMessageParams) (*CreateMessageResult, error)

+ func (ss *ServerSession) ListRoots(ctx context.Context, params *ListRootsParams) (*ListRootsResult, error)

+ func (ss *ServerSession) LoggingMessage(ctx context.Context, params *LoggingMessageParams) error

+ func (ss *ServerSession) Ping(ctx context.Context, params *PingParams) error

+ func (ss *ServerSession) Wait() error

+ type ServerTool struct

+ Handler ToolHandler[json.RawMessage]

+ Tool *Tool

+ func NewTool[TReq any](name, description string, handler ToolHandler[TReq], opts ...ToolOption) *ServerTool

+ type Session interface

+ type SetLevelParams struct

+ Level LoggingLevel

+ Meta Meta

+ func (x *SetLevelParams) GetMeta() *Meta

+ type StdIOTransport struct

+ func (t *StdIOTransport) Connect(context.Context) (Stream, error)

type Tool

+ Annotations *ToolAnnotations

+ Description string

+ InputSchema *jsonschema.Schema

+ Name string

+ type ToolAnnotations struct

+ DestructiveHint bool

+ IdempotentHint bool

+ OpenWorldHint bool

+ ReadOnlyHint bool

+ Title string

+ type ToolListChangedParams struct

+ Meta Meta

+ func (x *ToolListChangedParams) GetMeta() *Meta

v0.33.0

May 5, 2025

Changes in this version

+ var ErrConnectionClosed = errors.New("connection closed")

+ func NewLocalTransport() (*IOTransport, *IOTransport)

+ type AudioContent struct

+ Data string

+ MimeType string

+ func (c AudioContent) ToWire() protocol.Content

+ type BlobResource struct

+ Blob string

+ MimeType string

+ URI string

+ func (r BlobResource) ToWire() protocol.Resource

+ type Client struct

+ func NewClient(name, version string, opts *ClientOptions) *Client

+ func (c *Client) CallTool(ctx context.Context, name string, args map[string]any) (_ *protocol.CallToolResult, err error)

+ func (c *Client) Close() error

+ func (c *Client) Connect(ctx context.Context, t Transport, opts *ConnectionOptions) (err error)

+ func (c *Client) GetPrompt(ctx context.Context, name string, args map[string]string) (*protocol.GetPromptResult, error)

+ func (c *Client) ListPrompts(ctx context.Context) ([]protocol.Prompt, error)

+ func (c *Client) ListTools(ctx context.Context) ([]protocol.Tool, error)

+ func (c *Client) Ping(ctx context.Context) error

+ func (c *Client) Wait() error

+ type ClientConnection struct

+ func (cc *ClientConnection) Close() error

+ func (cc *ClientConnection) Ping(ctx context.Context) error

+ func (cc *ClientConnection) Wait() error

+ type ClientOptions struct

+ type CommandTransport struct

+ func NewCommandTransport(cmd *exec.Cmd) *CommandTransport

+ func (t *CommandTransport) Connect(ctx context.Context) (Stream, error)

+ type ConnectionOptions struct

+ Logger io.Writer

+ SessionID string

+ type Content interface

+ ToWire func() protocol.Content

+ func ContentFromWireContent(c protocol.Content) Content

+ type IOTransport struct

+ func NewStdIOTransport() *IOTransport

+ func (t *IOTransport) Connect(context.Context) (Stream, error)

+ type ImageContent struct

+ Data string

+ MimeType string

+ func (c ImageContent) ToWire() protocol.Content

+ type Prompt struct

+ Definition protocol.Prompt

+ Handler PromptHandler

+ func MakePrompt[TReq any](name, description string, ...) *Prompt

+ type PromptHandler func(context.Context, *ClientConnection, map[string]string) (*protocol.GetPromptResult, error)

+ type PromptOption interface

+ func Argument(name string, opts ...SchemaOption) PromptOption

+ type Resource interface

+ ToWire func() protocol.Resource

+ type ResourceContent struct

+ Resource Resource

+ func (r ResourceContent) ToWire() protocol.Content

+ type SSEClientTransport struct

+ func NewSSEClientTransport(baseURL string) *SSEClientTransport

+ func (c *SSEClientTransport) Connect(ctx context.Context) (Stream, error)

+ type SSEHandler struct

+ func NewSSEHandler(getServer func(request *http.Request) *Server) *SSEHandler

+ func (h *SSEHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type SchemaOption interface

+ func Description(desc string) SchemaOption

+ func Enum(values ...any) SchemaOption

+ func Property(name string, opts ...SchemaOption) SchemaOption

+ func Required(v bool) SchemaOption

+ func Schema(schema *jsonschema.Schema) SchemaOption

+ type Server struct

+ func NewServer(name, version string, opts *ServerOptions) *Server

+ func (s *Server) AddPrompts(prompts ...*Prompt)

+ func (s *Server) AddTools(tools ...*Tool)

+ func (s *Server) Clients() iter.Seq[*ClientConnection]

+ func (s *Server) Connect(ctx context.Context, t Transport, opts *ConnectionOptions) (*ClientConnection, error)

+ func (s *Server) Run(ctx context.Context, t Transport, opts *ConnectionOptions) error

+ type ServerOptions struct

+ Instructions string

+ type Stream interface

+ type TextContent struct

+ Text string

+ func (c TextContent) ToWire() protocol.Content

+ type TextResource struct

+ MimeType string

+ Text string

+ URI string

+ func (r TextResource) ToWire() protocol.Resource

+ type Tool struct

+ Definition protocol.Tool

+ Handler ToolHandler

+ func MakeTool[TReq any](name, description string, ...) *Tool

+ type ToolHandler func(context.Context, *ClientConnection, map[string]json.RawMessage) (*protocol.CallToolResult, error)

+ type ToolOption interface

+ func Input(opts ...SchemaOption) ToolOption

+ type Transport interface

+ Connect func(ctx context.Context) (Stream, error)

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