server

Documentation

Overview

Package server provides MCP (Model Control Protocol) server implementations.

Index

• func NewTestServer(server *MCPServer) *httptest.Server
• func ServeStdio(server *MCPServer) error
• type MCPServer
  • func NewMCPServer(name, version string, opts ...ServerOption) *MCPServer
  • func (s *MCPServer) AddNotificationHandler(handler NotificationHandlerFunc)
  • func (s *MCPServer) AddPrompt(name string, handler PromptHandlerFunc)
  • func (s *MCPServer) AddResource(uri string, handler ResourceHandlerFunc)
  • func (s *MCPServer) AddResourceTemplate(uriTemplate string, handler ResourceTemplateHandlerFunc)
  • func (s *MCPServer) AddTool(tool mcp.Tool, handler ToolHandlerFunc)
  • func (s *MCPServer) HandleMessage(ctx context.Context, message json.RawMessage) mcp.JSONRPCMessage
• type NotificationHandlerFunc
• type PromptHandlerFunc
• type ResourceHandlerFunc
• type ResourceTemplateHandlerFunc
• type SSEServer
  • func NewSSEServer(server *MCPServer, baseURL string) *SSEServer
  • func (s *SSEServer) SendEventToSession(sessionID string, event interface{}) error
  • func (s *SSEServer) Shutdown(ctx context.Context) error
  • func (s *SSEServer) Start(addr string) error
• type ServerOption
  • func WithLogging() ServerOption
  • func WithPromptCapabilities(listChanged bool) ServerOption
  • func WithResourceCapabilities(subscribe, listChanged bool) ServerOption
• type StdioServer
  • func NewStdioServer(server *MCPServer) *StdioServer
  • func (s *StdioServer) Listen(ctx context.Context, stdin io.Reader, stdout io.Writer) error
  • func (s *StdioServer) SetErrorLogger(logger *log.Logger)
• type ToolHandlerFunc

Functions

func NewTestServer

func NewTestServer(server *MCPServer) *httptest.Server

NewTestServer creates a test server for testing purposes

func ServeStdio

func ServeStdio(server *MCPServer) error

ServeStdio is a convenience function that creates and starts a StdioServer with os.Stdin and os.Stdout

Types

type MCPServer

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

func NewMCPServer

func NewMCPServer(
	name, version string,
	opts ...ServerOption,
) *MCPServer

func (*MCPServer) AddNotificationHandler

func (s *MCPServer) AddNotificationHandler(
	handler NotificationHandlerFunc,
)

func (*MCPServer) AddPrompt

func (s *MCPServer) AddPrompt(name string, handler PromptHandlerFunc)

func (*MCPServer) AddResource

func (s *MCPServer) AddResource(uri string, handler ResourceHandlerFunc)

func (*MCPServer) AddResourceTemplate

func (s *MCPServer) AddResourceTemplate(
	uriTemplate string,
	handler ResourceTemplateHandlerFunc,
)

func (*MCPServer) AddTool

func (s *MCPServer) AddTool(tool mcp.Tool, handler ToolHandlerFunc)

func (*MCPServer) HandleMessage

func (s *MCPServer) HandleMessage(
	ctx context.Context,
	message json.RawMessage,
) mcp.JSONRPCMessage

type NotificationHandlerFunc

type NotificationHandlerFunc func(notification mcp.JSONRPCNotification)

NotificationHandlerFunc handles incoming notifications.

type PromptHandlerFunc

type PromptHandlerFunc func(arguments map[string]string) (*mcp.GetPromptResult, error)

PromptHandlerFunc handles prompt requests with given arguments.

type ResourceHandlerFunc

type ResourceHandlerFunc func() ([]interface{}, error)

ResourceHandlerFunc is a function that returns resource contents.

type ResourceTemplateHandlerFunc

type ResourceTemplateHandlerFunc func() (mcp.ResourceTemplate, error)

ResourceTemplateHandlerFunc is a function that returns a resource template.

type SSEServer

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

SSEServer implements a Server-Sent Events (SSE) based MCP server. It provides real-time communication capabilities over HTTP using the SSE protocol.

func NewSSEServer

func NewSSEServer(server *MCPServer, baseURL string) *SSEServer

func (*SSEServer) SendEventToSession

func (s *SSEServer) SendEventToSession(
	sessionID string,
	event interface{},
) error

SendEventToSession sends an event to a specific session

func (*SSEServer) Shutdown

func (s *SSEServer) Shutdown(ctx context.Context) error

func (*SSEServer) Start

func (s *SSEServer) Start(addr string) error

type ServerOption

type ServerOption func(*MCPServer)

ServerOption is a function that configures an MCPServer.

func WithLogging

func WithLogging() ServerOption

func WithPromptCapabilities

func WithPromptCapabilities(listChanged bool) ServerOption

func WithResourceCapabilities

func WithResourceCapabilities(subscribe, listChanged bool) ServerOption

type StdioServer

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

StdioServer wraps a MCPServer and handles stdio communication StdioServer wraps a MCPServer and handles stdio communication. It provides a simple way to create command-line MCP servers that communicate via standard input/output streams.

func NewStdioServer

func NewStdioServer(server *MCPServer) *StdioServer

NewStdioServer creates a new stdio server wrapper around an MCPServer

func (*StdioServer) Listen

func (s *StdioServer) Listen(ctx context.Context, stdin io.Reader, stdout io.Writer) error

Listen starts listening for messages on the provided input and writes responses to the provided output

func (*StdioServer) SetErrorLogger

func (s *StdioServer) SetErrorLogger(logger *log.Logger)

SetErrorLogger allows configuring where errors are logged

type ToolHandlerFunc

type ToolHandlerFunc func(arguments map[string]interface{}) (*mcp.CallToolResult, error)

ToolHandlerFunc handles tool calls with given arguments.