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 ServerFromContext(ctx context.Context) *MCPServer
  • func (s *MCPServer) AddNotificationHandler(method string, handler NotificationHandlerFunc)
  • func (s *MCPServer) AddPrompt(prompt mcp.Prompt, handler PromptHandlerFunc)
  • func (s *MCPServer) AddResource(resource mcp.Resource, handler ResourceHandlerFunc)
  • func (s *MCPServer) AddResourceTemplate(template mcp.ResourceTemplate, handler ResourceTemplateHandlerFunc)
  • func (s *MCPServer) AddTool(tool mcp.Tool, handler ToolHandlerFunc)
  • func (s *MCPServer) HandleMessage(ctx context.Context, message json.RawMessage) mcp.JSONRPCMessage
  • func (s *MCPServer) SendNotificationToClient(method string, params map[string]interface{}) error
  • func (s *MCPServer) WithContext(ctx context.Context, notifCtx NotificationContext) context.Context
• type NotificationContext
• 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 ServerNotification
• 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. It sets up signal handling for graceful shutdown on SIGTERM and SIGINT. Returns an error if the server encounters any issues during operation.

Types

type MCPServer

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

MCPServer implements a Model Control Protocol server that can handle various types of requests including resources, prompts, and tools.

func NewMCPServer

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

NewMCPServer creates a new MCP server instance with the given name, version and options

func ServerFromContext

func ServerFromContext(ctx context.Context) *MCPServer

ServerFromContext retrieves the MCPServer instance from a context

func (*MCPServer) AddNotificationHandler

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

AddNotificationHandler registers a new handler for incoming notifications

func (*MCPServer) AddPrompt

func (s *MCPServer) AddPrompt(prompt mcp.Prompt, handler PromptHandlerFunc)

AddPrompt registers a new prompt handler with the given name

func (*MCPServer) AddResource

func (s *MCPServer) AddResource(
	resource mcp.Resource,
	handler ResourceHandlerFunc,
)

AddResource registers a new resource and its handler

func (*MCPServer) AddResourceTemplate

func (s *MCPServer) AddResourceTemplate(
	template mcp.ResourceTemplate,
	handler ResourceTemplateHandlerFunc,
)

AddResourceTemplate registers a new resource template and its handler

func (*MCPServer) AddTool

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

AddTool registers a new tool and its handler

func (*MCPServer) HandleMessage

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

HandleMessage processes an incoming JSON-RPC message and returns an appropriate response

func (*MCPServer) SendNotificationToClient

func (s *MCPServer) SendNotificationToClient(
	method string,
	params map[string]interface{},
) error

SendNotificationToClient sends a notification to the current client

func (*MCPServer) WithContext

func (s *MCPServer) WithContext(
	ctx context.Context,
	notifCtx NotificationContext,
) context.Context

WithContext sets the current client context and returns the provided context

type NotificationContext

type NotificationContext struct {
	ClientID  string
	SessionID string
}

NotificationContext provides client identification for notifications

type NotificationHandlerFunc

type NotificationHandlerFunc func(ctx context.Context, notification mcp.JSONRPCNotification)

NotificationHandlerFunc handles incoming notifications.

type PromptHandlerFunc

type PromptHandlerFunc func(ctx context.Context, request mcp.GetPromptRequest) (*mcp.GetPromptResult, error)

PromptHandlerFunc handles prompt requests with given arguments.

type ResourceHandlerFunc

type ResourceHandlerFunc func(ctx context.Context, request mcp.ReadResourceRequest) ([]interface{}, error)

ResourceHandlerFunc is a function that returns resource contents.

type ResourceTemplateHandlerFunc

type ResourceTemplateHandlerFunc func(ctx context.Context, request mcp.ReadResourceRequest) ([]interface{}, 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

NewSSEServer creates a new SSE server instance with the given MCP server and base URL.

func (*SSEServer) SendEventToSession

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

SendEventToSession sends an event to a specific SSE session identified by sessionID. Returns an error if the session is not found or closed.

func (*SSEServer) Shutdown

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

Shutdown gracefully stops the SSE server, closing all active sessions and shutting down the HTTP server.

func (*SSEServer) Start

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

Start begins serving SSE connections on the specified address. It sets up HTTP handlers for SSE and message endpoints.

type ServerNotification

type ServerNotification struct {
	Context      NotificationContext
	Notification mcp.JSONRPCNotification
}

ServerNotification combines the notification with client context

type ServerOption

type ServerOption func(*MCPServer)

ServerOption is a function that configures an MCPServer.

func WithLogging

func WithLogging() ServerOption

WithLogging enables logging capabilities for the server

func WithPromptCapabilities

func WithPromptCapabilities(listChanged bool) ServerOption

WithPromptCapabilities configures prompt-related server capabilities

func WithResourceCapabilities

func WithResourceCapabilities(subscribe, listChanged bool) ServerOption

WithResourceCapabilities configures resource-related server capabilities

type StdioServer

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

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 using JSON-RPC messages.

func NewStdioServer

func NewStdioServer(server *MCPServer) *StdioServer

NewStdioServer creates a new stdio server wrapper around an MCPServer. It initializes the server with a default error logger that discards all output.

func (*StdioServer) Listen

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

Listen starts listening for JSON-RPC messages on the provided input and writes responses to the provided output. It runs until the context is cancelled or an error occurs. Returns an error if there are issues with reading input or writing output.

func (*StdioServer) SetErrorLogger

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

SetErrorLogger configures where error messages from the StdioServer are logged. The provided logger will receive all error messages generated during server operation.

type ToolHandlerFunc

type ToolHandlerFunc func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error)

ToolHandlerFunc handles tool calls with given arguments.