Documentation
¶
Overview ¶
Package mcp exposes the mnemos retrieval surface over the Model Context Protocol. It builds an official-SDK server, registers the read-only search / read / context tools, and runs them over a transport (stdio in serve, an in-memory pair in tests). All tools reuse the Phase 1 search engine and storage; this package adds no retrieval logic of its own.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server is the MCP adapter over the memory service. The same value backs both the stdio serve command and the in-memory test client. Every tool handler is thin: it shapes the request, calls a memory.Service method, and formats the result — the verb behavior, gating, and option construction live in the service, so this surface cannot drift from the CLI.
retriever is the search seam Search/Context run through (held here, not in the service, because the CLI picks a retriever per command). cfg is retained only for the registration gates and the handler-level defensive re-checks on destructive tools.
func NewServer ¶
func NewServer(db *sql.DB, retriever search.Retriever, cfg *config.Config, treeRoot string, scanner security.SecretScanner, logger *slog.Logger) *Server
NewServer builds the MCP server and registers the read-only tools. db is the open store; retriever the search seam (the lexical FTS engine, or a hybrid lexical+vector retriever when serve resolves one); cfg the loaded configuration (write/capture/indexing settings are read from it, and search.default_limit is applied when a tool omits limit); treeRoot the OKF tree root paths are confined within; scanner the secret screen for captured text; and logger writes diagnostics to stderr (never stdout, the MCP transport). The write tools mnemos.remember/okfy are registered only when cfg.MCP.AllowWrite is true, and mnemos.forget/move only when cfg.MCP.AllowDelete is true (least capability: a disabled tool is never advertised in tools/list).
func (*Server) Connect ¶
func (s *Server) Connect(ctx context.Context, transport mcpsdk.Transport) (*mcpsdk.ServerSession, error)
Connect starts a single non-blocking session over transport and returns it. serve uses Serve (which blocks); Connect exists for the in-memory test harness that needs to drive the client side concurrently.
Source Files