server

Documentation

Overview

Package server MCP endpoint implements the Model Context Protocol (MCP) Streamable HTTP transport so that AI assistants (Claude Desktop, Cursor, etc.) can search the Hister index directly.

Specification: https://modelcontextprotocol.io/specification/2024-11-05

Only the search tool is exposed. The handler lives at POST /mcp and uses the same authentication as the rest of the API. Bearer tokens are accepted via the standard Authorization header and are resolved by the global auth middleware (withTokenAuth / populateUserContext).

Index

• Constants
• Variables
• func Listen(cfg *config.Config)
• type Endpoint
  • func (e *Endpoint) Pattern() string
• type EndpointArg
• type JSONSchemaField

Constants

const (
	// GET is HTTP GET request type
	GET string = "GET"
	// POST is HTTP POST request type
	POST string = "POST"
	// PUT is HTTP PUT request type
	PUT string = "PUT"
	// PATCH is HTTP PATCH request type
	PATCH string = "PATCH"
	// HEAD is HTTP HEAD request type
	HEAD string = "HEAD"
)

Variables

var Endpoints []*Endpoint

Endpoints contains all registered API endpoints.

var Version = "unknown"

Version is set by the main package before Listen() is called so that MCP and other server responses can expose the running binary version.

Functions

func Listen

func Listen(cfg *config.Config)

Types

type Endpoint

type Endpoint struct {
	Name         string
	Path         string
	Method       string
	CSRFRequired bool
	NoAuth       bool
	AdminOnly    bool
	Handler      endpointHandler `json:"-"`
	Description  string
	Args         []*EndpointArg
	// JSONSchema describes the fields of the JSON request body, if the endpoint
	// consumes application/json instead of (or in addition to) form data.
	JSONSchema []*JSONSchemaField
}

Endpoint represents an API endpoint definition.

func (*Endpoint) Pattern

func (e *Endpoint) Pattern() string

type EndpointArg

type EndpointArg struct {
	Name        string `json:"name"`
	Type        string `json:"type"`
	Required    bool   `json:"required"`
	Description string `json:"description"`
}

EndpointArg represents a query-string or form parameter for an API endpoint.

type JSONSchemaField

type JSONSchemaField struct {
	Name        string             `json:"name"`
	Type        string             `json:"type"`
	Required    bool               `json:"required"`
	Description string             `json:"description"`
	Fields      []*JSONSchemaField `json:"fields,omitempty"`
}

JSONSchemaField represents a single field in a JSON request body schema. Fields may be nested to describe object and array element types.