Documentation

This repository follows the shared documentation standard:

This file documents repository-specific documentation rules only.

Repository Rules

README.md must stay concise and act as the main human entry point.
AGENTS.md must stay operational and tell AI agents which files to read first.
Topic-specific documentation must live in the matching file under docs/.
Shared engineering rules must be linked from mpt-extension-skills instead of copied into this repository.
When changing setup, usage, testing, or architecture behavior, update the corresponding document in the same change.
docs/usage.md is the source of truth for installation, configuration, general usage examples, and supported command entry points.
docs/streaming.md is the source of truth for the streaming read mode: when to stream, the wire formats, consumer obligations, timeouts, and streaming examples. docs/usage.md carries only a short orientation and links here, so streaming guidance must not be duplicated there.

README.md: overview, quick start, and documentation map
AGENTS.md: AI-agent entry point and reading order
usage.md: install, configure, and use the client
streaming.md: streaming read mode — access pattern, wire formats, consumer obligations, and timeouts
architecture.md: repository structure and major abstractions
local-development.md: Docker-only local setup and execution
testing.md: repository-specific testing strategy
contributing.md: repository workflow and shared-standard links
rql.md: RQL query builder guide

Prefer updating the smallest relevant document instead of creating overlapping summary files.