Docsbook
概览

MCP 工具参考

本页面列出了 Docsbook MCP 服务器在 https://docsbook.io/api/mcp/server 上公开的所有工具。该服务器公开了309 个工具。每个工具都需要通过 OAuth 2.0 + PKCE 进行 Bearer 身份验证。

计费列出了调用所计入的类别，费用从项目自身余额中扣除：

类别 涵盖内容
包含 发现和连接 — 永不计费
读取 读取 Docsbook 已存储的页面、设置或注册表行
写入 更改内容、配置、目标或注册信息
分析 扫描事件数据仓库：漏斗、旅程、留存和信息源
外发 离开 Docsbook 的网络 — 获取 URL 或触发实际发送
探测 收集某一类事实并将其标准化，过程中不涉及模型
AI 由模型支持：由模型为你编写、读取或排名的内容
代理 完整的一次代理运行：数分钟的工作、一份报告及其自身的运行记录

每个类别的当前费率已公布在 Docsbook 定价页面上。余额不足而被拒绝的调用会明确说明这一点；本页面上的任何内容都不受其他条件限制。

要从 Claude Code 进行连接：

mcp add --transport http https://docsbook.io/api/mcp/server

工作区与品牌#

工具 计费 描述
get_info 包含 服务器功能、版本、可用工具列表
list_workspaces 包含 已认证用户的所有工作区及其功能
get_workspace 包含 按 ID 或 owner/repo 获取单个工作区
create_workspace 包含 从 GitHub 仓库创建工作区
update_branding 写入 颜色、字体、徽标、图标、默认主题、行动号召 URL、站点源 URL、产品平均价格
update_ui_settings 写入 切换页眉、搜索、反馈、复制按钮和面包屑导航
update_navigation 写入 页眉链接、社交链接、子页眉文件夹标签（可选图标）、左侧边栏页面/文件夹图标，以及侧边栏标签覆盖设置 — 重命名页面或文件夹在侧边栏中的显示名称，而不移动其地址或在树中的位置
update_ai_settings 写入 启用 AI 聊天、设置提供商和 API 密钥、选择模型 — 包括使用您自己的提供商密钥
update_seo 写入 SEO 元标签、站点地图、OpenGraph
update_access 写入 将工作区设为私有；设置密码和/或使用您自己的 SSO/OIDC 身份提供商
update_domain 写入 附加或移除自定义域名
update_languages 写入 启用用于 AI 翻译的目标语言

内容和文档#

工具 计费 描述
search_docs 人工智能 在工作区的文档内容中进行全文/正则表达式/标题/路径搜索。只读——无论读写范围如何，任何令牌均可使用。
search 人工智能 在工作区的文档内容中进行语义（基于嵌入）搜索——根据含义而非字面关键词重叠来查找页面。读取预先构建的向量索引（搜索时不会重新建立索引）。只读，所有计划均可使用；对于公共网站，在仓库范围的端点上无需令牌即可提供服务。当未构建或启用索引时，它会改用全文搜索回答，而不是拒绝请求，并且 mode（semantic / lexical）会说明作出响应的引擎。
get_doc_outline 读取 在搜索或写入之前，列出每个 Markdown 页面的标题、标题数量和大小。只读——无论读写范围如何，任何令牌均可使用。
write_docs 人工智能 在一次原子 Git 提交中，将一个或多个 Markdown 文件提交到工作区的文档仓库。要求使用具有读写范围授权的令牌——只读令牌会被拒绝。接受可选的 intent：即人员用自己的话提出的请求。它会显示在更改面板中对应的提交旁边，因此编辑背后的目标不会随着产生该编辑的对话结束而消失。
fetch_url 出站 读取一个公共网页，并将其作为整洁的 Markdown 返回，同时提供其标题、描述以及重定向后的最终 URL。用于针对工作区之外的页面核实某项声明——例如竞争对手的定价、你自己的网站，或文档所依赖的链接是否仍然有效。404 或登录墙会作为明确说明的结果返回，而不是作为失败返回，因为当问题是某个链接是否有效时，这本身就是答案。拒绝私有地址和内部地址，遵守 robots.txt，并将页面内容视为数据，绝不视为指令。
list_sources 读取 列出此工作区连接的、作为事实来源的仓库和网站，以及构建该网站所使用的仓库。每个条目都包含所有者本人对其连接原因的备注。只读。在写入或更新文档之前调用它：已连接的来源是你可以前往读取的事实，而不是需要回忆的内容。
read_source 出站 读取其中一个来源。没有 path 的仓库会返回其可读取的文件，有该项的仓库则返回该文件；没有 path 的网站会从自身站点地图中发现其多个页面，并以 Markdown 形式返回这些页面，范围限定为已连接的部分。保护措施与 fetch_url 相同——拒绝私有地址，遵守 robots.txt，将页面内容视为数据，绝不视为指令。
connect_source 写入 将仓库、网站或单个页面连接为事实来源——list_sources 随后会列出它，read_source 会读取它，而配备 enable_agent 的代理会监视它。在存储 GitHub 仓库之前，会先证明其可读（公开可读，或使用本项目已经持有的 GitHub 授权）；尚未获得任何人授权的私有仓库会被拒绝，并同时给出解决问题所需的唯一事项，而不是将其存储为不可读状态。note 是所有者本人对该来源用途的描述，之后读取它的所有组件都会将其作为指令读取。要求使用读写令牌。
configure_source 写入 重命名已连接的来源，改写其 note，暂停它（enabled: false——保持连接，但不读取任何内容），或完全断开它（移除附加到它的任何 GitHub 授权）。通过 list_sources 中的 source_id，或通过 match（其标签或 URL 中的某个词）来识别来源。要求使用读写令牌。

