indx documentation
Draft v0.1 · 2026-05-03
A self-hostable, AI-native knowledge vault — Obsidian-compatible on disk, agent-driven by design. Every operation a human can do in the UI must be doable by an agent in one tool call.
Product Requirements →
Vision, users, journeys, and scope for v1.
Technical Specification →
Surfaces, data model, vault layout, indexes, security, sizing.
Functional Requirements →
Traceable FR-IDs across vault, search, schemas, agents, infra.
Non-Functional Requirements →
Performance, reliability, security, observability, portability.
HTTP API →
REST + SSE under
/v1, designed AI-first.CLI →
Command surface for ingest, search, agents, and ops.
MCP Server →
Tools, resources, and prompts for LLM runtimes.
Implementation Plan →
Phasing, milestones, and execution checklist.
Epics & Stories →
BMAD-format epics with BDD acceptance criteria.