server

Documentation

Index

• type MethodExecutor
• type Server
  • func NewServer(opts ...ServerOpts) *Server
  • func (s *Server) ExecuteMethod(serviceName, methodName string, params map[string]any) (any, error)
  • func (s *Server) GetMethodExecutor() MethodExecutor
  • func (s *Server) GetToolRegistry() ToolRegistry
  • func (s *Server) GetTransport() Transport
  • func (s *Server) HTTPHandler() any
  • func (s *Server) ListenAndServe(addr string) error
  • func (s *Server) RegisterMethod(serviceName, methodName, description string, parameters map[string]any) error
  • func (s *Server) RegisterMethodLLM(methodName, description string, returns ...string) error
  • func (s *Server) RegisterService(service any) error
• type ServerOpts
  • func WithMethodExecutor(executor MethodExecutor) ServerOpts
  • func WithToolRegistry(registry ToolRegistry) ServerOpts
  • func WithTransport(transport Transport, opts ...TransportOpts) ServerOpts
• type ToolRegistry
• type Transport
• type TransportOpts

Types

type MethodExecutor

type MethodExecutor interface {
	ExecuteMethod(serviceName, methodName string, params map[string]interface{}) (interface{}, error)
}

MethodExecutor defines the interface for executing methods

type Server

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

func NewServer

func NewServer(opts ...ServerOpts) *Server

func (*Server) ExecuteMethod

func (s *Server) ExecuteMethod(serviceName, methodName string, params map[string]any) (any, error)

ExecuteMethod executes a method through the method executor

func (*Server) GetMethodExecutor

func (s *Server) GetMethodExecutor() MethodExecutor

GetMethodExecutor returns the method executor

func (*Server) GetToolRegistry

func (s *Server) GetToolRegistry() ToolRegistry

GetToolRegistry returns the tool registry

func (*Server) GetTransport

func (s *Server) GetTransport() Transport

GetTransport returns the underlying transport

func (*Server) HTTPHandler

func (s *Server) HTTPHandler() any

HTTPHandler returns the HTTP handler if the transport supports it

func (*Server) ListenAndServe

func (s *Server) ListenAndServe(addr string) error

func (*Server) RegisterMethod

func (s *Server) RegisterMethod(serviceName, methodName, description string, parameters map[string]any) error

RegisterMethod registers a method as a tool

func (*Server) RegisterMethodLLM

func (s *Server) RegisterMethodLLM(methodName, description string, returns ...string) error

RegisterMethodLLM registers a method using LLM-friendly combined description. This method provides an alternative to RegisterMethod that allows for more flexible parameter descriptions suitable for LLM consumption. The description parameter should contain all necessary information for an LLM to understand how to call the method, including parameter schemas, examples, and natural language guidance.

The methodName should be in the format "ServiceName.MethodName". The optional returns parameter specifies the return type description.

func (*Server) RegisterService

func (s *Server) RegisterService(service any) error

RegisterService registers a service with the underlying transport if it supports service registration

type ServerOpts

type ServerOpts func(*Server)

func WithMethodExecutor

func WithMethodExecutor(executor MethodExecutor) ServerOpts

func WithToolRegistry

func WithToolRegistry(registry ToolRegistry) ServerOpts

func WithTransport

func WithTransport(transport Transport, opts ...TransportOpts) ServerOpts

type ToolRegistry

type ToolRegistry interface {
	RegisterMethod(serviceName, methodName, description string, parameters map[string]interface{}) error
	// RegisterMethodLLM registers a method using LLM-friendly combined description
	RegisterMethodLLM(methodName, description string, returns ...string) error
}

ToolRegistry defines the interface for tool registration

type Transport

type Transport interface {
	ListenAndServe(addr string) error
}

type TransportOpts

type TransportOpts func(Transport) Transport