如果代理已将你的文档检出到磁盘，需要进行更深入的本地图导航（大纲、模糊标题、链接引用、解析链接），请改用 markdown-lsp——运行 npx markdown-lsp <subcommand> ./docs，即可在工作树上公开 LSP 风格的 doc_* 工具。有关设置，请参阅 markdown-lsp README。search_docs/write_docs 与 markdown-lsp 互为补充：前者通过托管的 MCP 连接工作，无需本地检出；后者需要磁盘上的仓库。

问题跟踪器#

文档所基于的 GitHub 仓库中的问题——项目中尚未完成的工作。这是一个发现能够超越产生它的对话而持续存在的地方：刚刚审查完文档的代理可以记录它发现的问题，而不是将其留在聊天记录中。

管理面板的 问题 部分读取和写入的也是这三个工具，因此从 Claude Code 提交的问题会显示在该表格中，反之亦然。

工具 计费 描述
list_issues 读取 列出项目仓库中的问题——未关闭、已关闭或全部问题，也可以按标签筛选。拉取请求绝不会包含在内。只读。在 create_issue 之前调用它：重复一个已存在的未关闭问题，比不创建问题更糟糕。
get_issue 读取 完整读取一个问题——包括其完整正文、标签、状态和链接。只读。根据 list_issues 返回的 280 个字符预览采取行动，就会落实请求中错误的部分。
create_issue 写入 在项目仓库中提交一个问题，包括标题、Markdown 正文和标签。需要使用具有 读写 范围权限的令牌授权——只读令牌会被拒绝。每个问题调用一次。返回问题编号和链接。

由 Docsbook 托管的网站，其问题存放在 Docsbook 为其托管的仓库中；从你自己的仓库构建的网站使用该仓库，而 MCP 调用在其中以 Docsbook 自己的账户身份执行——这足以读取公共仓库并在其中创建问题；对于私有仓库，则会返回明确的权限错误，而不是空列表。

AI 聊天#

工具 计费 描述
get_chat_system_prompt 读取 读取工作区的聊天系统提示词
set_chat_system_prompt 写入 替换聊天系统提示词
set_chat_hooks 写入 配置 LLM 前置/后置钩子
test_chat_hook 出口 使用合成负载运行钩子

翻译#

工具 计费 描述
set_translation_mode 写入 auto（内置 AI）或 external（Webhook 流程）
list_pending_translations 读取 等待批准的翻译
get_translation 读取 按语言和路径获取一条翻译
upload_translation 写入 上传外部生成的翻译
approve_translation 写入 发布待处理的翻译
delete_translation 写入 移除翻译

分析与可观测性#

工具 计费 描述
get_analytics 分析 一段时间内的浏览量、访客数、热门页面和引荐来源
get_ai_usage 分析 AI 聊天和翻译的使用情况，以及余额剩余量
get_ai_questions 分析 向 AI 聊天提出的所有问题
get_ai_unanswered 分析 AI 无法回答的问题
get_negative_feedback 分析 收到差评反馈的页面
get_failed_searches 分析 返回零结果的搜索查询
get_popular_searches 分析 按频率排列的热门搜索查询
get_page_journeys 分析 读者在页面之间的导航路径
query_events 分析 对平台事件数据仓库执行的任意查询

Webhook#

注册 Webhook 不收取任何保留费用；只有出站传送和重放会作为出口流量计量。

工具 计费 描述
register_webhook_<event> 写入 为 18 种类型化事件中的一种注册 Webhook（HMAC 密钥 + URL）
list_webhooks 读取 列出工作区中已注册的 Webhook
unregister_webhook 写入 移除 Webhook 订阅
list_webhook_deliveries 分析 包含状态、重试次数和有效负载的传送历史记录
replay_webhook_delivery 出口流量 重新传送特定的历史传送记录
test_webhook 出口流量 向 URL 发送合成有效负载

共有 18 种类型化事件，其中包括 content.indexed、translation.completed、chat.no_answer、chat.negative_feedback 和 usage.limit_approaching——完整列表和有效负载架构请参阅 Webhook。

技能发现#

工具 计费 描述
find_skill 已包含 按 query 搜索 docs-skills 目录，可选择使用 category 和 requires_plan 过滤器。返回 raw_url，供代理直接获取 SKILL.md。

