Adds a two-dimensional address (wing, hall) to brain notes. A wing is a
topic domain (e.g. jepa-fx, hyperguild); a hall is one of a closed
vocabulary of memory types (facts, decisions, failures, hypotheses,
sources). Notes route to brain/wiki/<wing>/<hall>/<slug>.md with
wing/hall/created_at YAML frontmatter, making the directory a valid
Obsidian vault.
Changes:
- new package ingestion/internal/brain (NotePath, ValidHalls, Sanitise,
BuildWingIndex, BuildAllWingIndexes)
- api.WriteNote refactored to WriteNoteOptions; wing+hall routes to
brain/wiki/, otherwise falls back to brain/knowledge/ (legacy)
- search.Query → QueryOptions with optional Wing/Hall filtering; Result
carries wing/hall extracted from frontmatter or path segments
- MCP tools brain_write and brain_query gain optional wing/hall params
(hall enum-validated); new brain_index tool regenerates _index.md MOC
- POST /index REST endpoint mirrors brain_index
- brain_write auto-rebuilds the wing's _index.md after a wing+hall write
- scripts/migrate-brain-halls.sh migrates flat brain/wiki/{concepts,entities}/
into the new layout (dry-run by default, --commit applies)
All existing tests pass; new tests cover wing/hall write routing, scope
filtering, invalid hall rejection, _index.md generation, and migration
script paths.
Closes hyperguild#1.
335 lines
11 KiB
Go
335 lines
11 KiB
Go
package mcp
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"log/slog"
|
|
"path/filepath"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/mathiasbq/hyperguild/ingestion/internal/api"
|
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brain"
|
|
"github.com/mathiasbq/hyperguild/ingestion/internal/extract"
|
|
"github.com/mathiasbq/hyperguild/ingestion/internal/pipeline"
|
|
"github.com/mathiasbq/hyperguild/ingestion/internal/search"
|
|
"github.com/mathiasbq/hyperguild/ingestion/internal/session"
|
|
)
|
|
|
|
// tools returns the tool descriptors. Handler bodies for each tool are filled
|
|
// in subsequent tasks; this file currently only provides the descriptors.
|
|
func (s *Server) tools() []map[string]any {
|
|
str := func(desc string) map[string]any {
|
|
return map[string]any{"type": "string", "description": desc}
|
|
}
|
|
int_ := func(desc string) map[string]any {
|
|
return map[string]any{"type": "integer", "description": desc}
|
|
}
|
|
enum := func(desc string, vals ...string) map[string]any {
|
|
return map[string]any{"type": "string", "description": desc, "enum": vals}
|
|
}
|
|
halls := []string{"facts", "decisions", "failures", "hypotheses", "sources"}
|
|
schema := func(required []string, props map[string]any) json.RawMessage {
|
|
b, _ := json.Marshal(map[string]any{
|
|
"type": "object", "required": required, "properties": props,
|
|
})
|
|
return b
|
|
}
|
|
|
|
return []map[string]any{
|
|
{
|
|
"name": "brain_query",
|
|
"description": "BM25 full-text search across brain/knowledge/ and brain/wiki/ markdown files. Optionally scope by wing (topic domain) and hall (memory type).",
|
|
"inputSchema": schema([]string{"query"}, map[string]any{
|
|
"query": str("search terms"),
|
|
"limit": int_("max results, default 5"),
|
|
"wing": str("optional wing to scope to, e.g. jepa-fx"),
|
|
"hall": enum("optional hall to scope to (requires wing)", halls...),
|
|
}),
|
|
},
|
|
{
|
|
"name": "brain_write",
|
|
"description": "Write a markdown note to the brain. With wing+hall set, routes to brain/wiki/<wing>/<hall>/ with wing/hall/created_at frontmatter; otherwise writes to brain/knowledge/ (legacy).",
|
|
"inputSchema": schema([]string{"content"}, map[string]any{
|
|
"content": str("markdown content"),
|
|
"filename": str("optional filename or slug"),
|
|
"type": str("optional frontmatter type (legacy)"),
|
|
"domain": str("optional frontmatter domain (legacy)"),
|
|
"wing": str("optional topic domain, e.g. jepa-fx"),
|
|
"hall": enum("optional memory type (requires wing)", halls...),
|
|
}),
|
|
},
|
|
{
|
|
"name": "brain_index",
|
|
"description": "Regenerate _index.md (Map of Content) for one or all wings under brain/wiki/. Auto-called after brain_write with wing+hall.",
|
|
"inputSchema": schema([]string{}, map[string]any{
|
|
"wing": str("optional wing to index; if absent, rebuilds every wing"),
|
|
}),
|
|
},
|
|
{
|
|
"name": "brain_ingest_raw",
|
|
"description": "Ingest pre-structured pages into the brain wiki, bypassing the LLM extraction step.",
|
|
"inputSchema": schema([]string{"source", "pages"}, map[string]any{
|
|
"source": str("source name"),
|
|
"pages": map[string]any{"type": "array"},
|
|
"dry_run": map[string]any{"type": "boolean"},
|
|
}),
|
|
},
|
|
{
|
|
"name": "brain_ingest",
|
|
"description": "Ingest content into the brain wiki via the LLM extraction pipeline.",
|
|
"inputSchema": schema([]string{}, map[string]any{
|
|
"content": str("raw content; required when path is empty"),
|
|
"source": str("source name; required when path is empty"),
|
|
"path": str("file path; mutually exclusive with content+source"),
|
|
"dry_run": map[string]any{"type": "boolean"},
|
|
}),
|
|
},
|
|
{
|
|
"name": "brain_answer",
|
|
"description": "Retrieve relevant brain content via BM25 and synthesize a coherent answer using an LLM.",
|
|
"inputSchema": schema([]string{"query"}, map[string]any{
|
|
"query": str("question to answer"),
|
|
}),
|
|
},
|
|
{
|
|
"name": "brain_classify",
|
|
"description": "Classify raw text into doc type, title, and tags using an LLM.",
|
|
"inputSchema": schema([]string{"text"}, map[string]any{
|
|
"text": str("raw document text to classify (first 3000 chars used)"),
|
|
}),
|
|
},
|
|
{
|
|
"name": "session_log",
|
|
"description": "Append a structured entry to brain/sessions/<session_id>.jsonl.",
|
|
"inputSchema": schema([]string{"session_id"}, map[string]any{
|
|
"session_id": str("session identifier"),
|
|
"skill": str("skill name"),
|
|
"phase": str("phase within the skill"),
|
|
"project_root": str("absolute project root"),
|
|
"final_status": str("pass | fail | skip (legacy: ok | error | skipped also accepted)"),
|
|
"file_path": str("optional file produced"),
|
|
"model_used": str("optional model identifier"),
|
|
"duration_ms": int_("optional duration in ms"),
|
|
"message": str("optional free-text"),
|
|
}),
|
|
},
|
|
}
|
|
}
|
|
|
|
type brainQueryArgs struct {
|
|
Query string `json:"query"`
|
|
Limit int `json:"limit,omitempty"`
|
|
Wing string `json:"wing,omitempty"`
|
|
Hall string `json:"hall,omitempty"`
|
|
}
|
|
|
|
func (s *Server) brainQuery(ctx context.Context, args json.RawMessage) (json.RawMessage, error) {
|
|
var a brainQueryArgs
|
|
if err := json.Unmarshal(args, &a); err != nil {
|
|
return nil, fmt.Errorf("parse args: %w", err)
|
|
}
|
|
if a.Query == "" {
|
|
return nil, fmt.Errorf("query is required")
|
|
}
|
|
if a.Limit == 0 {
|
|
a.Limit = 5
|
|
}
|
|
results, err := search.Query(s.brainDir, search.QueryOptions{
|
|
Query: a.Query,
|
|
Limit: a.Limit,
|
|
Wing: a.Wing,
|
|
Hall: a.Hall,
|
|
})
|
|
if err != nil {
|
|
return nil, fmt.Errorf("search: %w", err)
|
|
}
|
|
return json.Marshal(map[string]any{"results": results})
|
|
}
|
|
|
|
type brainWriteArgs struct {
|
|
Content string `json:"content"`
|
|
Filename string `json:"filename,omitempty"`
|
|
Type string `json:"type,omitempty"`
|
|
Domain string `json:"domain,omitempty"`
|
|
Wing string `json:"wing,omitempty"`
|
|
Hall string `json:"hall,omitempty"`
|
|
}
|
|
|
|
func (s *Server) brainWrite(ctx context.Context, args json.RawMessage) (json.RawMessage, error) {
|
|
var a brainWriteArgs
|
|
if err := json.Unmarshal(args, &a); err != nil {
|
|
return nil, fmt.Errorf("parse args: %w", err)
|
|
}
|
|
relPath, err := api.WriteNote(s.brainDir, api.WriteNoteOptions{
|
|
Content: a.Content,
|
|
Filename: a.Filename,
|
|
Type: a.Type,
|
|
Domain: a.Domain,
|
|
Wing: a.Wing,
|
|
Hall: a.Hall,
|
|
})
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
// Auto-regenerate the wing _index.md when the write landed in the
|
|
// structured wiki. A failure here is best-effort — log and move on,
|
|
// since the note itself is already written.
|
|
if a.Wing != "" && a.Hall != "" {
|
|
if err := brain.BuildWingIndex(s.brainDir, a.Wing); err != nil {
|
|
slog.Warn("brain_write: auto-index failed", "wing", a.Wing, "err", err)
|
|
}
|
|
}
|
|
return json.Marshal(map[string]string{"path": relPath})
|
|
}
|
|
|
|
type brainIndexArgs struct {
|
|
Wing string `json:"wing,omitempty"`
|
|
}
|
|
|
|
func (s *Server) brainIndex(ctx context.Context, args json.RawMessage) (json.RawMessage, error) {
|
|
var a brainIndexArgs
|
|
if len(args) > 0 {
|
|
if err := json.Unmarshal(args, &a); err != nil {
|
|
return nil, fmt.Errorf("parse args: %w", err)
|
|
}
|
|
}
|
|
if a.Wing == "" {
|
|
if err := brain.BuildAllWingIndexes(s.brainDir); err != nil {
|
|
return nil, fmt.Errorf("index: %w", err)
|
|
}
|
|
return json.Marshal(map[string]any{"status": "ok", "scope": "all"})
|
|
}
|
|
if err := brain.BuildWingIndex(s.brainDir, a.Wing); err != nil {
|
|
return nil, fmt.Errorf("index: %w", err)
|
|
}
|
|
return json.Marshal(map[string]any{"status": "ok", "scope": a.Wing})
|
|
}
|
|
|
|
type brainIngestRawArgs struct {
|
|
Source string `json:"source"`
|
|
Pages []pipeline.RawPage `json:"pages"`
|
|
DryRun bool `json:"dry_run,omitempty"`
|
|
}
|
|
|
|
func (s *Server) brainIngestRaw(ctx context.Context, args json.RawMessage) (json.RawMessage, error) {
|
|
var a brainIngestRawArgs
|
|
if err := json.Unmarshal(args, &a); err != nil {
|
|
return nil, fmt.Errorf("parse args: %w", err)
|
|
}
|
|
if a.Source == "" {
|
|
return nil, fmt.Errorf("source is required")
|
|
}
|
|
if len(a.Pages) == 0 {
|
|
return nil, fmt.Errorf("pages must be non-empty")
|
|
}
|
|
result, err := pipeline.RunRaw(s.brainDir, a.Source, a.Pages, a.DryRun)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("ingest: %w", err)
|
|
}
|
|
pages := result.Pages
|
|
if pages == nil {
|
|
pages = []string{}
|
|
}
|
|
warnings := result.Warnings
|
|
if warnings == nil {
|
|
warnings = []string{}
|
|
}
|
|
return json.Marshal(map[string]any{"pages": pages, "warnings": warnings})
|
|
}
|
|
|
|
type brainIngestArgs struct {
|
|
Content string `json:"content,omitempty"`
|
|
Source string `json:"source,omitempty"`
|
|
Path string `json:"path,omitempty"`
|
|
DryRun bool `json:"dry_run,omitempty"`
|
|
}
|
|
|
|
func (s *Server) brainIngest(ctx context.Context, args json.RawMessage) (json.RawMessage, error) {
|
|
var a brainIngestArgs
|
|
if err := json.Unmarshal(args, &a); err != nil {
|
|
return nil, fmt.Errorf("parse args: %w", err)
|
|
}
|
|
if a.Path != "" && a.Content != "" {
|
|
return nil, fmt.Errorf("path and content+source are mutually exclusive")
|
|
}
|
|
if a.Path == "" && a.Content == "" {
|
|
return nil, fmt.Errorf("either path or content+source is required")
|
|
}
|
|
if s.pipeline.Complete == nil {
|
|
return nil, fmt.Errorf("LLM not configured: set INGEST_LLM_URL")
|
|
}
|
|
|
|
if a.Path != "" {
|
|
text, err := extract.Text(a.Path)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("extract: %w", err)
|
|
}
|
|
source := a.Source
|
|
if source == "" {
|
|
source = filepath.Base(strings.TrimSuffix(a.Path, filepath.Ext(a.Path)))
|
|
}
|
|
return s.runIngest(ctx, text, source, a.DryRun)
|
|
}
|
|
if a.Source == "" {
|
|
return nil, fmt.Errorf("source is required when content is provided")
|
|
}
|
|
return s.runIngest(ctx, a.Content, a.Source, a.DryRun)
|
|
}
|
|
|
|
type sessionLogArgs struct {
|
|
SessionID string `json:"session_id"`
|
|
Skill string `json:"skill,omitempty"`
|
|
Phase string `json:"phase,omitempty"`
|
|
ProjectRoot string `json:"project_root,omitempty"`
|
|
FinalStatus string `json:"final_status,omitempty"`
|
|
FilePath string `json:"file_path,omitempty"`
|
|
ModelUsed string `json:"model_used,omitempty"`
|
|
DurationMs int64 `json:"duration_ms,omitempty"`
|
|
Message string `json:"message,omitempty"`
|
|
}
|
|
|
|
func (s *Server) sessionLog(ctx context.Context, args json.RawMessage) (json.RawMessage, error) {
|
|
var a sessionLogArgs
|
|
if err := json.Unmarshal(args, &a); err != nil {
|
|
return nil, fmt.Errorf("parse args: %w", err)
|
|
}
|
|
if a.SessionID == "" {
|
|
return nil, fmt.Errorf("session_id is required")
|
|
}
|
|
entry := session.Entry{
|
|
SessionID: a.SessionID,
|
|
Timestamp: time.Now().UTC(),
|
|
Skill: a.Skill,
|
|
Phase: a.Phase,
|
|
ProjectRoot: a.ProjectRoot,
|
|
FinalStatus: a.FinalStatus,
|
|
FilePath: a.FilePath,
|
|
ModelUsed: a.ModelUsed,
|
|
DurationMs: a.DurationMs,
|
|
Message: a.Message,
|
|
}
|
|
dir := filepath.Join(s.brainDir, "sessions")
|
|
if err := session.Append(dir, a.SessionID, entry); err != nil {
|
|
return nil, fmt.Errorf("append: %w", err)
|
|
}
|
|
return json.Marshal(map[string]string{"status": "ok", "session_id": a.SessionID})
|
|
}
|
|
|
|
func (s *Server) runIngest(ctx context.Context, content, source string, dryRun bool) (json.RawMessage, error) {
|
|
result, err := pipeline.Run(ctx, s.pipeline, s.brainDir, content, source, dryRun)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("ingest: %w", err)
|
|
}
|
|
pages := result.Pages
|
|
if pages == nil {
|
|
pages = []string{}
|
|
}
|
|
warnings := result.Warnings
|
|
if warnings == nil {
|
|
warnings = []string{}
|
|
}
|
|
return json.Marshal(map[string]any{"pages": pages, "warnings": warnings})
|
|
}
|