Expand description
Generated reference documentation.
Renders Markdown appendices directly from the in-code single sources of
truth (the MCP tool registry and the Config schema) so the published
reference can never drift from the actual feature surface.
mcp-tools.md— every registered MCP tool, frommanifest_value().config-keys.md— every recognizedconfig.tomlkey, fromConfigSchema.
Used by the gen_docs example (writes the files) and by drift tests /
the CI gate (compare on-disk vs. freshly rendered).
Functions§
- config_
keys_ markdown - Markdown reference for every recognized
config.tomlkey, rendered from theConfigschema (types, defaults, allowed values, env overrides). - content_
matches - True when on-disk content equals freshly generated content, ignoring line-ending differences. Windows checkouts may store the committed docs with CRLF while the generator emits LF; the drift gate compares content, not byte-exact line endings.
- generated_
dir - Directory the generated reference docs live in (
docs/reference/generated). - generated_
docs - Every generated reference document as
(filename, markdown)pairs. This is the canonical list shared by the writer and the drift tests. - mcp_
tools_ markdown - Markdown reference for every registered MCP tool (granular profile), rendered from the same manifest the editors consume.