操作工具——工作的一步，一个工具#

135 个只读工具。每个工具都针对一个主题执行一个操作，而不是涵盖整个学科：observe_link_graph 报告页面之间的边缘关系，decide_next_market 选择一个市场并说明为什么不是其他市场，draft_comparison_page 编写页面。调用者选择的是一个步骤，而不是一个部门。

这一系列工具由三个轴交叉构成，每个工具都会声明自己在这三个轴上的位置：

  • 动词决定答案的形式，以及本次运行拒绝执行的内容。
  • 领域决定主题和所读取的证据。
  • 结果——支持负载、自然流量、AI 引用、回答时间、转化率以及另外八项指标——是购买该工具要推动变化的数值，并且会在工具自身的描述中明确说明。
动词 回答内容 拒绝内容
observe_* 有什么，以及每一行的来源 提出任何建议
explain_* 背后的机制，而不是重复陈述相关性 无法指向具体步骤的故事
discover_* 缺少什么，具体到足以构建 “更多关于 X 的内容”
decide_* 一个选择，以及每个被排除选项及其原因 返回排序列表而不是做出决策
plan_* 有序序列，第一步是一次调用 在第一个可能使计划失效的事项之后继续规划
draft_* 成品本身，可直接应用 交回一份简报却称其为草稿
measure_* 由我们计算、可在不同运行之间比较的记分卡 编写分数，或用零填补缺口
verify_* 相对于对照对象的判断，并允许结论为“时机过早” 在时间窗口过短时贸然使用“已确认”
learn_* 可迁移的规则，以及它停止适用的位置 没有边界的经验教训
handoff_* 确切的调用、参数和验收检查 无法说明其验收测试的工作

每个工具返回的都是经过验证的 JSON 载荷，而不是一段散文：一个 evidence 映射，其中包含本次运行收集的所有原始事实，以及只能陈述其所引用证据中出现的数字的声明。无法追溯来源的数字会使本次运行失败，而不是被发布，因此你无需额外检查虚构的数字。

对于会评分的工具——十五个 measure_* 工具，每个领域一个——分数由我们根据收集的证据及载荷中公布的权重计算，而不是由模型编写。模型给出的 0-100 分无法与同一模型下周给出的分数进行比较，这会破坏评分唯一的意义：观察其变化。无法检查的轴会报告为未测量，而绝不会报告为零。

全部 135 个工具都不会执行任何更改，并使用只读令牌：整个运行期间都会拒绝写入操作。它们每一个都按 Agent 类别计费。其中包括 draft_*，它会生成页面或区块，并指出将应用该内容的调用（run_docs_create / run_docs_manage），而不是自行应用。每一行都带有该调用，因此分析结果无需人工在中间进行转换即可交接。

每个工具都根据其声明的工作内容定价——它读取多少类证据、可能进行多少次模型往返、是否会离开你的网站、是否会输出成品——因此，狭窄的观察只需支付深度草稿的一小部分成本，而不是每个操作都采用统一的代理费用。等待时间也以同样的方式不同，下面会列出每个工具的典型等待时间。每个工具当前的价格都会显示在面板中以及 Docsbook 定价页面上。

产品 & 能力地图#

工具 它唯一能告诉你的内容 典型等待时间
observe_capability_inventory 每项产品实际提供的能力各占一行，旁边列出记录该能力的页面——以及没有对应页面时的空白。 ~41 秒
explain_capability_confusion 读者为何会询问产品已经具备的功能背后的机制——使现有能力变得不可见的确切措辞、位置或缺失。 ~45 秒
discover_undocumented_capabilities 产品中已经存在但在文档中无处可见的能力，每项都以足够具体的名称列出，明天即可据此撰写页面。 ~45 秒
decide_capability_priority 下一项要记录的能力，列出所有严肃的备选项以及每个选项落选的原因。 ~26 秒
plan_capability_page_set 一项能力实际需要的页面集合——同样重要的是，它不需要哪些页面——以及这些页面应当撰写的顺序。 ~39 秒
draft_capability_matrix 一页完成的能力矩阵——每项能力、其状态、计划门槛和页面链接一应俱全，并以可直接提交的 Markdown 格式呈现。 ~52 秒
measure_capability_coverage 可重复使用的评分表，用五个由不同人员确定的维度，评估文档实际覆盖了产品的多少内容。 ~45 秒
verify_capability_claims 对于文档声称具备的每项能力，判断产品是否仍然提供该能力，并附上能够定论的来源。 ~52 秒
handoff_capability_backlog 为下一位执行者打包好的能力工作：确切的调用、其参数，以及如何确认调用成功。 ~20 秒

待完成的任务#

