Guides for operators, MCP client authors, and library embedders.
| Guide | Description |
|---|---|
| TOOLS.md | All MCP tools, parameters, success/error shapes, suggest-flow, multi-source |
| CONFIGURATION.md | Environment variables, CLI flags, resolveConfig, multi-source mode, deployment profiles |
| SECURITY.md | API keys, log redaction, Docker hardening, reporting issues |
| CONTRIBUTING.md | Local dev, tests, lint/format, PR expectations |
| CI_CD.md | GitHub Actions, CodeQL, SBOM, Codecov, releases |
| FAQ.md | Common questions |
| MIGRATION.md | Breaking changes and upgrade paths |
| deprecation-policy.md | Deprecation window, semver, CHANGELOG conventions |
| templates/breaking-change-release-notes.md | GitHub Release body template for breaking versions |
| RELEASING.md | npm publish via GitHub Releases |
The main README.md remains the high-level overview; deep reference lives here.