Anydocs Documents
快速开始

AI 协作工作流

用一条通用流程说明如何让 Claude Code、Codex 等助手安全参与 Anydocs 写作。

先安装 MCP 并注册 server,再读项目约束,然后通过 MCP 安全写入页面、导航和状态,这是 Anydocs 中 AI 协作的默认路径。

Steps

  1. 安装并注册 MCP server
  2. 初始化项目并准备 agent 入口
  3. 先读取项目 contract
  4. 建立内容与导航上下文
  5. 通过页面与导航工具写入
  6. 把发布动作单独拆开
  7. 验证面向用户与 AI 的交付结果

安装并注册 MCP server

在让 AI 助手参与写作之前,需要先在运行环境中注册 Anydocs MCP server。安装方式参考安装页面中的 MCP 快捷命令。常见的注册配置如下:

codex mcp add anydocs -- npx -y @anydocs/mcp
claude mcp add -s user anydocs -- npx -y @anydocs/mcp

初始化项目并准备 agent 入口

用 `init` 创建项目;如果要给特定 agent 生成最小 guide 文件,可在初始化时带上 `--agent`。

先读取项目 contract

让 agent 先调用 `project_open`,确认允许的块类型、模板、语言、resources 和 authoring guidance。

project_open({ projectRoot: "/path/to/project" })

建立内容与导航上下文

继续读取 `page_list`、`page_get`、`page_find`、`nav_get`,先知道当前页面和导航结构,再决定改哪一部分。

通过页面与导航工具写入

创建或修改页面时优先使用模板工具、页面工具和导航工具,而不是直接改 `pages/<lang>/*.json` 或 `navigation/*.json`。

把发布动作单独拆开

内容确认后再调用 `page_set_status`,把目标页面切到 `published`;不要通过 `page_update` 改状态。

page_set_status({ projectRoot: "/path/to/project", lang: "zh", pageId: "guide", status: "published" })

验证面向用户与 AI 的交付结果

最后用 `preview` 或 `build` 检查 reader 页面、搜索索引、`llms.txt`、`llms-full.txt` 与 `mcp/*.json` 是否都反映了最新的 published 内容。

边界: 内容编辑和状态切换应始终是两个动作。先写内容,再决定是否发布。
分工: AI 最适合起草、改写、补 metadata 和整理导航;人工最适合做事实核对、品牌语气判断和最终审批。