工具 只有它能告诉你的信息 典型等待时间
observe_reader_jobs 读者用自己的话表达的任务——来自助手问题和搜索——经过分组、计数，并逐字引用。 ~32 s
explain_job_abandonment 某项任务无法继续完成的位置，以及导致其停止的机制——读者离开前遇到的步骤、缺失的前置条件或句子。 ~42 s
discover_unserved_jobs 你的产品能够服务、但文档完全没有涉及的任务——从能力推导到读者，因为无人服务的任务不会留下可供衡量的痕迹。 ~48 s
decide_primary_job 这份文档应围绕组织的唯一任务，同时列出相互竞争的任务，并说明拒绝每项任务的代价。 ~32 s
plan_job_journey 承载一项任务从首次接触到完成的有序页面序列，并标出该序列中的缺口。 ~33 s
draft_job_walkthrough 完整编写的任务演练页面，从头到尾服务于一项任务，明确说明每个前置条件，并确保每个步骤都可验证。 ~55 s
measure_job_completion 用于评估有任务的读者是否真正完成任务的记分卡——进入、继续、死胡同、声明的结果以及回访。 ~39 s
verify_job_now_served 为某项任务编写的页面是否确实改变了读者的行为——前后、时间窗口、控制组、结论。 ~36 s
learn_job_patterns 文档能够良好服务这些任务背后的规则，以可迁移的方式表述——以及该规则不再成立的边界。 ~32 s

主题权威#

工具 只有它能告诉你的信息 通常等待时间
observe_topic_inventory 该语料库涵盖的每个主题、涉及该主题的页面数量、最深页面的层级，以及链接到该主题的页面数量。 约 32 秒
explain_authority_shortfall 为什么这个语料库读起来像是一个提到某个主题的网站，而不是专门介绍该主题的网站——以及造成这种印象的具体缺失之处。 约 39 秒
discover_missing_entities 某个主题所需、但该语料库从未提及的实体——读者期望真正的权威来源了解的概念、工具、格式和失败模式。 约 39 秒
decide_topic_cluster_focus 下一步应构建的唯一主题集群、已命名的竞争对手，以及拒绝每个竞争对手的原因。 约 32 秒
plan_topic_cluster 中心页及其分支：该集群所需的每个页面、各自负责的内容、相互链接的方式，以及撰写顺序。 约 33 秒
draft_topic_hub_page 编写完成的中心页本身：定义、子主题地图，以及将该集群构建成图的链接。 约 46 秒
measure_topical_depth 用于评估该语料库是否能被视为其主题权威来源的可重复评分：定义、覆盖范围、关系、证据和连通性。 约 36 秒
verify_cluster_effect 你构建的集群是否真正取得了成果——在指定时间窗口内，依据排名、访问量或引用，并与对照组进行比较。 约 36 秒
learn_authority_wins 该网站赢得这些主题背后的规则——这些页面具备而其他页面不具备的要素，以及该规则不再适用的范围。 约 32 秒

搜索意图#

工具 它独有的告知内容 典型等待时间
observe_query_intents 该网站被哪些查询找到，并按每个查询所承载的意图分类——操作指南、定义、比较、错误、价格、参考。 ~32 秒
explain_intent_mismatch 为什么一个获得排名的页面最终仍会失去读者——问题的形式与页面的形式之间存在的具体差距。 ~36 秒
discover_intent_gaps 读者确实带着哪些意图到达，而该网站上没有任何页面针对这些意图进行构建和回答。 ~36 秒
decide_page_shape 鉴于实际到达该页面的意图，它必须是教程、操作指南、参考资料、解释文章还是比较文章中的哪一种，并列出被排除的页面形式。 ~26 秒
plan_intent_coverage 能够覆盖该网站吸引到的各种意图的页面有序集合，每个页面都针对其中一个意图进行精准构建。 ~30 秒
draft_intent_matched_opening 根据页面实际获得排名的意图，对页面的标题、描述和首屏内容进行重写——完整写出，可直接应用。 ~39 秒
measure_intent_match 衡量读者看到的页面与其到达时所带意图匹配程度的评分卡，基于观察结果从五个维度计算得出。 ~36 秒
verify_intent_fix 基于意图的重写是否确实改变了点击或参与度——同时纳入对照组，并考虑搜索数据的延迟。 ~36 秒
handoff_intent_rewrites 将意图重写打包为行动项：哪个页面、改成什么内容，以及该改动必须赢得的查询。 ~20 秒

程序化 SEO#

工具 它唯一能告诉你的信息 典型等待时间
observe_page_families 该网站上已经沿某个轴重复出现的 URL 模式，以及现有成员数量和该轴实际包含的成员总数。 约 26 秒
explain_thin_family_pages 某个系列的生成成员表现不佳的原因——在其中大多数成员中为空、相同或虚构的字段。 约 36 秒
discover_scalable_patterns 该产品可以大规模回答的重复搜索模式——轴、查询模板，以及每个成员所承载的独特事实。 约 48 秒
decide_family_worth_building 对提议创建的系列是否应当构建给出一个结论，同时列出备选方案，并预先说明终止条件。 约 30 秒
plan_family_rollout 发布计划：首先上线哪些成员、为它们提供数据的来源、保护措施是什么，以及检查点在哪里。 约 42 秒
draft_family_template 模板本身——页面骨架、每个成员的变量，以及两个完整渲染的成员示例。 约 58 秒
measure_family_coverage 每个系列的评分卡：轴的覆盖程度、成员之间的差异性、相互链接的完善程度，以及事实信息的时效性。 约 32 秒
verify_family_indexation 生成的成员是否确实可访问并已被编入索引——实时抓取，并逐一列出未达到要求的成员。 约 45 秒
learn_family_thresholds 在该网站上，生成成员达到什么阈值后才能获得任何价值——以规则形式说明，并列出背后的案例。 约 32 秒

