Skip to main content

Module about

Module about 

Source
Expand description

What the executable says about itself, written once. The OpenAPI document’s info, the MCP initialize instructions, the HTTP index and the generated reference all read these sentences from here, so that no projection describes the surface in words of its own and none can drift from the others. Prose only: counts, URLs of a running server and anything else that is measured are added by the projection that measures it.

use majordomus_cli::about;

// one sentence, and every projection titles itself with it
assert_eq!(about::NAME, "Majordomus");
let text = about::description();
assert!(text.starts_with(about::SUMMARY));
// the description is the summary and every paragraph, so a projection that shows the
// description cannot be missing one a projection that shows the paragraphs has
assert!(about::PARAGRAPHS.iter().all(|p| text.contains(p)));

Constants§

LICENSE
The licence, from the crate manifest, as an SPDX identifier.
NAME
The product name, as every projection titles itself.
PARAGRAPHS
The paragraphs a reader of any projection should have, in order. CommonMark, as Swagger UI and the site render it; each entry is one paragraph.
REFERENCE_URL
Where the HTTP projection is explained for a person: the derived API reference on the documentation site, rendered from the OpenAPI document itself.
REPOSITORY
The source repository, from the crate manifest.
SUMMARY
One sentence: what is being served.

Functions§

description
The paragraphs as one CommonMark text.
writes
The sentence that says what writes the repository, given the MCP tools whose declared effect is a repository mutation, as the projection measured them from its registry.