用途:为 gofastmcp.com 撰写或修订 docs/ 下的页面,适用于新增功能文档、修复文档问题、重写页面或审查页面。
主要能力:文档站是基于 Mintlify、由 docs/ 构建的站点;页面只有被 docs/docs.json 列出才存在,功能只有被页面记录才算存在。docs/python-sdk/** 由机器人根据 docstring 生成,应改 docstring 而非页面。
使用方式: 先定位归属页面再决定是否新建。用 rg -l "<feature>" docs --glob '!docs/python-sdk/' --glob '!docs/v2/' --glob '!docs/v3/**' 查找;功能属于既有页面主题就扩展它,有独立主题才新增页面。阅读同一 docs.json 分组内两个相邻页面,对齐其章节顺序与标题层级。按模板写作:前置元数据含 title、sidebarTitle、description、icon,引入 VersionBadge 并标注引入版本;先用一段说明要解决的问题与适用时机,再给用法。
约定与限制: 每个代码块都要可运行,导入齐全、名称已定义、一块一个要点;中间值提取为具名变量而非嵌套调用。正文用第二人称、现在时、陈述句,首句点明段落要点,重要信息写在正文而非代码注释;裸 {} 需加反引号,因 Mintlify 会当作 JSX。无障碍要求:img 与 提供说明性 alt,装饰性媒体加 aria-hidden="true",标题逐级递进,链接文字指明目的地,表格有表头行,代码围栏标注语言,图表配文字说明,自定义 CSS 保持文字 4.5:1 对比度且动画置于 prefers-reduced-motion 之下。
校验: 运行 (cd docs && npx --yes mint@latest broken-links) 与 uv run pytest tests/docs -n 0。前者捕获死链与 MDX 解析错误并给出文件行号;后者解析 docs/ 中每个 Python 块并解析所有 fastmcp 导入。不应运行的块在围栏上加 test="skip"。涉及视觉改动时在 docs/ 下运行 npx --yes mint@latest dev,并以 1280px 与 390px、明暗两种模式查看页面。
注意: VersionBadge 标记功能引入时间,旧徽章保留,属历史而非过期。docs/v2/ 与 docs/v3/ 是早期大版本的冻结快照,维护版本只在其添加变更日志条目。版本选择器标签位于 docs/docs.json 的 navigation.versions[0].version,需手动升级。4.x 中协议类型包的真实名称是 mcp_types。合并不等于上线:站点服务的是 published-docs;来自 main 的稳定发布会对 published-docs 开 Publish FastMCP v<version> docs PR 由维护者合并,发布间的纯文档改动遵循 .agents/skills/release/SKILL.md 中 Publishing docs by hand;最终以 Deploy docs 运行结论判断站点是否变更。