ElBruno.MempalaceNet: Instructions file for GitHub Copilot

GitHub Copilot Instructions for MemPalace.NET

This file provides high-level guidance for GitHub Copilot agents integrating MemPalace.NET into .NET applications.

---

Overview

MemPalace.NET is a local-first AI memory library that:

• Stores everything verbatim (no summarization)
• Searches semantically using vector embeddings
• Organizes knowledge in a hierarchical structure (wings → rooms → drawers)
• Runs locally by default with ONNX embeddings (no API keys required)
• Integrates with Microsoft.Extensions.AI and Microsoft Agent Framework

---

Installation

# NuGet package
dotnet add package mempalacenet --version 0.5.0-preview.1

# CLI tool
dotnet tool install -g mempalacenet --version 0.5.0-preview.1

---

Basic Usage Patterns

1. Initialize a Palace

using MemPalace;

// Create a new palace (SQLite backend with ONNX embeddings)
var palace = await Palace.Create("~/my-palace");

// Or specify custom configuration
var config = new PalaceConfig
{
    Path = "~/my-palace",
    EmbedderType = EmbedderType.Local, // ONNX (default)
    Backend = BackendType.Sqlite       // SQLite (default)
};
var palace = await Palace.Create(config);

2. Store Memories

// Store a simple memory
await palace.Store(
    content: "Alice joined the engineering team in Q1 2024",
    wing: "team-updates"
);

// Store with metadata
await palace.Store(
    content: "User reported bug: login form crashes on Safari",
    metadata: new Dictionary<string, object>
    {
        { "source", "github-issues" },
        { "issue_id", "GH-42" },
        { "priority", "high" }
    },
    wing: "bugs"
);

// Store in a room (subcategory)
await palace.Store(
    content: "Meeting notes: Q1 planning session",
    wing: "meetings",
    room: "planning"
);

3. Semantic Search

// Basic semantic search
var results = await palace.Search(
    query: "Who joined the team recently?",
    wing: "team-updates",
    limit: 5
);

foreach (var result in results)
{
    Console.WriteLine($"Score: {result.Score:F3}");
    Console.WriteLine($"Content: {result.Memory.Content}");
    Console.WriteLine($"Wing: {result.Memory.Wing}");
    Console.WriteLine();
}

// Hybrid search (semantic + keyword)
var hybridResults = await palace.Search(
    query: "React hooks",
    wing: "docs",
    limit: 10,
    mode: SearchMode.Hybrid
);