Tools¶

Ten MCP tools. Multiple modes. One framework-aware documentation workflow.

Use this page as the operating map for the server. The dependable baseline is simple: detect the project, profile the primitive, then use the creation or quality tools that fit the job.

If you are new to the server, start with Quickstart, then come back here to choose the next tool intentionally.

All tools at a glance¶

Tool	What it does	When to use it
detect	Identify framework context and readiness	First step in any workflow
profile	Query primitive support and render native snippets	Before writing framework-specific markup
scaffold	Create or enrich docs pages	Generate a new page or fill gaps in an existing one
validate	Check links, frontmatter, navigation, and quality	Before merge or before publishing
generate	Produce diagrams, SVGs, changelogs, and reference assets	Build the visual and reference layer
onboard	Bootstrap a docs project and wire defaults	Starting from zero or inheriting a docs site
theme	Generate CSS/JS theme files and config	Apply a visual system without manual CSS archaeology
copilot	Create Copilot instruction, prompt, and agent assets	Encode documentation conventions for AI workflows
docstring	Audit and generate Python docstrings	Improve source-to-reference coverage
story	Compose narrative docs from prose intent	Turn rough product or technical ideas into structured docs

Recommended baseline

Use detect first, confirm the relevant primitive with profile, then move into scaffold, generate, story, or validate.

By category¶

Discovery¶

Tool	Primary use
detect	Identify the framework and project readiness signals
profile	Resolve primitive support, caveats, and native syntax

These tools provide the context that makes the rest of the workflow reliable.

Creation¶

Tool	Primary use
scaffold	Create or enrich docs pages
generate	Produce diagrams, SVGs, badges, changelogs, and reference assets
onboard	Stand up an AI-ready docs project structure

Use these when you are building pages, assets, or a full docs foundation.

Quality¶

Tool	Primary use
validate	Audit docs quality and structural correctness
docstring	Improve code-to-doc parity for Python APIs

Use these before publishing or when cleaning up an inherited docs set.

Workflow¶

Tool	Primary use
theme	Generate and wire a coherent visual layer
copilot	Preserve docs conventions in AI-assisted editing
story	Produce longer narrative documentation from intent

Use these to shape how documentation gets written, maintained, and visually expressed.

Typical workflows¶

Starting from scratch¶

detect → onboard → theme → validate

Use detect to confirm the environment, onboard to scaffold the docs surface, theme to establish the presentation layer, and validate to catch structural issues before publishing.

Adding a new page¶

detect → profile → scaffold → validate

profile is the key step here: it resolves the primitive rules that keep the page native to the detected framework.

Improving an existing docs set¶

detect → validate → scaffold enrich → docstring → validate

Start with the gaps you can measure, then use generation and enrichment tools to close them.

Migrating between frameworks¶

detect → profile translate → story/scaffold → validate

Translation is strongest when the source and target frameworks are both explicit. Keep Detect → Profile → Act nearby for the operating model.

How they connect¶

The tools are designed to cooperate, not to act as isolated commands.

detect establishes source-truth context.
profile resolves what the current framework can support.
Creation tools use that context to write native output.
Quality tools surface what still needs attention.

For the conceptual model behind that flow, read Detect → Profile → Act and Authoring Primitives.

What to read next¶

detect

Start here when you need framework context or readiness signals.

Read detect
profile

Resolve primitives, support levels, and framework-native snippets.

Read profile
Guides

Step back from the commands and learn the mental model.

Browse guides