MCP Zen Of Docs

mcp-zen-of-docs

📝 Write documentation the way the framework intended.

______________________________________________________________________

一 用于AI助手的MCP服务器 这将为您的编辑器带来文档质量工具。 将其连接到Claude Desktop、VS Code Copilot或Cursor，您的AI可以检测到您的框架， 原生语法的脚手架页面、验证结构和生成视觉资源——所有这些都在对话中。

• 4个主要框架概况 --Zensical、Docusaurus、VitePress、星光
• 3个补充检测到的上下文 --MkDocs材质、Sphinx和通用Markdown
• 22个规范创作原语 -前台、选项卡、图表、API端点块、徽章等
• 10个复合MCP工具 --检测、分析、脚手架、验证、生成、机载、主题、副驾驶、文件串、故事
• 530+次测试 始终具有pytest和Pydantic v2类型的安全性
• CLI接口 用于本地脚本、CI管道和独立运行

为什么选择MCP

MCP将文档质量从独立报告转变为交互式创作循环。 编辑器调用 mcp-zen-of-docs 直接——你的AI 检测框架，以其本机语法构建页面，验证它，并生成 所有资产都在同一个对话中。

• 减少上下文切换 --无需离开编辑器即可进行脚手架、验证和评分。
• 框架原生输出 --没有通用的Markdown；每个代码段都使用正确的语法。
• 始终如一的质量 --同样的十条禅宗原则适用于每一页，每一次。

禅宗哲学

Zen of Docs将文档质量视为工程约束，而不是风格偏好。 每个框架配置文件都对编写原语进行编码，使文档在该框架中易于维护 生态系统，有一个质量评分器，可以在发货前发现结构性问题。

• 框架原生质量 而不是通用的Markdown linting。
• 原始第一脚手架 除了复制粘贴模板。
• 可操作评分 通过《文献禅》的十大原则。

该项目由 文档禅 --驱动每一个工具决策的十条语言无关原则。

快速入门

# MCP server (IDE and agent workflows)
uvx --from mcp-zen-of-docs mcp-zen-of-docs-server

# CLI without installing
uvx --from mcp-zen-of-docs mcp-zen-of-docs --help

# Or install globally
pip install mcp-zen-of-docs

# Scaffold a documentation page
mcp-zen-of-docs scaffold doc --doc-path docs/new-page.md --title "My Page"

# Validate your docs
mcp-zen-of-docs validate all --docs-root docs

# Score documentation quality
mcp-zen-of-docs validate score --docs-root docs

MCP工具概览

MCP服务器公开 10个复合工具 在整个文档生命周期中：

查看完整 API 参考 用于参数、模式和示例。

选择你的道路

命名指南

保持这些名称不同，以避免设置混淆：

• 包名: mcp-zen-of-docs
• CLI命令: mcp-zen-of-docs
• MCP服务器命令: mcp-zen-of-docs-server
• 兼容性CLI别名: mcp-zen-of-docs-cli
• MCP客户端服务器密钥: zen-of-docs

安装

MCP集成

将服务器添加到MCP客户端配置中。

克劳德桌面版

添加 claude_desktop_config.json:

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

VS Code

添加 .vscode/mcp.json:

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

光标

添加 .cursor/mcp.json:

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

一键（VS代码）

码头工人

# MCP server via Docker
docker run --rm -i ghcr.io/anselmoo/mcp-zen-of-docs:latest

# CLI via Docker
docker run --rm ghcr.io/anselmoo/mcp-zen-of-docs:latest mcp-zen-of-docs --help

文档

完整文档： ****

发展

uv sync --group dev --group docs
uv run --group dev pytest
uv run --group dev ruff check .
uv run --group docs zensical serve

贡献

许可证

麻省理工学院

______________________________________________________________________