How It Works
Index keeps source-controlled knowledge readable by people while exposing approved material to agents through a read-only MCP interface.
Knowledge Flow
- Maintainers record durable context in Markdown and structured metadata.
index.jsondefines ownership, approved content roots, registries, lifecycle, and enabled interfaces.- Contract, documentation, and workspace checks catch broken paths, malformed records, invalid dates, and unsafe metadata keys.
- MCP and Slack expose approved documentation and repository records through the same read-only search service.
- Clients can list, read, and search that context without gaining write access.
Source Of Truth
| Surface | Source |
|---|---|
| Management contract | index.json |
| Documentation | docs/ |
| Repository registry | repos/index.yaml |
| Workspace schema | schemas/workspace.schema.json |
| Workspace checks | scripts/validate-workspaces.mjs |
| MCP and Slack runtime | mcp/src/ |
Design Principle
Prefer evidence-backed files with stable paths over knowledge that exists only in chat history or individual memory.