Skip to main content

Module docs

Module docs 

Source
Expand description

Documentation reads for the MCP server.

Serves the repository’s own documentation — the README and the documentation tree — driven by the bring-your-own [governance].readme and [governance].docs configuration. Locations are configured, never hardcoded: an unset path degrades to a null/empty result rather than a transport error (the degradation contract, design D4).

read_doc is confined to the configured documentation directory: the requested path is resolved under that directory, canonicalised, and verified to still lie within it, so ../absolute escapes are refused before any file outside the directory is read.

Structs§

DocEntry
One documentation entry returned by list_docs.

Functions§

list_docs
Lists Markdown documents under the configured documentation directory.
read_doc
Reads one document confined to the configured documentation directory.
read_readme
Reads the configured README.