server

package
v0.0.11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 14, 2025 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

Package server implements the MCP server functionality.

It handles loading tool configurations, starting the server, and processing requests from AI clients using the MCP protocol.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	ConfigFile  string         // Path to the YAML configuration file
	Shell       string         // Shell to use for executing commands
	Logger      *common.Logger // Logger for server operations
	Version     string         // Version string for the server
	Description string         // Description shown to AI clients
}

Config contains the configuration options for creating a new Server

type Server

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

Server represents the MCPShell server that handles tool registration and request processing.

func New

func New(cfg Config) *Server

New creates a new Server instance with the provided configuration

Parameters:

  • cfg: The server configuration

Returns:

  • A new Server instance

func (*Server) Start

func (s *Server) Start() error

Start initializes the MCP server, loads tools from the configuration file, and starts listening for client connections.

Returns:

  • An error if server initialization or startup fails

func (*Server) Validate

func (s *Server) Validate() error

Validate verifies the configuration file without starting the server. It loads the configuration, attempts to compile all constraints, and checks for errors.

Returns:

  • nil if the configuration is valid
  • An error describing validation failures

Jump to

Keyboard shortcuts

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