免费工具#

工具 它唯一能告诉你的信息 典型等待时间
observe_tool_demand 读者已经提出的、具有工具形式的需求——计算、转换、验证、生成、检查——并对其进行引用和计数。 约 32 秒
explain_tool_underuse 现有免费工具未被使用的原因——阻止读者找到或完成使用流程的入口、阻力或不匹配之处。 约 45 秒
discover_tool_ideas 本产品可信地托管的免费工具，每个工具都明确其要回答的查询以及实现该功能所需的数据。 约 48 秒
decide_tool_to_build 确定一个要构建的工具，以理由驳回其余方案，并在任何人开始之前说明所选工具的维护成本。 约 39 秒
plan_tool_launch 上线方案：工具位于何处、哪些内容链接到它、之后会向读者提供什么，以及如何评估其成功。 约 33 秒
draft_tool_page 工具页面的撰写内容：首屏展示它的功能、示例演算、采用的方法和下一步操作，以及组件本身的嵌入规范。 约 58 秒
measure_tool_pull 工具实际带来的效果评分卡——到达量、完成率、后续转化、获得的链接以及独立可读性。 约 32 秒
verify_tool_traffic 工具上线是否带来了可衡量的变化——与对照组比较、在指定时间窗口内评估，并给出可能为“时机尚早”的结论。 约 32 秒
handoff_tool_build 为构建者指定的工具要求：输入、规则、输出、边界情况，以及必须通过的验收检查。 约 29 秒

原创研究#

工具 只有它能告诉你的内容 典型等待时间
observe_own_data_assets 该产品已经掌握、外部任何人都无法计算的数据——它涵盖什么、可追溯到多久以前，以及是否可以发布。 约 41 秒
explain_research_ignored 一项已发布的研究为何没有获得引用——缺失的方法、无法引用的格式，或没有一个别人可以复述的论断。 约 48 秒
discover_research_questions 你的自有数据能够回答、而其他人无法回答的问题；每个问题都注明能够回答它的数据切分方式，以及会再次传播该结论的受众。 约 45 秒
decide_research_to_publish 要开展的一项研究，同时列出被否决的问题，并坦诚说明风险：如果答案很无聊，会发生什么。 约 30 秒
plan_research_release 发布方案：要运行的数据切分、要说明的方法、要发布的产物，以及让它明年能够再次执行的节奏。 约 33 秒
draft_research_report 报告本身：用一句可引用的话概括核心论断，列出带分母的数字、方法和局限。 约 68 秒
measure_research_citations 一份关于已发布研究实际可引用程度的评分卡——可引用的论断、明确说明的方法、可获取的数据、日期信息和机器可读性。 约 45 秒
verify_research_claims 每个已发布的数字在重新运行相同数据切分时是否仍然成立——并逐一列出差异。 约 39 秒
learn_research_formats 哪些已发布内容被再次传播，其背后的规律是什么——格式、论断结构或发布模式——以及该规律在哪些地方不再适用。 约 39 秒

GEO / AI 搜索#

工具 它能告诉你的唯一信息 通常等待时间
observe_assistant_answers 答案引擎当前如何描述这个产品，以及它们引用了哪个来源来得出这一说法——包含原文引用、日期，以及生成该结果的问题。 ~46 秒
explain_citation_absence 为什么助手引用的来源不是这份文档——页面的具体哪项属性使其无法被引用。 ~48 秒
discover_quotable_atoms 这个语料库应该具备但实际缺失的自包含段落——一个问题对应一个完整答案，无需依赖相邻内容即可引用。 ~39 秒
decide_geo_surface_priority 应首先修复哪个机器可读界面——页面结构、llms.txt、结构化数据、信息源或爬虫访问权限——并对其余选项进行排序和排除。 ~39 秒
plan_geo_surfaces 机器可读界面上的有序工作流程，每一步都标明所涉及的设置或页面，以及证明其已生效的检查。 ~39 秒
draft_answer_blocks 可引用的段落本身——问题、完整答案、来源和日期——旨在整体提取后仍然准确。 ~55 秒
measure_ai_visibility 该产品在答案引擎中的存在度评分卡——存在性、准确性、归因、新鲜度，以及已覆盖问题的占比。 ~48 秒
verify_citation_gain GEO 工作是否改变了助手的说法——在前后分别提出相同的问题，并逐字比较答案。 ~45 秒
learn_citation_patterns 决定哪些页面会被引用的规则——结构、答案的位置、日期信息——以及它的适用边界。 ~45 秒

