How It Works

Index is a pipeline for turning setup intent into workspace memory that humans can inspect and agents can query.

ProfileChoose the workspace shape and default feature bundle.

→

TemplatesCopy docs, registries, runbooks, evals, MCP, and workspace records.

→

WorkspaceReplace placeholders with owners, paths, dates, links, and decisions.

→

ValidationRun targeted checks for docs, metadata, generator output, and MCP behavior.

→

MCP ContextExpose approved docs and repo entries as read-only agent context.

Mermaid Source

flowchart LR
  Profile["Profile"]
  Templates["Templates"]
  Workspace["Generated Workspace"]
  Validation["Validation"]
  MCP["MCP Context"]
  Agent["Agent Use"]

  Profile --> Templates --> Workspace --> Validation --> MCP --> Agent

Design Principle

The workspace should be useful before it is complete. A generated Index repository starts with predictable paths and checks, then becomes valuable as teams replace starter copy with evidence.

Source Of Truth

Step	Source
Profile defaults	generator/profiles/*.yml
File templates	generator/templates/
CLI behavior	generator/create-index.mjs
Workspace checks	scripts/validate-workspaces.mjs
MCP resources and tools	mcp/src/