Skip to content

Framework-aware documentation, rendered with intent

MCP Zen of Docs

The map should calm the reader before it instructs them.

Like a path through cedar mist with Fuji holding the horizon, mcp-zen-of-docs gives your AI tools a calm sense of place before they write a single line.

It reads the framework you already have, then returns the syntax that actually belongs on the page in front of you.

Get started Browse tools Why this exists

A quiet Mount Fuji scene above cedar forest and mist, rendered in the mcp-zen-of-docs palette.

  • Detect & Profile

    Identify the docs framework that is actually present, then resolve the right primitive syntax before an assistant writes a single line.

    detect · profile

  • Generate & Theme

    Create pages, diagrams, SVG assets, and theme files that fit the target framework instead of generic Markdown defaults.

    generate · theme

  • Validate & Score

    Check links, frontmatter, navigation sync, and quality signals before a docs change ships.

    validate

Why this exists

AI assistants are good at writing Markdown. They are not automatically good at writing the right dialect of Markdown for the site in front of them.

Ask for a note on a Docusaurus page and an assistant might return MkDocs syntax. Ask for tabs in Starlight and it might answer with a VitePress container. The wording can be excellent while the rendered result is still broken.

mcp-zen-of-docs fixes that problem by turning framework context into a first-class input. It detects the docs stack, loads the matching authoring profile, and gives every tool the rules it needs to emit native syntax for 22 canonical documentation primitives.

If you want the longer case for why this matters, start with Why Zen Docs.

Advanced features

System setup

Onboard inherited docs without reverse-engineering the stack

onboard combines context detection, readiness checks, scaffolding, and theme wiring so a new or inherited docs project can become AI-ready in one guided pass.

Explore onboard · Start with quickstart

Source truth

Translate primitives across frameworks

Use profile to compare support levels, render native snippets, and translate constructs like admonitions, tabs, and card grids between framework dialects.

Read profile · Compare frameworks

Visual layer

Generate assets and themes that belong to the docs system

Create SVGs, badges, diagrams, and brand-aware theme files so the docs site feels designed, not assembled from disconnected snippets.

Read generate · Read theme

Workflow memory

Keep AI output aligned across long-running documentation work

Use copilot, docstring, and story to encode conventions, close code-doc drift, and turn rough prompts into structured long-form docs.

Copilot assets · Docstring coverage · Narrative docs

Tools at a glance

Tool What it does Best starting use
detect Detect framework context and readiness First call in any new project or session
profile Query primitive support and render native snippets Resolve framework-specific syntax before writing
scaffold Create, enrich, or fully write docs pages Generate a correct page skeleton quickly
validate Audit quality, frontmatter, links, and nav state Gate docs changes before merge
generate Produce diagrams, SVGs, changelogs, and reference assets Build the visual and reference layer
onboard Bootstrap docs structure and configuration Stand up a new or inherited docs site
theme Generate CSS/JS theme files and configuration Apply a coherent visual system
copilot Create Copilot instruction, prompt, and agent assets Preserve docs conventions in AI-assisted work
docstring Audit and generate Python docstrings Improve API reference readiness
story Compose narrative docs from prose intent Turn rough ideas into structured long-form pages

See Tools Overview for the full reference and workflow map.

Get started in 30 seconds

uvx --from mcp-zen-of-docs mcp-zen-of-docs-server

Add it to GitHub Copilot in VS Code:

{
  "servers": {
    "zen-of-docs": {
      "command": "uvx",
      "args": ["--from", "mcp-zen-of-docs", "mcp-zen-of-docs-server"]
    }
  }
}

Then ask your assistant to run the standard workflow:

detect → profile → act

For installation targets, MCP client setup, and the first real workflow, continue to Quickstart.

  • Quickstart

    Connect the server, run the first tool call, and see the workflow end to end.

    Get started

  • Frameworks

    Compare the primary profiles and the supplemental detected contexts.

    Compare frameworks

  • Guides

    Learn the concepts behind Detect → Profile → Act and the 22 canonical primitives.

    Browse guides