竞争对手与市场空白#

工具 只有它能告诉你的内容 典型等待时间
observe_competitor_docs 某个指定竞争对手的文档实际包含什么——章节、页面类型、他们记录而你没有记录的内容——已抓取并注明日期。 约 46 秒
explain_switching_objections 评估者在阅读两套文档时形成的具体异议——以及你方形成该异议的页面和句子。 约 48 秒
discover_market_gaps 你和指定竞争对手都没有满足的需求——并附有证据证明有人有此需求，却没有任何人回应。 约 52 秒
decide_positioning_wedge 本产品应主动邀请进行的一项比较，以及应拒绝的比较和拒绝每项比较的原因。 约 33 秒
plan_comparison_pages 值得制作的比较页面集合、每个页面必须包含哪些内容才可信，以及编写顺序。 约 39 秒
draft_comparison_page 根据抓取的证据撰写的比较页面本身——关于对方的每一项声明都注明日期并标明来源，包括对方胜出的情况。 约 58 秒
measure_competitive_coverage 一份评分卡，展示你的文档在评估者实际打开的各类页面上与指定竞争对手相比的表现。 约 48 秒
verify_competitor_claims 你的页面对竞争对手作出的声明如今是否仍然属实——逐项重新抓取，并列出已过时的声明。 约 42 秒
learn_competitor_moves 自上次查看以来竞争对手方面发生了哪些变化，以及这些变化背后的模式——明确说明接下来需要关注什么。 约 42 秒

用户语言#

工具 只有它能告诉你的内容 典型等待时间
observe_reader_vocabulary 读者实际输入和提问的原话及其计数，并列出你的文档用于表示同一事物的词。 约 29 秒
explain_term_misses 为什么读者使用的词没有返回任何结果，以及两个截然不同的原因究竟是哪一个：概念的名称不同，还是该概念完全不存在。 约 36 秒
discover_missing_synonyms 你已经记录的概念所对应的替代名称，这些名称在语料库中完全没有出现，并分别标明应收录它们的页面。 约 32 秒
decide_canonical_terms 每个概念对应一个规范名称，保留被舍弃的名称作为同义词而不是删除，并说明每项选择的理由。 约 30 秒
plan_terminology_migration 将命名决策逐步应用到整个语料库的有序计划，包括不得更改的页面及其原因。 约 30 秒
draft_glossary_entries 术语表条目本身——用一句新手可以理解和使用的话定义每个概念，并列出其同义词及负责该概念的页面。 约 52 秒
measure_vocabulary_alignment 一份评分卡，衡量语料库的语言与读者用语相差多远，包括对读者术语的覆盖率、我们用语的一致性，以及搜索能够解析其中多少内容。 约 32 秒
verify_renaming_effect 加入读者用语是否确实减少了失败——使用对照组比较前后的相同搜索。 约 32 秒
handoff_term_changes 将命名工作打包成调用：哪个页面、哪个词变成哪个词，以及之后必须不再失败的搜索。 约 20 秒

内容架构#

工具 它唯一能告诉你的内容 典型等待时间
observe_corpus_shape 语料库的实际形态：各个部分、每个分支的深度、页面大小，以及声明的导航实际触达了其中多少内容。 约 26 秒
explain_navigation_failure 读者为什么找不到内容——你声明的树状结构与读者实际浏览的路径之间存在的具体不匹配。 约 42 秒
discover_orphan_pages 没有任何链接指向的页面，以及读者能够到达却无法离开的页面——这两类页面分别位于从树内部无法看见的语料库两端。 约 32 秒
decide_structure_model 该语料库应采用的组织原则——按工作、产品领域、页面类型或受众组织——以及被否决的模型和它们带来的成本。 约 36 秒
plan_restructure 迁移清单：哪个页面应移到哪里、按什么顺序迁移，并将每个 URL 变更及其所需的重定向分别列出。 约 39 秒
draft_navigation_tree 完整列出的导航本身——包含使用读者用语的标签的完整树状结构，可直接应用。 约 42 秒
measure_findability 读者能否从进入的位置到达所需内容的评分卡——可达性、深度平衡、方向感、入口点和搜索备用方案。 约 39 秒
verify_restructure_effect 重构是否有所帮助——重构前后的相同可查找性和行为指标，同时检查重定向并设置对照部分。 约 45 秒
learn_structure_lessons 该语料库中有效部分背后的规则——它们如何分组、深入到什么程度、如何展开，以及该规则适用到哪里为止。 约 32 秒

内部链接#

