Files

1348 lines
71 KiB
JSON
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{
"version": 1,
"source": {
"kind": "explicit",
"name": "dws-agent-selection/doc",
"repository": "DingTalk-Real-AI/dingtalk-workspace-cli",
"channel": "open-source",
"reviewed": true
},
"tools": {
"doc.add_permission": {
"agent_summary": "兼容入口:为文档空间节点添加协作成员权限;文件管理权限命令已迁移到 drive。",
"use_when": [
"给单篇文档做节点级授权(与 drive permission add 同能力的 doc 入口)时"
],
"avoid_when": [
"知识库容器授权用 wiki member add",
"查/改/移除用 permission list/update/remove"
],
"examples": [
"dws doc permission add --node <DOC_ID> --users uid1 --role READER --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.add_permission",
"cobra-help:dws doc permission add",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.add_permission",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.add_permission"
]
},
"doc.copy_document": {
"agent_summary": "兼容入口:复制文档或文件;文件复制能力已迁移到 drive。",
"use_when": [
"用户要复制文档/文件并保留原位置时(尤其保形复制模板:copy + rename + block update)",
"目标文件夹 --folder 或知识库根 --workspace;都不传则默认「我的文档」"
],
"avoid_when": [
"要搬走不留副本改用 dws doc move 或 dws drive move",
"跨钉盘整理文件优先 dws drive copy"
],
"examples": [
"dws doc copy --node <DOC_ID> --folder <TARGET_FOLDER_ID> --format json",
"dws doc copy --node <DOC_ID> --workspace <TARGET_WS_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.copy_document",
"cobra-help:dws doc copy",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.copy_document",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.copy_document"
]
},
"doc.create_comment": {
"agent_summary": "创建文档评论",
"use_when": [
"在文档上创建不绑定具体划词位置的全文评论,可 @用户或通过 --mentioned-open-conversation-id @群"
],
"avoid_when": [
"针对某段选中文本的划词评论改用 create-inline(需 blockId+start/end)",
"回复已有评论用 reply;删评论用 delete"
],
"examples": [
"dws doc comment create --node <DOC_ID> --content \"这里需要修改\" --format json",
"dws doc comment create --node <DOC_ID> --content \"请review\" --mention uid1,uid2 --mentioned-open-conversation-id <openConversationId> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.create_comment",
"cobra-help:dws doc comment create",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.create_comment",
"structured-hint:internal/cli/schema_hints/imported/wukong.json#doc.create_comment",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc-comment.create_comment"
]
},
"doc.create_document": {
"agent_summary": "在默认根目录、文档文件夹或知识库根创建带可选初始内容的 adoc",
"use_when": [
"用户要新建文字在线文档(adoc),可空文档或用 --content-file 写入明确要求的初始 Markdown/JSONML;用户显式要求正文 H1 时必须保留,不能用 --name 替代",
"已知目标文档文件夹 --folder 或知识库 --workspace;长 Markdown 仍直接使用本命令,由原生写入管道自动分片;返回 nodeId 绑定同一请求的后续 list/insert/export,后续可观察操作仍须分别执行"
],
"avoid_when": [
"创建表格/脑图/白板/多维表/演示改用 dws wiki node create --type <type>(勿用 doc create)",
"只管理知识库空节点或层级时用 wiki node create;本命令侧重创建并写入 adoc",
"导入本地 Word/Markdown 并保留服务端转换语义时用 dws doc import;不要用自写分片脚本替代原生 create"
],
"examples": [
"dws doc create --name \"项目周报\" --format json",
"dws doc create --name \"Q1 总结\" --content-file ./q1.md --workspace <WORKSPACE_ID> --format json"
],
"reviewed": true,
"review_reason": "人工对齐当前 Cobra 原生内容写入管道、显式正文 H1、同请求新 nodeId 绑定和可观察块操作边界;强调长内容无需外部分片,不改变命令身份、参数或安全事实。",
"source_refs": [
"CommandRegistry:canonical_path=doc.create_document",
"cobra-help:dws doc create",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.create_document",
"structured-hint:internal/cli/schema_hints/imported/wukong.json#doc.create_document",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.create_document"
]
},
"doc.create_file": {
"agent_summary": "创建文件(文档/表格/脑图/白板/多维表/文件夹等)",
"use_when": [
"兼容入口:按类型创建文件节点时(已弃用,改用 wiki node create)"
],
"avoid_when": [
"请改用 dws wiki node create --workspace <id> --type <type>",
"纯文字带内容创建用 doc create"
],
"examples": [
"dws doc file create --name \"项目周报\" --type adoc --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.create_file",
"cobra-help:dws doc file create",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.create_file",
"structured-hint:internal/cli/schema_hints/imported/wukong.json#doc.create_file",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.create_file"
]
},
"doc.create_folder": {
"agent_summary": "创建文件夹",
"use_when": [
"兼容入口:创建文件夹(已弃用)时"
],
"avoid_when": [
"个人空间/钉盘改用 dws drive mkdir;知识库改用 wiki node create --type folder"
],
"examples": [
"dws doc folder create --name \"项目资料\" --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.create_folder",
"cobra-help:dws doc folder create",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.create_folder",
"structured-hint:internal/cli/schema_hints/imported/wukong.json#doc.create_folder",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.create_folder"
]
},
"doc.create_inline_comment": {
"agent_summary": "在文档选中文本范围创建划词评论",
"use_when": [
"针对块内某段文本创建划词评论(必填 blockId、start、end)时"
],
"avoid_when": [
"不绑定位置的全文评论用 create",
"先 block list 取 blockId 与纯文本偏移再调用"
],
"examples": [
"dws doc comment create-inline --node <DOC_ID> --block-id <BLOCK_ID> --start 0 --end 10 --content \"这里需要修改\" --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.create_inline_comment",
"cobra-help:dws doc comment create-inline",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.create_inline_comment",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc-comment.create_inline_comment"
]
},
"doc.delete_comment": {
"agent_summary": "永久删除指定文档中的一条评论",
"use_when": [
"用户明确要求永久删除指定文档中的某条评论(已有 commentKey)时"
],
"avoid_when": [
"只需改文案用 update;回复用 reply;目标评论不明或未确认时不要删"
],
"examples": [
"dws doc comment delete --node <DOC_ID> --comment-key <COMMENT_KEY> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.delete_comment",
"cobra-help:dws doc comment delete --help",
"skills/mono/references/products/doc/doc-comment.md",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc-comment.delete_comment"
]
},
"doc.delete_document": {
"agent_summary": "兼容入口:将文档或文件移入回收站;文件删除能力已迁移到 drive。",
"use_when": [
"用户明确要求用 doc delete 兼容入口将文档/文件移入回收站,且已确认目标时"
],
"avoid_when": [
"常规文件删除优先 dws drive delete;本入口仅为兼容",
"用户未确认或目标不清时不要删",
"删块用 doc block delete;删评论用 doc comment delete"
],
"examples": [
"dws doc delete --node <DOC_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.delete_document",
"cobra-help:dws doc delete",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.delete_document",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.delete_document"
]
},
"doc.delete_document_block": {
"agent_summary": "删除块元素(不可逆)",
"use_when": [
"用户确认后删除文档中指定块元素时"
],
"avoid_when": [
"未确认或 blockId 不明时不要删;先 block list",
"删整篇文档用 doc/drive delete"
],
"examples": [
"dws doc block delete --node <DOC_ID> --block-id <BLOCK_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.delete_document_block",
"cobra-help:dws doc block delete",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.delete_document_block",
"structured-hint:internal/cli/schema_hints/imported/wukong.json#doc.delete_document_block",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.delete_document_block"
]
},
"doc.download_doc_attachment": {
"agent_summary": "获取文档附件的临时下载链接",
"use_when": [
"获取文档正文中附件的临时下载 URL(resourceId 来自 block list attachment)时"
],
"avoid_when": [
"下载钉盘普通文件用 drive download;导出在线文档用 doc export"
],
"examples": [
"dws doc media download --node <DOC_ID> --resource-id <RESOURCE_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.download_doc_attachment",
"cobra-help:dws doc media download",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.download_doc_attachment",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.download_doc_attachment"
]
},
"doc.download_file": {
"agent_summary": "兼容入口:下载钉盘或文档空间已有文件;文件下载能力已迁移到 drive。",
"use_when": [
"兼容入口:获取文件下载凭证(已迁移场景优先 drive download)时"
],
"avoid_when": [
"常规下载普通文件改用 dws drive download --output ...",
"在线文档导出 docx 用 doc export"
],
"examples": [
"dws doc download --node <NODE_ID> --output ./report.pdf --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.download_file",
"cobra-help:dws doc download",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.download_file",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.download_file"
]
},
"doc.get_document_content": {
"agent_summary": "读取完整文档内容,或按 outline/range/section/tags 获取 JSONML fragment",
"use_when": [
"已由 drive info 确认 extension=adoc,用户要读取正文(Markdown)时",
"用户提供已知 adoc nodeId/URL,且要读取内容或抽取指定章节时",
"只需标题大纲、指定块区间/单块或特定 JSONML tags 时使用 --content-format jsonml 与 --scope"
],
"avoid_when": [
"原始 alidocs URL 类型未知或目标不是 adoc 时先用 drive info 探测并路由;表格/多维表/普通文件不要用本命令",
"要元信息用 doc info;要块结构用 doc block list",
"Markdown 为有损投影:保形复制模板请用 doc copy,不要 read→create"
],
"examples": [
"dws doc read --node <DOC_ID> --format json",
"dws doc read --node <DOC_ID> --content-format jsonml --scope outline --max-depth 3"
],
"reviewed": true,
"review_reason": "人工对齐 doc Skill 与 doc-info reference 的 extension 预检边界,并保留 Markdown/JSONML scope 的真实 Cobra 契约。",
"source_refs": [
"CommandRegistry:canonical_path=doc.get_document_content",
"cobra-help:dws doc read",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.get_document_content",
"structured-hint:internal/cli/schema_hints/imported/wukong.json#doc.get_document_content",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.get_document_content"
]
},
"doc.get_document_info": {
"agent_summary": "在已确认是 ALIDOC 后读取文档专属元信息",
"use_when": [
"drive info 已确认是 ALIDOC,用户还要标题、创建者、权限或 docUrl 等文档专属元信息时",
"创建响应只有 nodeId、缺少 docUrl,需要补查文档链接时"
],
"avoid_when": [
"原始 alidocs URL 的类型探测、extension 路由或可靠 fileSize 使用 dws drive info;不要先猜是文档",
"已确认是 adoc 且只要正文时改用 dws doc read",
"只要目录列表改用 dws drive list / wiki node list",
"普通文件、电子表格或 AI 表格不使用本命令"
],
"examples": [
"dws doc info --node <DOC_ID> --format json",
"dws doc info --node \"https://alidocs.dingtalk.com/i/nodes/<DOC_UUID>\" --format json"
],
"reviewed": true,
"review_reason": "人工对齐 drive info 统一类型探测入口与 doc info 的文档专属补查职责;不改变 node 参数或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.get_document_info",
"cobra-help:dws doc info",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.get_document_info",
"structured-hint:internal/cli/schema_hints/imported/wukong.json#doc.get_document_info",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.get_document_info"
]
},
"doc.import_get": {
"agent_summary": "根据 taskId 查询文档导入任务的执行结果",
"use_when": [
"查询文档导入任务结果(已有 taskId,导入超时/中断后兜底)时"
],
"avoid_when": [
"发起导入用 doc import(若入口可用);不要用本命令代替导入"
],
"examples": [
"dws doc import get --task-id <TASK_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.import_get",
"cobra-help:dws doc import get",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:none (Cobra+Skill; composite/unpinned)"
]
},
"doc.insert_document_block": {
"agent_summary": "向文档插入块元素",
"use_when": [
"用户明确要求在文档中插入新块(段落/标题/列表等)时;简单段落/标题用 --text/--heading,复杂块用 --element JSON",
"用户要求有序列表块时使用 JSONML p.list.isOrdered=true(同一 listId)或等价原生 orderedList 结构,不能用普通 Markdown 代替"
],
"avoid_when": [
"仅在用户没有指定块操作、只要整篇追加 Markdown 时优先 doc update --mode append;显式 insert/标题块/列表块不能折叠",
"插入本地文件附件优先 doc media insert",
"删块用 block delete;改已有块用 block update"
],
"examples": [
"dws doc block insert --node <DOC_ID> --text \"这是一段文字\" --format json",
"dws doc block insert --node <DOC_ID> --heading \"二级标题\" --level 2 --format json"
],
"reviewed": true,
"review_reason": "人工对齐显式 block insert 的可观察操作语义和有序列表原生结构;不改变命令身份、参数契约、接口绑定或 Runtime 门禁。",
"source_refs": [
"CommandRegistry:canonical_path=doc.insert_document_block",
"cobra-help:dws doc block insert",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.insert_document_block",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.insert_document_block"
]
},
"doc.list_comments": {
"agent_summary": "查询文档评论列表",
"use_when": [
"查看文档评论列表,可按全文/划词、已解决/未解决过滤时"
],
"avoid_when": [
"创建全文评论用 comment create;划词用 create-inline;回复用 reply;删除用 delete"
],
"examples": [
"dws doc comment list --node <DOC_ID> --format json",
"dws doc comment list --node <DOC_ID> --type inline --resolve-status unresolved --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.list_comments",
"cobra-help:dws doc comment list",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.list_comments",
"structured-hint:internal/cli/schema_hints/imported/wukong.json#doc.list_comments",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc-comment.list_comments"
]
},
"doc.list_document_blocks": {
"agent_summary": "查询文档一级块元素列表",
"use_when": [
"查看文档一级块结构、拿 blockId,供 insert/update/delete 或划词评论定位时;用户在显式工作流中点名 list 时必须真实执行并使用返回结果"
],
"avoid_when": [
"只要全文 Markdown 用 doc read",
"要改内容分别用 block insert/update/delete"
],
"examples": [
"dws doc block list --node <DOC_ID> --format json",
"dws doc block list --node <DOC_ID> --start-index 0 --end-index 5 --format json"
],
"reviewed": true,
"review_reason": "人工对齐 block list 的显式可观察步骤和真实 blockId 上下文传递;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.list_document_blocks",
"cobra-help:dws doc block list",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.list_document_blocks",
"structured-hint:internal/cli/schema_hints/imported/wukong.json#doc.list_document_blocks",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.list_document_blocks"
]
},
"doc.list_nodes": {
"agent_summary": "兼容入口:遍历文件夹或知识库的直接子节点;目录浏览能力已迁移到 drive/wiki。",
"use_when": [
"兼容入口:遍历文件夹或知识库直接子节点时(已弃用,日常改用 drive list / wiki node list)"
],
"avoid_when": [
"日常浏览「我的文档」/钉盘用 dws drive list;知识库用 dws wiki node list"
],
"examples": [
"dws doc list --format json",
"dws doc list --folder <FOLDER_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.list_nodes",
"cobra-help:dws doc list",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.list_nodes",
"structured-hint:internal/cli/schema_hints/imported/wukong.json#doc.list_nodes",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.list_nodes"
]
},
"doc.list_permission": {
"agent_summary": "兼容入口:查询文档空间节点的协作者权限;文件权限命令已迁移到 drive。",
"use_when": [
"列出文档节点成员权限时"
],
"avoid_when": [
"增删改权限用 add/update/remove;知识库成员用 wiki member list"
],
"examples": [
"dws doc permission list --node <DOC_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.list_permission",
"cobra-help:dws doc permission list",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.list_permission",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.list_permission"
]
},
"doc.media_insert": {
"agent_summary": "上传本地文件并作为附件插入文档",
"use_when": [
"把本地文件/图片作为附件块插入文档正文(自动 prepare+PUT+insert)时"
],
"avoid_when": [
"上传为独立文件用 drive/doc upload,不要与正文附件混淆",
"下载正文附件用 media download"
],
"examples": [
"dws doc media insert --node <DOC_ID> --file ./report.pdf --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.media_insert",
"cobra-help:dws doc media insert",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.media_insert",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:none (Cobra+Skill; composite/unpinned)"
]
},
"doc.move_document": {
"agent_summary": "兼容入口:移动文档或文件;文件移动能力已迁移到 drive。",
"use_when": [
"用户要移动文档/文件且原位置不再保留时"
],
"avoid_when": [
"要保留副本改用 doc/drive copy",
"目标未确认时不要 move"
],
"examples": [
"dws doc move --node <DOC_ID> --folder <TARGET_FOLDER_ID> --format json",
"dws doc move --node <DOC_ID> --workspace <TARGET_WS_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.move_document",
"cobra-help:dws doc move",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.move_document",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.move_document"
]
},
"doc.query_export_job": {
"agent_summary": "查询文档导出任务结果",
"use_when": [
"doc export 超时/中断后,用 jobId 查询导出任务状态与下载链接时"
],
"avoid_when": [
"常规导出请直接 dws doc export(一体化提交+轮询+下载),不要先查 job"
],
"examples": [
"dws doc export get --job-id <JOB_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.query_export_job",
"cobra-help:dws doc export get",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.query_export_job",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.query_export_job"
]
},
"doc.remove_permission": {
"agent_summary": "兼容入口:移除文档空间节点的协作成员权限;文件权限命令已迁移到 drive。",
"use_when": [
"移除文档节点上指定用户权限时"
],
"avoid_when": [
"改角色用 update;知识库撤成员用 wiki member remove"
],
"examples": [
"dws doc permission remove --node <DOC_ID> --users uid1 --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.remove_permission",
"cobra-help:dws doc permission remove",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.remove_permission",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.remove_permission"
]
},
"doc.rename_document": {
"agent_summary": "兼容入口:重命名文档或文件;文件重命名能力已迁移到 drive。",
"use_when": [
"用户要改在线文档在列表与链接中展示的名称时"
],
"avoid_when": [
"改正文标题/章节标题改用 doc block update",
"不要用 update 或重新 create 来改名",
"文件或文件夹重命名优先用 dws drive rename,由该命令读取真实节点类型和当前扩展名"
],
"examples": [
"dws doc rename --node <DOC_ID> --name \"新名称\" --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.rename_document",
"cobra-help:dws doc rename",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.rename_document",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.rename_document"
]
},
"doc.reply_comment": {
"agent_summary": "回复文档评论",
"use_when": [
"回复已有评论(文字、可 @用户/@群,或 --emoji 表情);commentKey 来自 list/create"
],
"avoid_when": [
"新建评论用 create/create-inline;删评论用 delete"
],
"examples": [
"dws doc comment reply --node <DOC_ID> --comment-key <COMMENT_KEY> --content \"同意\" --mentioned-open-conversation-id <openConversationId> --format json",
"dws doc comment reply --node <DOC_ID> --comment-key <COMMENT_KEY> --content \"比心\" --emoji --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.reply_comment",
"cobra-help:dws doc comment reply",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.reply_comment",
"structured-hint:internal/cli/schema_hints/imported/wukong.json#doc.reply_comment",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc-comment.reply_comment"
]
},
"doc.search_documents": {
"agent_summary": "搜索文档(不传关键词返回最近访问)",
"use_when": [
"兼容入口:按关键词搜文档时(已弃用,日常改用 drive search / wiki node search)"
],
"avoid_when": [
"全局搜文件用 dws drive search;指定知识库内搜用 dws wiki node search"
],
"examples": [
"dws doc search --query \"会议纪要\" --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.search_documents",
"cobra-help:dws doc search",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.search_documents",
"structured-hint:internal/cli/schema_hints/imported/wukong.json#doc.search_documents",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.search_documents"
]
},
"doc.template_apply": {
"agent_summary": "使用指定模板创建新文档",
"use_when": [
"使用指定模板创建新文档时"
],
"avoid_when": [
"先 list/search 拿到模板再 apply;普通空文档用 doc create"
],
"examples": [
"dws doc template apply --template-id <TPL_ID> --name \"我的周报\" --format json",
"dws doc template apply --template-id <TPL_ID> --name \"项目方案\" --folder <FOLDER_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.template_apply",
"cobra-help:dws doc template apply",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.apply_doc_template"
]
},
"doc.template_list": {
"agent_summary": "获取当前用户可用的文档模板列表",
"use_when": [
"列出当前用户可用的文档模板时"
],
"avoid_when": [
"按关键词搜模板用 template search;套用模板用 template apply"
],
"examples": [
"dws doc template list --format json",
"dws doc template list --source MY --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.template_list",
"cobra-help:dws doc template list",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.list_doc_templates"
]
},
"doc.template_search": {
"agent_summary": "根据关键词搜索文档模板",
"use_when": [
"按关键词搜索文档模板时"
],
"avoid_when": [
"浏览全部模板用 template list;创建文档用 template apply"
],
"examples": [
"dws doc template search --query \"周报\" --format json",
"dws doc template search --query \"会议纪要\" --source PUBLIC --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.template_search",
"cobra-help:dws doc template search",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.search_doc_templates"
]
},
"doc.update_comment": {
"agent_summary": "更新指定文档评论的文字内容和可选 @用户/@群。",
"use_when": [
"修改已有评论正文;可选更新 --mention 或 --mentioned-open-conversation-id;执行后必须用 comment list 回查同一 commentKey 的目标字段"
],
"avoid_when": [
"删除评论用 delete;回复用 reply",
"响应为 null/空对象或回查仍是旧正文时不能判成功,必须报告更新未生效或部分完成"
],
"examples": [
"dws doc comment update --node <DOC_ID> --comment-key <COMMENT_KEY> --content \"已按最新数据修正\" --format json",
"dws doc comment update --node <DOC_ID> --comment-key <COMMENT_KEY> --content \"请群内确认\" --mentioned-open-conversation-id <openConversationId>"
],
"reviewed": true,
"review_reason": "人工对齐评论更新的业务结果与 comment list 回查语义;null/空响应不能单独证明成功,不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.update_comment",
"cobra-help:dws doc comment update --help",
"skills/mono/references/products/doc/doc-comment.md",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc-comment.update_comment"
]
},
"doc.update_document": {
"agent_summary": "用原生自动分片管道追加或整篇覆盖 adoc 内容",
"use_when": [
"用户要向已有 adoc 追加长、多行或文件内容时用 --mode append + --content-file;CLI 自动分片",
"用户明确要求整篇覆盖替换时用 --mode overwrite(破坏性)",
"append 且要插到第 N 个 block 前时加 --index N(先 block list)"
],
"avoid_when": [
"只在末尾补一小段纯文本优先 +doc-append;只改一个块用 doc block update",
"目标不是 adoc 时按 drive info 的 extension 切对应产品",
"覆盖模式用户未确认前不要执行;可先 --dry-run 预览",
"创建新文档用 doc create;不要预先手工分片或循环重试覆盖"
],
"examples": [
"dws doc update --node <DOC_ID> --content \"# 追加内容\" --mode append --format json",
"dws doc update --node <DOC_ID> --content-file ./body.md --mode overwrite --dry-run"
],
"reviewed": true,
"review_reason": "人工对齐 Runtime 的 10000 字符自动分片、append/overwrite 动态门禁与根 Skill 的写后回读流程;不改变参数和安全事实。",
"source_refs": [
"CommandRegistry:canonical_path=doc.update_document",
"cobra-help:dws doc update",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.update_document",
"structured-hint:internal/cli/schema_hints/imported/wukong.json#doc.update_document",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.update_document"
]
},
"doc.update_document_block": {
"agent_summary": "更新文档中的指定块",
"use_when": [
"修改已有块的文本/标题/样式(已知 blockId)时"
],
"avoid_when": [
"插入新块用 block insert;删除用 block delete",
"改文档显示名用 rename;整篇覆盖用 update overwrite"
],
"examples": [
"dws doc block update --node <DOC_ID> --block-id <BLOCK_ID> --text \"新内容\" --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.update_document_block",
"cobra-help:dws doc block update",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.update_document_block",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.update_document_block"
]
},
"doc.update_permission": {
"agent_summary": "兼容入口:更新文档空间节点的协作成员角色;文件权限命令已迁移到 drive。",
"use_when": [
"变更文档节点上已有用户角色时"
],
"avoid_when": [
"新授权用 add;移除用 remove"
],
"examples": [
"dws doc permission update --node <DOC_ID> --users uid1 --role EDITOR --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.update_permission",
"cobra-help:dws doc permission update",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.update_permission",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.update_permission"
]
},
"doc.upload": {
"agent_summary": "兼容入口:上传本地文件到钉盘或文档空间;文件上传能力已迁移到 drive。",
"use_when": [
"把本地文件上传到文档空间/知识库(可 --convert 转在线文档)时"
],
"avoid_when": [
"钉盘/我的文件上传优先 dws drive upload",
"插入文档正文附件用 media insert"
],
"examples": [
"dws doc upload --file ./report.pdf --format json",
"dws doc upload --file ./data.xlsx --workspace <WS_ID> --convert --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.upload",
"cobra-help:dws doc upload",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/selection-review.json#doc.upload",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:none (Cobra+Skill; composite/unpinned)"
]
},
"doc.version_list": {
"agent_summary": "查看文档历史版本列表",
"use_when": [
"查看文档历史版本列表以确认版本号时"
],
"avoid_when": [
"回滚用 version revert(需确认);保存快照用 version save"
],
"examples": [
"dws doc version list --node <DOC_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.version_list",
"cobra-help:dws doc version list",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.list_doc_versions"
]
},
"doc.version_revert": {
"agent_summary": "将文档回滚到指定历史版本",
"use_when": [
"用户明确要求将 adoc 回滚到指定历史版本(已从 version list 确认版本号)时"
],
"avoid_when": [
"只看版本列表用 version list;保存快照用 save",
"版本号未确认或用户未同意回滚时不要执行"
],
"examples": [
"dws doc version revert --node <DOC_ID> --version 3 --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.version_revert",
"cobra-help:dws doc version revert",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.revert_doc_version"
]
},
"doc.version_save": {
"agent_summary": "手动保存文档版本快照",
"use_when": [
"手动保存当前文档版本快照时"
],
"avoid_when": [
"回滚用 revert;只看历史用 list"
],
"examples": [
"dws doc version save --node <DOC_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:结合本机 dws schema 实时 MCP description/parameters(经 interface_ref)、产品 Skill、Cobra Long 与 Runtime 确认门禁,按飞书风格重写选型文案;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.version_save",
"cobra-help:dws doc version save",
"Skill:skills/mono/references/products/doc.md",
"structured-hint:internal/cli/schema_hints/products/doc.json",
"live-mcp:dws schema doc.save_doc_version"
]
},
"doc.shortcut_search": {
"agent_summary": "按关键词搜索有权限的文档 (不传则返回最近访问)",
"use_when": [
"当你只记得文档的标题或主题词、需要先定位到某篇钉钉文档拿到它的 nodeId/URL 以便后续阅读或编辑时使用;可按关键词、扩展名、创建/访问时间、创建者等条件过滤,不传关键词则返回最近访问的文档,返回匹配的文档列表。"
],
"avoid_when": [
"只有一个关键词且只要紧凑标题/URL/type/token 投影时优先 +find-doc;目标已给 nodeId/URL 时不要再搜索"
],
"examples": [
"dws doc +search --query \"会议纪要\"",
"dws doc +search --extensions pdf,docx"
],
"reviewed": true,
"review_reason": "人工区分 +search 的丰富过滤/最近访问能力与 +find-doc 的单关键词紧凑投影,避免两个同源搜索 Shortcut 互相争抢。",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_search",
"cobra-help:dws doc +search",
"ShortcutRegistry:doc +search"
]
},
"doc.shortcut_list": {
"agent_summary": "列出文件夹或知识库下的直接子节点",
"use_when": [
"当你已知某个文档文件夹或知识库的 ID、想浏览它下面直接包含的文档与子文件夹(不递归深层)以便逐层导航时使用;输入 folder 或 workspace,返回该层级的子节点列表。"
],
"avoid_when": [
"全局或钉盘目录浏览优先 drive list,知识库节点树优先 wiki node list;本 Shortcut 只列已知 doc folder/workspace 的直接子节点"
],
"examples": [
"dws doc +list --folder DOC_FOLDER_NODE_ID",
"dws doc +list --workspace WS_ID --limit 20"
],
"reviewed": true,
"review_reason": "人工对齐 doc/drive/wiki 产品边界:保留已知文档文件夹/知识库的直接子节点投影,不替代常规目录管理。",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_list",
"cobra-help:dws doc +list",
"ShortcutRegistry:doc +list"
]
},
"doc.shortcut_copy": {
"agent_summary": "复制文档/文件到指定文件夹或知识库",
"use_when": [
"当你想保留原件、在另一个文件夹或知识库里生成一份文档/文件副本(例如以某篇文档为模板另存)时使用;输入源 node 与目标 folder/workspace,会实际创建一个副本。"
],
"avoid_when": [
"常规文件管理优先 drive copy;要搬走原件用 move;复制后必须从真实返回取副本 nodeId,禁止继续编辑源文档"
],
"examples": [
"dws doc +copy --node DOC_ID --folder TARGET_FOLDER_NODE_ID"
],
"reviewed": true,
"review_reason": "人工对齐保形复制、真实副本 ID 与 drive 文件管理边界;保留 Runtime user_required 门禁。",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_copy",
"cobra-help:dws doc +copy",
"ShortcutRegistry:doc +copy"
]
},
"doc.shortcut_move": {
"agent_summary": "移动文档/文件到指定文件夹或知识库",
"use_when": [
"当你要整理文档归属、把某篇文档/文件从当前位置挪到另一个文件夹或知识库(原位置不再保留)时使用;输入 node 与目标 folder/workspace,会实际改变文件的存放位置。"
],
"avoid_when": [
"常规文件管理优先 drive move;要保留原位置副本用 copy;目标位置不明确或未确认时不要移动"
],
"examples": [
"dws doc +move --node DOC_ID --folder TARGET_FOLDER_NODE_ID"
],
"reviewed": true,
"review_reason": "人工对齐 move 的原位置消失语义、目标位置确认与 drive 文件管理边界;保留 Runtime user_required 门禁。",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_move",
"cobra-help:dws doc +move",
"ShortcutRegistry:doc +move"
]
},
"doc.shortcut_comment_list": {
"agent_summary": "查询文档评论列表",
"use_when": [
"当你想查看某篇文档上已有的评论、了解有哪些反馈或待处理意见(可按全文/划词、已解决/未解决过滤)时使用;输入 node,返回评论列表及其 commentKey 以便后续回复。"
],
"avoid_when": [
"需要该 Shortcut 未公开的底层参数、原始响应或不同执行语义时,改用对应原子命令"
],
"examples": [
"dws doc +comment-list --node DOC_ID",
"dws doc +comment-list --node DOC_ID --type inline --resolve-status unresolved"
],
"reviewed": true,
"review_reason": "Agent-authored and reviewed from the built-in Shortcut intent, executable Cobra path, and declared outcome; it affects selection only and does not alter execution or safety facts.",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_comment_list",
"cobra-help:dws doc +comment-list",
"ShortcutRegistry:doc +comment-list"
]
},
"doc.shortcut_comment_create": {
"agent_summary": "在文档上创建一条评论",
"use_when": [
"当你想对整篇文档留一条全文评论、给出反馈或 @ 相关同事时使用;输入 node 与评论 content(可带 mention),会实际在文档上发布一条新评论。"
],
"avoid_when": [
"需要该 Shortcut 未公开的底层参数、原始响应或不同执行语义时,改用对应原子命令"
],
"examples": [
"dws doc +comment-create --node DOC_ID --content \"这里需要修改\""
],
"reviewed": true,
"review_reason": "Agent-authored and reviewed from the built-in Shortcut intent, executable Cobra path, and declared outcome; it affects selection only and does not alter execution or safety facts.",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_comment_create",
"cobra-help:dws doc +comment-create",
"ShortcutRegistry:doc +comment-create"
]
},
"doc.shortcut_comment_reply": {
"agent_summary": "回复文档中的一条评论",
"use_when": [
"当你要针对某条已有评论进行回复、参与讨论或用表情贴图回应时使用;先从评论列表拿到 comment-key,再输入 node、comment-key 与 content(--emoji 则作为表情回复),会实际发布一条回复。"
],
"avoid_when": [
"需要该 Shortcut 未公开的底层参数、原始响应或不同执行语义时,改用对应原子命令"
],
"examples": [
"dws doc +comment-reply --node DOC_ID --comment-key COMMENT_KEY --content \"同意\""
],
"reviewed": true,
"review_reason": "Agent-authored and reviewed from the built-in Shortcut intent, executable Cobra path, and declared outcome; it affects selection only and does not alter execution or safety facts.",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_comment_reply",
"cobra-help:dws doc +comment-reply",
"ShortcutRegistry:doc +comment-reply"
]
},
"doc.shortcut_export_submit": {
"agent_summary": "提交在线文档导出任务 (docx/markdown/pdf),返回 jobId",
"use_when": [
"当你想把在线文档导出成 docx/markdown/pdf 文件(例如离线保存或外发)时使用;这是异步任务的第一步,输入 node 与 export-format 提交导出,返回 jobId,随后用 +export-get 轮询结果。"
],
"avoid_when": [
"用户要直接拿到本地 docx/markdown/pdf 文件时使用一体化 dws doc export;不要默认手工编排 submit/get 轮询"
],
"examples": [
"dws doc +export-submit --node DOC_ID --export-format markdown"
],
"reviewed": true,
"review_reason": "人工对齐 atomic doc export 的一体化提交/轮询/下载路径,将 +export-submit 限定为明确异步控制场景。",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_export_submit",
"cobra-help:dws doc +export-submit",
"ShortcutRegistry:doc +export-submit"
]
},
"doc.shortcut_export_get": {
"agent_summary": "根据 jobId 查询文档导出任务结果",
"use_when": [
"当你已用 +export-submit 提交了导出任务、想查询它是否完成并拿到导出文件的下载链接时使用;输入上一步返回的 job-id,返回任务状态与结果。"
],
"avoid_when": [
"需要该 Shortcut 未公开的底层参数、原始响应或不同执行语义时,改用对应原子命令"
],
"examples": [
"dws doc +export-get --job-id JOB_ID"
],
"reviewed": true,
"review_reason": "Agent-authored and reviewed from the built-in Shortcut intent, executable Cobra path, and declared outcome; it affects selection only and does not alter execution or safety facts.",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_export_get",
"cobra-help:dws doc +export-get",
"ShortcutRegistry:doc +export-get"
]
},
"doc.shortcut_version_save": {
"agent_summary": "手动保存文档版本快照",
"use_when": [
"当你在做重大改动前后、想手动打一个可回滚的版本存档点时使用;输入 node,会实际为该文档保存一个当前内容的历史版本快照。"
],
"avoid_when": [
"需要该 Shortcut 未公开的底层参数、原始响应或不同执行语义时,改用对应原子命令"
],
"examples": [
"dws doc +version-save --node DOC_ID"
],
"reviewed": true,
"review_reason": "Agent-authored and reviewed from the built-in Shortcut intent, executable Cobra path, and declared outcome; it affects selection only and does not alter execution or safety facts.",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_version_save",
"cobra-help:dws doc +version-save",
"ShortcutRegistry:doc +version-save"
]
},
"doc.shortcut_version_list": {
"agent_summary": "查看文档历史版本列表",
"use_when": [
"当你想查看某篇文档有哪些历史版本、以便挑一个版本号用于回滚时使用;输入 node,返回历史版本列表及其版本号。"
],
"avoid_when": [
"需要该 Shortcut 未公开的底层参数、原始响应或不同执行语义时,改用对应原子命令"
],
"examples": [
"dws doc +version-list --node DOC_ID"
],
"reviewed": true,
"review_reason": "Agent-authored and reviewed from the built-in Shortcut intent, executable Cobra path, and declared outcome; it affects selection only and does not alter execution or safety facts.",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_version_list",
"cobra-help:dws doc +version-list",
"ShortcutRegistry:doc +version-list"
]
},
"doc.shortcut_version_revert": {
"agent_summary": "回滚文档到指定历史版本",
"use_when": [
"当文档被误改、你想把它整体恢复到某个历史版本时使用;先用 +version-list 找到目标版本号,再输入 node 与 version,会实际把文档内容覆盖回该版本,属于高风险写操作,需谨慎确认。"
],
"avoid_when": [
"只查看历史用 +version-list,只保存当前快照用 +version-save;版本号未核实、用户未确认或只需改单块时不要回滚"
],
"examples": [
"dws doc +version-revert --node DOC_ID --version 3"
],
"reviewed": true,
"review_reason": "人工对齐 version list → 明确确认 → revert → 回读的 ID 与高风险边界;不改变 typed_yes 安全门禁。",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_version_revert",
"cobra-help:dws doc +version-revert",
"ShortcutRegistry:doc +version-revert"
]
},
"doc.shortcut_template_list": {
"agent_summary": "获取文档模板列表",
"use_when": [
"当你想基于模板新建文档、需要先浏览可用的模板(自己的 MY 或公共 PUBLIC)并拿到 templateId 时使用;返回模板列表,随后可配合 +template-apply 套用。"
],
"avoid_when": [
"需要该 Shortcut 未公开的底层参数、原始响应或不同执行语义时,改用对应原子命令"
],
"examples": [
"dws doc +template-list --source PUBLIC"
],
"reviewed": true,
"review_reason": "Agent-authored and reviewed from the built-in Shortcut intent, executable Cobra path, and declared outcome; it affects selection only and does not alter execution or safety facts.",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_template_list",
"cobra-help:dws doc +template-list",
"ShortcutRegistry:doc +template-list"
]
},
"doc.shortcut_template_search": {
"agent_summary": "根据关键词搜索文档模板",
"use_when": [
"当模板较多、你想按关键词(如“周报”“合同”)快速找到合适的模板并拿到 templateId 时使用;输入 query,返回匹配的模板列表,随后可配合 +template-apply 套用。"
],
"avoid_when": [
"需要该 Shortcut 未公开的底层参数、原始响应或不同执行语义时,改用对应原子命令"
],
"examples": [
"dws doc +template-search --query \"周报\""
],
"reviewed": true,
"review_reason": "Agent-authored and reviewed from the built-in Shortcut intent, executable Cobra path, and declared outcome; it affects selection only and does not alter execution or safety facts.",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_template_search",
"cobra-help:dws doc +template-search",
"ShortcutRegistry:doc +template-search"
]
},
"doc.shortcut_doc_append": {
"agent_summary": "在文档末尾追加一段文本(安全追加,不改动原有内容)",
"use_when": [
"当你只想往一篇钉钉文档的最后面补一段文字、又不想动原有内容时使用;内部用文档更新的“追加(append)”模式,把你给的文本安全地拼到文档末尾,不需要你先去查文档块列表、算末尾位置或手工拼块结构。会真实写入文档内容。"
],
"avoid_when": [
"长、多行、表格或文件内容使用 doc update --mode append --content-file;指定位置或富结构使用 block insert;不要跳过 user_required 确认"
],
"examples": [
"dws doc +doc-append --doc DOC_ID --text \"补充说明:本方案已评审通过。\"",
"dws doc +doc-append --doc \"https://alidocs.dingtalk.com/i/nodes/<DOC_UUID>\" --text \"追加一行备注\""
],
"reviewed": true,
"review_reason": "人工将 Shortcut 限定为短纯文本末尾追加,并对齐 user_required 与写后回读;长内容交给原生自动分片管道。",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_doc_append",
"cobra-help:dws doc +doc-append",
"ShortcutRegistry:doc +doc-append"
]
},
"doc.shortcut_find_doc": {
"agent_summary": "按关键词搜索云文档并投影关键字段(只读)",
"use_when": [
"当你只记得云文档标题或内容里的某个关键词,想快速按关键词找到匹配的文档、拿到它的标题、URL、类型和 token 以便后续查看或编辑,却不想拿到一大坨原始字段时使用;内部调用云文档的 search_documents 工具,把 --query 作为搜索关键词(keyword),可选地用 --limit 限制返回条数(pageSize),再在本地把每条命中结果精简为「标题、URL、类型、token」四个字段后打印。这是纯只读操作,只做搜索与本地投影,不会创建、修改或删除任何文档;未命中时提示「没搜到文档」。"
],
"avoid_when": [
"需要最近访问、extension/时间/创建者等组合过滤时使用 +search;目标已给 nodeId/URL 时直接进入 info/read,不再搜索"
],
"examples": [
"dws doc +find-doc --query 季度汇报",
"dws doc +find-doc --query 合同 --limit 10"
],
"reviewed": true,
"review_reason": "人工将 +find-doc 定位为高频单关键词紧凑投影,并与 +search 的丰富过滤能力做互斥路由。",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_find_doc",
"cobra-help:dws doc +find-doc",
"ShortcutRegistry:doc +find-doc"
]
},
"doc.shortcut_share_doc": {
"agent_summary": "按姓名把文档链接私信发给某人(自动解析 userId)",
"use_when": [
"当你手上已经有一个文档链接、想直接私信发给某个人而不必先查 userId 时使用;内部先按姓名搜通讯录解析出唯一用户,再用 openDingTalkId 把链接拼成一条 Markdown 消息发出去,姓名匹配到多人时会列出候选让你区分。只发链接、不读取或改动文档本身,会真实发出消息。"
],
"avoid_when": [
"同名人员未消歧、缺少真实文档 URL 或用户未确认时不要发送;本命令不授予文档权限,授权应走 drive permission"
],
"examples": [
"dws doc +share-doc --to 张三 --url https://docs.dingtalk.com/xxx --note \"帮忙过一下\""
],
"reviewed": true,
"review_reason": "人工对齐人员消歧、真实 docUrl、user_required 消息发送门禁与文档权限边界。",
"source_refs": [
"internal/cli/schema_command_registry.json#doc.shortcut_share_doc",
"cobra-help:dws doc +share-doc",
"ShortcutRegistry:doc +share-doc"
]
},
"doc.style_cover_set": {
"agent_summary": "设置钉钉文档顶部封面图(外链或本地图片上传)",
"use_when": [
"用户说 给文档设置封面/换个封面图"
],
"avoid_when": [
"读取当前封面用 doc style get;移除封面用 cover clear"
],
"examples": [
"dws doc style cover set --node <DOC_ID> --image https://img.example.com/cover.png --format json"
],
"reviewed": true,
"review_reason": "人工审阅:对照悟空 develop 同名命令实现、Cobra Long/Example 与 Runtime 确认门禁移植;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.style_cover_set",
"cobra-help:dws doc style cover set",
"wukong-develop:wukong/products"
]
},
"doc.style_cover_clear": {
"agent_summary": "移除钉钉文档封面",
"use_when": [
"用户说 去掉文档封面"
],
"avoid_when": [
"设置封面用 cover set"
],
"examples": [
"dws doc style cover clear --node <DOC_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:对照悟空 develop 同名命令实现、Cobra Long/Example 与 Runtime 确认门禁移植;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.style_cover_clear",
"cobra-help:dws doc style cover clear",
"wukong-develop:wukong/products"
]
},
"doc.style_background_set": {
"agent_summary": "设置钉钉文档背景纯色(#RRGGBB)",
"use_when": [
"用户说 给文档设置背景色"
],
"avoid_when": [
"背景不支持图片;封面用 cover set"
],
"examples": [
"dws doc style background set --node <DOC_ID> --color \"#E8F2FE\" --format json"
],
"reviewed": true,
"review_reason": "人工审阅:对照悟空 develop 同名命令实现、Cobra Long/Example 与 Runtime 确认门禁移植;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.style_background_set",
"cobra-help:dws doc style background set",
"wukong-develop:wukong/products"
]
},
"doc.style_background_clear": {
"agent_summary": "清除钉钉文档背景",
"use_when": [
"用户说 去掉文档背景色"
],
"avoid_when": [
"设置背景用 background set"
],
"examples": [
"dws doc style background clear --node <DOC_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:对照悟空 develop 同名命令实现、Cobra Long/Example 与 Runtime 确认门禁移植;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.style_background_clear",
"cobra-help:dws doc style background clear",
"wukong-develop:wukong/products"
]
},
"doc.get_document_style": {
"agent_summary": "读取文档当前封面与背景配置(只读)",
"use_when": [
"用户说 看下文档现在的封面/背景"
],
"avoid_when": [
"修改用 cover set / background set"
],
"examples": [
"dws doc style get --node <DOC_ID> --format json"
],
"reviewed": true,
"review_reason": "人工审阅:对照悟空 develop 同名命令实现、Cobra Long/Example 与 Runtime 确认门禁移植;不改变命令身份、参数契约或接口绑定。",
"source_refs": [
"CommandRegistry:canonical_path=doc.get_document_style",
"cobra-help:dws doc style get",
"wukong-develop:wukong/products"
]
}
},
"products": {
"doc": {
"agent_summary": "管理钉钉在线文档的正文、块、评论、导入导出、模板与版本",
"use_when": [
"创建、读取或编辑在线文档内容,或处理文档块、评论、导入导出、模板和版本时"
],
"avoid_when": [
"文件、目录、上传下载及节点权限已迁移到 drive;知识库空间和成员使用 wiki;不要用于搜索开放平台开发文档"
],
"reviewed": true,
"review_reason": "依据真实 CommandRegistry 命令分区与对应产品 Skill 审阅产品级选择边界。",
"source_refs": [
"CommandRegistry:product=doc",
"Skill:skills/mono/references/products/doc.md"
]
}
}
}