mcpserver

package
v1.3.3 Latest Latest
Warning

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

 Go to latest Published: Aug 13, 2026 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Package mcpserver exposes Beacon's local configuration and operational state through the Model Context Protocol. It is a thin transport over the same config.Service and stats.Registry used by the REST API and web UI, so MCP writes get identical validation, persistence, and hot reconciliation.

Index

Constants

View Source 
const (
	EndpointPath = "/mcp"
)

Variables

This section is empty.

Functions

func Handler 

func Handler(svc *config.Service, reg *stats.Registry, version string, log *slog.Logger) http.Handler

Handler serves the current MCP Streamable HTTP transport. Beacon's tools are synchronous and keep no cross-call state, so stateless mode avoids retaining one server session per client. Request bodies are bounded before the SDK decodes JSON. Cross-origin protection enforces the MCP transport's Origin requirement while continuing to allow non-browser local/LAN agents.

func NewServer 

func NewServer(svc *config.Service, reg *stats.Registry, version string, log *slog.Logger) *sdkmcp.Server

NewServer creates Beacon's MCP server. The returned server can be used with an in-memory transport in tests or the Streamable HTTP handler returned by Handler in production.

Types

type ToolInfo 

type ToolInfo struct {
	Name        string
	Access      string
	Description string
}

ToolInfo is the stable, human-readable catalog shared by the MCP server and the onboard /mcp/info reference page.

func Catalog 

func Catalog() []ToolInfo

Catalog returns a copy so callers cannot mutate the registered tool list.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.