工具 它唯一能告诉你的内容 典型等待时间
observe_link_graph 将语料库视为图：哪些页面链接到哪些页面、每个页面的入边和出边数量，以及图将哪些页面视为枢纽。 ~29 秒
explain_unreachable_pages 页面在实践中为何无法访问——缺失的边、无人点击的链接，或没有给出点击理由的锚文本。 ~36 秒
discover_missing_links 讨论同一实体但彼此没有链接的页面对——以及每一对中应插入链接的句子。 ~39 秒
decide_hub_pages 哪些页面会成为枢纽——其他页面都指向它们的页面——以及被拒绝的候选页面和拒绝原因。 ~30 秒
plan_linking_pass 链接处理流程：哪些页面会被编辑、按什么顺序编辑、每个页面增加多少链接，以及防止其变成链接垃圾的规则。 ~30 秒
draft_link_insertions 确切的编辑内容：对于每个页面，插入链接后句子的完整表述，包括锚文本和目标页面。 ~46 秒
measure_graph_health 链接图的评分卡——连通性、枢纽集中度、集群间交叉、锚文本质量，以及仅依赖导航的页面数量。 ~36 秒
verify_link_effect 内部链接处理是否带来了变化——与对照组相比，链接页面的到达量、死路率和排名的变化。 ~36 秒
handoff_link_edits 按页面打包成调用的链接编辑内容，并将验收检查表述为到达量或入站链接数量。 ~20 秒

信任（E-E-A-T）#

工具 只有它能告诉你的内容 典型等待时间
observe_trust_signals 页面实际具备哪些可信度材料——作者、日期、来源、带分母的数字、演算示例、明确说明的限制条件——逐页列出。 约 32 秒
explain_disbelief 读者为什么不相信一个事实正确的页面——未注明来源的数字、未说明的限制条件，或只有你提出的主张。 约 45 秒
discover_unsourced_claims 商业上重要的页面中，每一条没有来源、没有分母且没有日期的主张——逐条列出。 约 35 秒
decide_evidence_standard 每一类主张在发布前必须具备的证据——一次确定，并列出被否决的标准及其成本。 约 29 秒
plan_trust_upgrade 使页面达到证据标准的工作顺序，从实际消耗信任的页面开始。 约 30 秒
draft_evidence_blocks 重写后的主张本身——每条都附有来源、分母和日期，并在旁边说明限制条件。 约 55 秒
measure_trust 从五个维度评估可信度的记分卡——首先是可验证性，因为这是竞争对手无法在一个下午复制的要素。 约 45 秒
verify_claim_freshness 每一条带日期或数字的主张如今是否仍然成立——对照来源重新核查，并逐条列出已过时的内容。 约 48 秒
learn_trust_objections 读者对所有内容产生质疑时反复出现的异议模式——将其表述为一条关于该受众需要哪些证明的规则。 约 32 秒

反向链接 & 数字公关#

工具 只有它能告诉你的信息 典型等待时间
observe_inbound_mentions 目前在公开场合提及此产品的人、他们的说法，以及该提及是链接、提名还是引用。 ~42 秒
explain_unlinkable_pages 为什么没有人链接到某个页面——它缺少哪些关于这一主题进行写作的人所需要的内容。 ~45 秒
discover_link_targets 可能会提及此产品的具体渠道——每个渠道都附有他们会链接到的页面，以及他们愿意这样做的原因。 ~51 秒
decide_linkable_asset 为了获得引用应构建的唯一资产——数据、工具、定义或论点——以及被否决的选项和它们落选的原因。 ~39 秒
plan_outreach_sequence 按顺序排列的外联计划：联系谁、以什么顺序、提供什么内容，以及停止条件。 ~42 秒
draft_outreach_pitch 针对每个目标撰写的消息本身——提及对方的什么内容、提供什么，以及唯一的请求是什么。 ~51 秒
measure_linkability 对这一内容库可被引用程度的评分卡——独特事实、可定位章节、可引用格式、时效性和 URL 的持久性。 ~45 秒
verify_mention_gain 工作完成后是否确实出现了新的提及——再次搜索，与之前的集合进行比较，并附上引荐流量。 ~42 秒
handoff_pr_targets 为某个人打包的外联内容：目标对象、对方的页面、起草的消息、请求，以及回复意味着什么。 ~33 秒

市场拓展#

工具 它唯一能告诉你的信息 典型等待时间
observe_audience_origins 读者已经来自哪里——国家、语言、引荐来源——以及各群体来到这里后表现出多大差异。 ~32 秒
explain_market_stall 为什么一个已经到达的市场没有转化——是语言、示例、定价假设，还是缺少的证明阻止了转化。 ~42 秒
discover_adjacent_markets 这个产品本可以服务、但完全没有触达的受众——每个受众都附有需求确实存在的证据，以及必须通过的门槛。 ~48 秒
decide_next_market 下一步要进入的一个市场，其他市场则被排除，并在任何人做出承诺前说明这一选择的持续成本。 ~36 秒
plan_market_entry 进入计划：哪些页面优先推出，除了语言之外还必须本地化什么，以及决定是否继续的检查点。 ~33 秒
draft_market_landing 面向该市场的落地页，使用其语言，包含其示例、其货币，以及该市场所要求的证明。 ~46 秒
measure_market_readiness 用于评估文档是否已准备好服务某个市场的计分卡——覆盖范围、语言之外的本地化、证明、可发现性和维护情况。 ~36 秒
verify_market_traction 进入该市场是否带来了任何变化——该市场的到达量、结果和回报，并与对照组及明确的时间窗口进行比较。 ~36 秒
learn_expansion_lessons 在这里取得成效的市场背后的规则——为它们做了哪些而没有为其他市场做的事情——以及该规则的边界。 ~32 秒

