API Reference¶

This page brings together two different reference surfaces:

Python model reference generated from the codebase.
Tool parameter reference for the public MCP commands.

Use this page when you need precise signatures. If you want the narrative workflow, start with Tools or Quickstart first.

Python models¶

mcp_zen_of_docs.domain.contracts ¶

Domain-owned business contracts for framework and primitive semantics.

FrameworkName ¶

Bases: StrEnum

Supported documentation framework identifiers.

Attributes:

Name	Type	Description
`MKDOCS_MATERIAL`		Material for MkDocs — feature-rich theme with plugin ecosystem.
`ZENSICAL`		Zensical — opinionated Markdown-first docs framework.
`DOCUSAURUS`		Docusaurus — React-based documentation site generator by Meta.
`SPHINX`		Sphinx — Python documentation generator with reStructuredText roots.
`VITEPRESS`		VitePress — Vite-powered static site generator for Vue projects.
`STARLIGHT`		Starlight — Astro-based documentation framework.
`GENERIC_MARKDOWN`		Generic Markdown — plain Markdown without a specific framework.

AuthoringPrimitive ¶

Bases: StrEnum

Common authoring primitives used in documentation content.

Each member represents a discrete content construct that documentation frameworks may support at varying levels.

Attributes:

Name	Type	Description
`FRONTMATTER`		YAML frontmatter block at the top of a Markdown file.
`HEADING_H1`		Top-level H1 heading.
`ADMONITION`		Callout or alert block (note, warning, tip, etc.).
`CODE_FENCE`		Fenced code block with optional language identifier.
`NAVIGATION_ENTRY`		Entry in the site navigation or sidebar.
`SNIPPET`		Reusable inline or block content snippet.
`TABLE`		Markdown or HTML table.
`TASK_LIST`		GitHub-flavoured task list with checkboxes.
`IMAGE`		Embedded image with alt text and optional caption.
`LINK`		Inline hyperlink or cross-reference.
`FOOTNOTE`		Footnote reference and definition pair.
`TABS`		Tabbed content panels.
`DIAGRAM`		Embedded diagram (Mermaid, Graphviz, PlantUML).
`API_ENDPOINT`		Structured API endpoint reference block.
`STEP_LIST`		Numbered step-by-step procedure list.
`BADGE`		Inline status badge (build, version, license).
`CARD_GRID`		Grid of visual info cards (Material/Zensical-specific).
`BUTTON`		Styled hyperlink rendered as a button.
`TOOLTIP`		Hover tooltip attached to inline text.
`MATH`		LaTeX or MathML mathematical expression.
`FORMATTING`		Inline text formatting (bold, italic, strikethrough).
`ICONS_EMOJIS`		Inline icon or emoji shortcode.

SupportLevel ¶

Bases: StrEnum

Framework support coverage classification.

Attributes:

Name	Type	Description
`FULL`		The primitive is natively and completely supported.
`PARTIAL`		The primitive is supported with caveats or limited feature parity.
`EXPERIMENTAL`		Support exists but is unstable or behind a feature flag.
`UNSUPPORTED`		The primitive is not supported by the framework.

PrimitiveTranslationGuidance ¶

Bases: BaseModel

Domain guidance contract for primitive syntax translation.

Carries support levels and optional rendered snippets for both source and target frameworks, along with actionable migration hints derived from domain rules and framework-specific knowledge.

Attributes:

Name	Type	Description
`source_support_level`	`SupportLevel`	Support classification in the source framework.
`target_support_level`	`SupportLevel`	Support classification in the target framework.
`source_snippet`	`str \| None`	Rendered primitive snippet for the source framework, or `None` when the primitive is unsupported.
`target_snippet`	`str \| None`	Rendered primitive snippet for the target framework, or `None` when the primitive is unsupported.
`hints`	`list[str]`	Ordered list of actionable migration guidance strings.

mcp_zen_of_docs.models ¶

Pydantic model layer for tool request/response contracts.

PipelineContext ¶

Bases: ModelBase

Shared context passed between pipeline tools for chaining.

Each tool in the pipeline (detect → plan → scaffold → compose → enrich → validate → score) populates relevant fields so the next tool can auto-configure without requiring the user to re-specify parameters.

ToolSignature ¶

Bases: ModelBase

Tool name and argument signature.

LinkIssue ¶

Bases: ModelBase

Issue found while validating documentation links.

StructureIssue ¶

Bases: ModelBase

Issue found while validating document structure.

QualityIssue ¶

Bases: ModelBase

Issue raised during documentation quality scoring.

Tool parameters¶

Quick-reference for all 10 MCP tools. For narrative explanations and workflow guidance, see the Tools section.

detect¶

detect(mode="full", project_root=".")

Modes: full · context · readiness

profile¶

profile(
    mode="show",
    framework=None,
    primitive=None,
    source_framework=None,
    target_framework=None,
    topic=None,
    resolution_mode=None,
)

Modes: show · resolve · translate

scaffold¶

scaffold(
    mode="write",
    doc_path=None,
    title=None,
    topic=None,
    description="",
    audience=None,
    framework=None,
    docs_root="docs",
    mkdocs_file="mkdocs.yml",
    sections=None,
    content_hints=None,
    add_to_nav=True,
    overwrite=False,
    output_path=None,
    pages=None,
    sections_to_enrich=None,
    content="",
)

Modes: write · single · batch · enrich

validate¶

validate(
    mode="all",
    docs_root="docs",
    mkdocs_file="mkdocs.yml",
    project_root=".",
    fix=False,
    required_frontmatter=None,
    required_headers=None,
    checks=None,
    nav_mode="audit",
    external_mode="report",
)

generate¶

generate(mode, ...)

Use the dedicated generate page for the full mode-by-mode surface.

onboard¶

onboard(project_root=".", framework=None, ...)

theme¶

theme(mode, output_dir="docs/stylesheets", ...)

copilot¶

copilot(mode, output_dir=".github", ...)

docstring¶

docstring(mode, target=None, ...)

story¶

story(mode, prompt, ...)

Next reference surfaces¶

Read Tools for workflow context.
Read profile when you need primitive-level support and snippet resolution.
Read Frameworks when you are comparing framework behavior at a higher level.