大多数工具都接受一个可选的、用你自己的话填写的 request，它会缩小运行范围但不会替代该方法；此外还需要该问题所需的类型化输入（path、path_prefix、pages、competitors、window_days）。不符合自身契约的负载会被报告为失败，并列出违规项——绝不会作为结果为空的成功答案，因为“没有发现问题”读起来就像“网站没问题”。

收集器——证据，而非对证据的解读#

该系列下有五款工具，单独归入更低的计费类别Probe：collect_page_text、collect_corpus_map、collect_assistant_questions、collect_traffic和collect_onsite_search。它们会返回操作本应读取的规范化行数据，以及一个reproduce块，其中列出每一行背后所对应的确切调用——整个流程中没有模型，因此其中没有任何内容需要怀疑。在决定是否购买对这些数据的解读之前，如果你想先获得数据本身，就购买其中一款。audit_geo也从上一代产品中保留下来：它的证据层采用代码而非模型，并能回答答案引擎是否根本能够抓取你的页面。

后台代理运行#

find_skill 将 SKILL.md 交给你的代理执行。这些工具则相反：它们在 Docsbook 端针对你的工作区运行该技能，并使用编写该技能时所需的完整管理工具集——因此，即使没有连接任何其他 Docsbook 工具的助手，也能完成工作。

每次 run_docs_* 调用都会立即返回 { run_id, state }。它不会返回结果——工作需要几分钟，而将启动报告为答案的调用方，报告的是尚未发生的工作。使用返回的 run_id 轮询 get_agent_run。

工具 计费 描述
run_docs_analyze 代理 运行 docs-analyze 技能：根据真实数据审计网站，并报告存在的问题及其成本。声明为审计模式——整个运行期间都会拒绝写入操作，因此可以使用只读令牌。
run_docs_create 代理 运行 docs-create 技能：从你的网站、代码仓库、其他文档平台，或仅凭产品名称构建文档。会提交页面——需要读写令牌。
run_docs_manage 代理 运行 docs-manage 技能：根据写作和网站运行规则手册重写页面并配置网站。需要读写令牌。
run_docs_automate 代理 运行 docs-automate 技能：设置漂移防护、事件订阅、传入变更检查、警报和持续监控。需要读写令牌。
get_agent_run 读取 单次运行的状态（queued、running、succeeded、failed、canceled、expired）、运行期间的实时进度，以及成功后完整的结果：报告、它执行的每项操作，以及网站发生的变化。
list_agent_runs 读取 你最近的运行记录，按最新时间优先排列。使用它可以在启动第二次运行前检查该任务是否已经在运行。
cancel_agent_run 读取 停止尚未完成的运行。它不会撤销运行已经执行的操作——已经提交的页面仍会保持提交状态。

一次运行归启动它的账户所有：其他账户的 run_id 读取结果与未知运行完全相同。尚未启动的排队运行如果在几小时内仍未开始，就会过期而不会延迟运行，因为审计回答的是提出问题时网站状态下的问题。一次运行只会尝试一次，绝不会重试——失败的运行可能已经提交了页面，而第二次尝试会将这些页面提交两次。

常驻代理#

上面的工具按请求运行一次。这两个工具会启用一条常驻路线，使其自动运行——按计划运行、在此工作区发出事件时运行，或在连接的仓库有新提交时运行——使用的目录与管理面板的 Agents 选项卡所显示并启用的目录相同。

工具 计费 描述
find_agent 读取 按你想要的结果搜索此工作区可以启用的路线目录（“让文档与仓库保持同步”、“翻译”、“监控流量”）。每个结果都包含 state——此工作区是否已经启用该路线，以及启用的对象——这样你就能区分“没有监控仓库”和“已启用，但自周二以来一直失败”。在手动提议设置某项之前调用它：该路线通常已经存在。
enable_agent 写入 通过其 agent_key，从 find_agent 的目录中启用（或停用）一个代理。唤醒它的方式恰好是 schedule（cron 表达式，最快为每小时一次）、on_event（此工作区发出的某项内容）或 watch_source_id（来自 list_sources/connect_source 的已连接 GitHub 仓库——代理会在推送到该仓库的提交上运行）中的一种。在仓库上启用代理会记录其当前提交，因此首次运行是在下一次推送时，而不是重放其完整历史记录。enabled: false 会停用它，但不会忘记其配置方式。需要读写令牌。

Updated

此页面对您有帮助吗？

由...提供支持 Docsbook