Files
dingtalk-workspace-cli/internal/cli/schema_hints/selection-review.json
T

7762 lines
324 KiB
JSON
Raw 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": "agent-selection-contract-v1",
"reviewed": true,
"repository": "DingTalk-Real-AI/dingtalk-workspace-cli",
"channel": "open-source"
},
"coverage": {
"source_tools": 513
},
"tools": {
"aisearch.enterprise_person_search": {
"use_when": [
"13800138000是谁/查手机号;按手机号搜人",
"222020这个工号是谁/查工号;按工号搜人",
"五道的上级是谁/谁负责XX/XX的下属有谁;AI语义搜人",
"找一下张三/搜同事/找人;AI搜人(首选)",
"搜人/找人/谁负责/上级是谁/哪个部门的人"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“企业内找人搜索工具,支持按姓名、部门、职位、技能、工作职责等多维度搜索企业内人员。”"
],
"examples": [
"dws aisearch person --keyword \"张三\" --dimension name --format json",
"dws aisearch person --keyword \"产品部\" --dimension department --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aisearch.search_enterprise": {
"use_when": [
"搜一下智能化方案/最近 OKR 相关邮件/最近发版相关消息;搜企业知识内容",
"搜资料/找方案/查文档/搜企业知识/项目相关内容/工作总结/周报总结",
"最近/本周/今天 + XX相关消息/文档/邮件有哪些"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“企业内部知识搜索工具。”"
],
"examples": [
"dws aisearch enterprise --queries \"智能化方案\" --types document --format json",
"dws aisearch enterprise --queries \"搜索问题\" --types im --time-range \"最近\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aisearch.search_enterprise_behavior": {
"use_when": [
"我发给某人的消息/邮件/文档/今天我干了什么;搜行为记录",
"我发过/谁发给我/创建过/分享过/收到过/今天我干了什么"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“业内部行为记录搜索工具。”"
],
"examples": [
"dws aisearch behavior --queries \"智能化方案\" --types document --format json",
"dws aisearch behavior --types mail --behavior-type send --direction \"我->汐峰\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.advperm_disable": {
"use_when": [
"开启或关闭指定 Base 的高级权限总开关。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“开启或关闭指定 Base 的高级权限总开关。”所述变更时不要使用"
],
"examples": [
"dws aitable advperm disable --base-id <base-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.advperm_enable": {
"use_when": [
"1. 确保高级权限已开"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“开启或关闭指定 Base 的高级权限总开关。”所述变更时不要使用"
],
"examples": [
"dws aitable advperm enable --base-id BASE_ID --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.advperm_role_create": {
"use_when": [
"3. 创建角色 + 指定 sheet 子角色 authLevel=read",
"仅指定 name,子角色由服务端按默认(none)填充",
"创建时即指定 sub-roles(推荐——避免再走一次 role-update)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在指定 Base 下创建自定义角色;”所述变更时不要使用"
],
"examples": [
"dws aitable advperm role-create --base-id BASE_ID --name \"市场可读\" --format json",
"dws aitable advperm role-create --base-id BASE_ID --name \"市场可读\" --sub-roles '[{\"targetId\":\"<sheetId>\",\"targetType\":\"sheet\",\"authLevel\":\"read\"}]' --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.advperm_role_delete": {
"use_when": [
"删除指定 Base 下的自定义角色;"
],
"avoid_when": [
"用户未明确要求“删除指定 Base 下的自定义角色;”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws aitable advperm role-delete --base-id <base-id> --role-id <role-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.advperm_role_get": {
"use_when": [
"获取指定 Base 下单个角色的完整配置,含 subRoles 与字段/行级权限。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定 Base 下单个角色的完整配置,含 subRoles 与字段/行级权限。”"
],
"examples": [
"dws aitable advperm role-get --base-id BASE_ID --role-id ROLE_ID --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.advperm_role_list": {
"use_when": [
"列出指定 Base 下的全部角色,含系统角色与自定义角色,并标注 isSystem 与默认角色信息。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列出指定 Base 下的全部角色,含系统角色与自定义角色,并标注 isSystem 与默认角色信息。”"
],
"examples": [
"dws aitable advperm role-list --base-id BASE_ID --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.advperm_role_update": {
"use_when": [
"只传 sub-roles,name 等其他字段保持不变(PATCH 语义)",
"只改 sheet 子角色 authLevel,name 不传保持不变",
"只改名"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“增量更新自定义角色配置。”所述变更时不要使用"
],
"examples": [
"dws aitable advperm role-update --base-id BASE_ID --role-id ROLE_ID --name \"新名字\"",
"dws aitable advperm role-update --base-id BASE_ID --role-id ROLE_ID --sub-roles '[{\"targetId\":\"<sheetId>\",\"targetType\":\"sheet\",\"authLevel\":\"edit-own\"}]'"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.attachment_upload": {
"use_when": [
"1. 获取上传凭证"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“申请 attachment 字段 OSS 直传地址(不直接上传)”所述变更时不要使用"
],
"examples": [
"dws aitable attachment upload --base-id <BASE_ID> --file-name report.xlsx --size 204800",
"dws aitable attachment upload --base-id <BASE_ID> --file-name photo.png --size 1024 --mime-type image/png"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.base_copy": {
"use_when": [
"复制当前AI表格到指定的路径下,支持传入目标地址以及是否需要复制元数据还是只是复制表的结构不复制数据,三个参数都是必填的,如果用户传的是链接的话则需要根据实际去调用文档的DWS去获取dentryuuid信息,并且传入"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“复制当前AI表格到指定的路径下,支持传入目标地址以及是否需要复制元数据还是只是复制表的结构不复制数据,三个参数都是必填的,如果用户传的是链接的话则需要根据实际去调用文档的DWS去获取dentryuuid信息,并且传入”所述变更时不要使用"
],
"examples": [
"dws aitable base copy --base-id <base-id> --target-folder-id <target-folder-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.base_create": {
"use_when": [
"表格/多维表/AI表格;创建"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建 AI 表格 Base”所述变更时不要使用"
],
"examples": [
"dws aitable base create --name \"项目跟踪\""
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.base_delete": {
"use_when": [
"表格/多维表/AI表格;删除"
],
"avoid_when": [
"用户未明确要求“删除 Base(高风险、不可逆)”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws aitable base delete --base-id <base-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.base_get": {
"use_when": [
"2. 获取 Base 信息 — 提取 tableId",
"表格/多维表/AI表格;详情"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取 Base 资源目录(tables、dashboards summary)”"
],
"examples": [
"dws aitable base get --base-id <BASE_ID> --format json",
"dws aitable base get --base-id BASE_ID # 查询 baseId: dws aitable base list"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.base_get_primary_doc_id": {
"use_when": [
"根据 baseId、tableId 和 recordId 获取主键文档对应的文档信息,会返回对应的文档的dentryuuid,然后利用该uuid去获取文档的内容以及做其他操作"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“根据 baseId、tableId 和 recordId 获取主键文档对应的文档信息,会返回对应的文档的dentryuuid,然后利用该uuid去获取文档的内容以及做其他操作”"
],
"examples": [
"dws aitable base get-primary-doc-id --base-id <base-id> --record-id <record-id> --table-id <table-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.base_list": {
"use_when": [
"获取 AI 表格列表(最近访问)"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取 AI 表格列表(最近访问)”"
],
"examples": [
"dws aitable base list",
"dws aitable base list --limit 5 --cursor NEXT_CURSOR"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.base_search": {
"use_when": [
"1. 搜索/列出 Base — 提取 baseId",
"表格/多维表/AI表格;查看/查找/列表"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“按名称关键词搜索 AI 表格 Base。”"
],
"examples": [
"dws aitable base search --query \"项目\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.base_update": {
"use_when": [
"表格/多维表/AI表格;修改"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新 Base 名称 / 备注”所述变更时不要使用"
],
"examples": [
"dws aitable base update --base-id BASE_ID --name \"新名称\" # 查询 baseId: dws aitable base list"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.chart_create": {
"use_when": [
"在 dashboard 下创建 chart(需 --config 与 --layout)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在 dashboard 下创建 chart(需 --config 与 --layout)”所述变更时不要使用"
],
"examples": [
"dws aitable chart create --base-id BASE_ID --dashboard-id DASHBOARD_ID --config '{\"chartName\":\"销售柱图\",\"chartType\":\"bar\",...}' --layout '{\"x\":0,\"y\":0,\"w\":6,\"h\":4}'"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.chart_delete": {
"use_when": [
"删除 chart(同步删除其 dashboard 布局项;不可逆)"
],
"avoid_when": [
"用户未明确要求“删除 chart(同步删除其 dashboard 布局项;不可逆)”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws aitable chart delete --base-id <base-id> --chart-id <chart-id> --dashboard-id <dashboard-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.chart_get": {
"use_when": [
"2) 先拿 dashboard,再拿 chart 详情"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取 chart 详细信息(widget.config + 布局)”"
],
"examples": [
"dws aitable chart get --base-id <BASE_ID> --dashboard-id <DASHBOARD_ID> --chart-id <CHART_ID> --format json",
"dws aitable chart get --base-id BASE_ID --dashboard-id DASHBOARD_ID --chart-id CHART_ID"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.chart_share_get": {
"use_when": [
"获取 chart 分享配置"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取 chart 分享配置”"
],
"examples": [
"dws aitable chart share get --base-id BASE_ID --dashboard-id DASHBOARD_ID --chart-id CHART_ID"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.chart_share_update": {
"use_when": [
"更新 chart 分享开关与类型"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新 chart 分享开关与类型”所述变更时不要使用"
],
"examples": [
"dws aitable chart share update --base-id BASE_ID --dashboard-id DASHBOARD_ID --chart-id CHART_ID --enabled true --share-type ORG",
"dws aitable chart share update --base-id BASE_ID --dashboard-id DASHBOARD_ID --chart-id CHART_ID --enabled false"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.chart_update": {
"use_when": [
"更新 chart 配置 / 布局"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新 chart 配置 / 布局”所述变更时不要使用"
],
"examples": [
"dws aitable chart update --base-id BASE_ID --dashboard-id DASHBOARD_ID --chart-id CHART_ID --config '{\"chartName\":\"新柱图名\",...}'",
"dws aitable chart update --base-id BASE_ID --dashboard-id DASHBOARD_ID --chart-id CHART_ID --layout '{\"x\":0,\"y\":4,\"w\":12,\"h\":4}'"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.chart_widgets_example": {
"use_when": [
"1) 先看配置模板(JSONC)"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“返回所有图表类型的 widget config 示例(JSONC)”"
],
"examples": [
"dws aitable chart widgets-example --format json",
"dws aitable chart widgets-example"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.create": {
"use_when": [
"创建 AI 表格(dws aitable base create 的别名)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建 AI 表格(dws aitable base create 的别名)”所述变更时不要使用"
],
"examples": [
"dws aitable create --name <name>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.dashboard_arrange": {
"use_when": [
"自动对齐仪表盘中的图表布局,对错乱的图表进行全局重排。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“自动对齐仪表盘中的图表布局,对错乱的图表进行全局重排。”所述变更时不要使用"
],
"examples": [
"dws aitable dashboard arrange --base-id <base-id> --dashboard-id <dashboard-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.dashboard_config_example": {
"use_when": [
"1) 先看配置模板(JSONC)"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“返回 dashboard config 结构示例(JSONC)”"
],
"examples": [
"dws aitable dashboard config-example --format json",
"dws aitable dashboard config-example"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.dashboard_create": {
"use_when": [
"在指定 Base 下创建 dashboard。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在指定 Base 下创建 dashboard。”所述变更时不要使用"
],
"examples": [
"dws aitable dashboard create --base-id <base-id> --name <name>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.dashboard_delete": {
"use_when": [
"删除 dashboard(级联删除其下 chart;不可逆)"
],
"avoid_when": [
"用户未明确要求“删除 dashboard(级联删除其下 chart;不可逆)”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws aitable dashboard delete --base-id <base-id> --dashboard-id <dashboard-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.dashboard_get": {
"use_when": [
"2) 先拿 dashboard,再拿 chart 详情"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取 dashboard 详情(含 charts summary)”"
],
"examples": [
"dws aitable dashboard get --base-id <BASE_ID> --dashboard-id <DASHBOARD_ID> --format json",
"dws aitable dashboard get --base-id BASE_ID --dashboard-id DASHBOARD_ID"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.dashboard_share_get": {
"use_when": [
"获取 dashboard 分享配置"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取 dashboard 分享配置”"
],
"examples": [
"dws aitable dashboard share get --base-id BASE_ID --dashboard-id DASHBOARD_ID"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.dashboard_share_update": {
"use_when": [
"更新 dashboard 分享开关与类型"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新 dashboard 分享开关与类型”所述变更时不要使用"
],
"examples": [
"dws aitable dashboard share update --base-id BASE_ID --dashboard-id DASHBOARD_ID --enabled true --share-type PUBLIC",
"dws aitable dashboard share update --base-id BASE_ID --dashboard-id DASHBOARD_ID --enabled false"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.dashboard_update": {
"use_when": [
"更新指定 dashboard 的配置。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新指定 dashboard 的配置。”所述变更时不要使用"
],
"examples": [
"dws aitable dashboard update --base-id <base-id> --dashboard-id <dashboard-id> --name <name>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.export_data": {
"use_when": [
"第一步:创建任务(按 scope 传必要参数)",
"第一步:创建任务时使用 --export-format 指定导出格式,并保持 --format json 作为结构化输出",
"第二步:拿 taskId 继续轮询,直到返回 downloadUrl",
"续等导出:拿到 downloadUrl 后再 curl 下载(见下方警告)"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“导出数据(不传 --task-id 创建新任务并等待,传入 --task-id 继续等待)”"
],
"examples": [
"dws aitable export data --base-id <BASE_ID> --scope table --table-id <TABLE_ID> --export-format excel --timeout-ms 1000 --format json",
"dws aitable export data --base-id <BASE_ID> --task-id <TASK_ID> --timeout-ms 3000 --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.field_create": {
"use_when": [
"字段/列/column;添加",
"或者使用批量创建模式:"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在已有表格中批量新增字段。”所述变更时不要使用"
],
"examples": [
"dws aitable field create --base-id <BASE_ID> --table-id <TABLE_ID> --name \"状态\" --type \"singleSelect\" --config '{\"options\":[{\"name\":\"待办\"},{\"name\":\"进行中\"},{\"name\":\"已完成\"}]}'",
"dws aitable field create --base-id <BASE_ID> --table-id <TABLE_ID> --fields '[{\"fieldName\":\"状态\",\"type\":\"singleSelect\",\"config\":{\"options\":[{\"name\":\"待办\"}]}}]'"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.field_delete": {
"use_when": [
"字段/列/column;删除"
],
"avoid_when": [
"用户未明确要求“删除字段(不可逆,禁止删除主字段与最后一个字段)”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws aitable field delete --base-id <base-id> --field-id <field-id> --table-id <table-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.field_get": {
"use_when": [
"字段/列/column;查看"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“批量获取字段详细信息(含完整配置)”"
],
"examples": [
"dws aitable field get --base-id <BASE_ID> --table-id <TABLE_ID>",
"dws aitable field get --base-id <BASE_ID> --table-id <TABLE_ID> --field-ids fld1,fld2"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.field_list": {
"use_when": [
"批量获取指定字段的详细信息,包括 fieldId、名称、类型、description 以及类型相关完整配置(如格式化、选项、AI 配置等)。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“批量获取指定字段的详细信息,包括 fieldId、名称、类型、description 以及类型相关完整配置(如格式化、选项、AI 配置等)。”"
],
"examples": [
"dws aitable field list --base-id <base-id> --table-id <table-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.field_search_options": {
"use_when": [
"搜索指定单选/多选字段的 options 列表,支持按关键词模糊匹配(大小写不敏感、contains 模式)。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“搜索指定单选/多选字段的 options 列表,支持按关键词模糊匹配(大小写不敏感、contains 模式)。”"
],
"examples": [
"dws aitable field search-options --base-id <base-id> --field-id <field-id> --table-id <table-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.field_update": {
"use_when": [
"字段/列/column;修改"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新字段名称 / 配置 / AI 配置(至少传一项)”所述变更时不要使用"
],
"examples": [
"dws aitable field update --base-id <BASE_ID> --table-id <TABLE_ID> --field-id <FIELD_ID> --name \"新字段名\"",
"dws aitable field update --base-id <BASE_ID> --table-id <TABLE_ID> --field-id <FIELD_ID> --config '{\"options\":[{\"name\":\"A\"},{\"name\":\"B\"}]}'"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.import_data": {
"use_when": [
"第 3 步(替代):追加到已有表",
"第 3 步:触发导入(新建表模式)",
"续等导入"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“触发导入并等待结果;每个 Sheet 新建为独立表”所述变更时不要使用"
],
"examples": [
"dws aitable import data --import-id <importId> --format json",
"dws aitable import data --import-id <importId> --table-id <TABLE_ID> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.import_upload": {
"use_when": [
"第 1 步:申请上传凭证"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“申请导入文件 OSS 直传地址,返回 uploadUrl 与 importId”所述变更时不要使用"
],
"examples": [
"dws aitable import upload --base-id <BASE_ID> --file-name data.xlsx --file-size <字节数> --format json",
"dws aitable import upload --base-id BASE_ID --file-name data.xlsx --file-size 204800"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.info": {
"use_when": [
"获取指定 Base 的资源目录级信息,返回 baseName、tables、dashboards 的 summary 信息(不含字段与记录详情)。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定 Base 的资源目录级信息,返回 baseName、tables、dashboards 的 summary 信息(不含字段与记录详情)。”"
],
"examples": [
"dws aitable info --base-id <base-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.list": {
"use_when": [
"列出当前用户可访问的 AI 表格 Base。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列出当前用户可访问的 AI 表格 Base。”"
],
"examples": [
"dws aitable list"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.query_records": {
"use_when": [
"4. 查询记录",
"从上次断点继续",
"关键词搜索",
"按 ID 查询",
"无限制(拉完为止)",
"游标分页",
"示例:基础条件查询模板(可改内部 operator 为 contain 等)",
"记录/行/数据/row;查看/搜索",
"默认(最多 50 页 = 5000 条)"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询记录(支持按 ID 取或 filters/sort/分页遍历)”"
],
"examples": [
"dws aitable record query --base-id <BASE_ID> --table-id <TABLE_ID> --format json",
"dws aitable record query --base-id <BASE_ID> --table-id <TABLE_ID> --filters '{\"operator\":\"and\",\"operands\":[{\"operator\":\"eq\",\"operands\":[\"fld_state\",\"进行中\"]}]}' --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.record_create": {
"use_when": [
"5. 新增记录 (cells 用 fieldId 作 key)",
"再用 fieldId 写入记录",
"单条",
"多条",
"步骤 2: 在 record create/update 中使用 fileToken 写入",
"步骤 2: 在 record create/update 中使用 fileToken 写入附件字段",
"记录/行/数据/row;添加/写入"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“批量新增记录(单次最多 100 条)”所述变更时不要使用"
],
"examples": [
"dws aitable record create --base-id <BASE_ID> --table-id <TABLE_ID> --records '[{\"cells\":{\"fldABC\":\"完成设计\",\"fldDEF\":\"进行中\"}}]' --format json",
"dws aitable record create --base-id <BASE_ID> --table-id <TABLE_ID> --records '["
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.record_delete": {
"use_when": [
"记录/行/数据/row;删除"
],
"avoid_when": [
"用户未明确要求“批量删除记录(不可逆,单次最多 100 条)”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws aitable record delete --base-id <base-id> --record-ids <record-ids> --table-id <table-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.record_get": {
"use_when": [
"记录/行/数据/row;已知 recordId 反查字段值"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询指定表格中的记录,支持两种模式: 按 ID 取:传入 recordIds(单次最多 100 个),直接获取指定记录。”"
],
"examples": [
"dws aitable record get --base-id <base-id> --record-ids <record-ids> --table-id <table-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.record_history_list": {
"use_when": [
"第 1 页(最新 20 条)",
"第 2 页"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询指定行记录的变更历史列表。”"
],
"examples": [
"dws aitable record history-list --base-id BASE_ID --table-id TABLE_ID --record-id REC_ID [--offset N] [--limit M]",
"dws aitable record history-list --base-id BASE --table-id TBL --record-id REC --format json | jq '.data.histories[] | {version, action, operateTime}'"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.record_primary_doc_create": {
"use_when": [
"2. 为某条记录创建主键文档"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“为指定记录创建主键文档(幂等:若该记录已有主键文档则直接返回已有文档的 nodeId)。”所述变更时不要使用"
],
"examples": [
"dws aitable record primary-doc-create --base-id BASE_ID --table-id TABLE_ID --field-id FIELD_ID --record-id RECORD_ID"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.record_primary_doc_get": {
"use_when": [
"查询指定记录的主键文档信息。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询指定记录的主键文档信息。”"
],
"examples": [
"dws aitable record primary-doc-get --base-id BASE_ID --table-id TABLE_ID --record-id RECORD_ID"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.record_query_empty": {
"use_when": [
"查询指定表格中\"完全没填用户字段\"的空行。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询指定表格中\"完全没填用户字段\"的空行。”"
],
"examples": [
"dws aitable record query-empty --base-id <base-id> --table-id <table-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.record_share_url": {
"use_when": [
"一次拿一条记录的链接",
"带视图上下文(链接打开时落在指定视图)",
"批量拿,配合 jq 过滤出 url"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定行记录的分享链接,可用于将记录分享给他人。”"
],
"examples": [
"dws aitable record share-url --base-id BASE_ID --table-id TABLE_ID --record-ids rec1,rec2,rec3 [--view-id VIEW_ID]",
"dws aitable record share-url --base-id BASE --table-id TBL --record-ids rec1"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.record_update": {
"use_when": [
"3. 写入记录",
"记录/行/数据/row;修改/更新"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“批量更新记录(单次最多 100 条)”所述变更时不要使用"
],
"examples": [
"dws aitable record update --base-id <BASE_ID> --table-id <TABLE_ID> --records '[{\"recordId\":\"rec001\",\"cells\":{\"fldDEF\":\"已完成\"}}]' --format json",
"dws aitable record update --base-id <BASE_ID> --table-id <TABLE_ID> --records '[{\"recordId\":\"recXXX\",\"cells\":{\"fldAttachId\":[{\"fileToken\":\"ft_xxx\"}]}}]' --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.record_upsert": {
"use_when": [
"1) 全部新建:所有项都不带 recordId",
"2) 全部更新:所有项都带 recordId",
"3) 混合:第 1 条更新(带 recordId),第 2 条创建(不带)",
"4) 长 JSON 用文件"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“批量创建或更新记录(Upsert 语义)。”所述变更时不要使用"
],
"examples": [
"dws aitable record upsert --base-id BASE_ID --table-id TABLE_ID --records '[{\"recordId\":\"<可选>\",\"cells\":{...}}, ...]'",
"dws aitable record upsert --base-id BASE --table-id TBL --records '["
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.search": {
"use_when": [
"按名称关键词搜索 AI 表格 Base。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“按名称关键词搜索 AI 表格 Base。”"
],
"examples": [
"dws aitable search --query <query>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.section_create": {
"use_when": [
"在指定 Base 下创建分区(用于在导航树中组织 table / dashboard,类似文件夹)。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在指定 Base 下创建分区(用于在导航树中组织 table / dashboard,类似文件夹)。”所述变更时不要使用"
],
"examples": [
"dws aitable section create --base-id <BASE_ID> --name 我的文件夹",
"dws aitable section create --base-id <BASE_ID> --name 子文件夹 --parent-section-id <SECTION_ID> --index 0"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.section_delete": {
"use_when": [
"删除指定分区。"
],
"avoid_when": [
"用户未明确要求“删除指定分区。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws aitable section delete --base-id <BASE_ID> --section-id <SECTION_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.section_list_empty": {
"use_when": [
"列出指定 Base 下所有没有任何子节点的分区(空文件夹),用于清理或诊断导航树。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列出指定 Base 下所有没有任何子节点的分区(空文件夹),用于清理或诊断导航树。”"
],
"examples": [
"dws aitable section list-empty --base-id <BASE_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.section_list_nodes": {
"use_when": [
"列出指定 Base 当前版本下的全部 nsheet 节点,包括分区、AI 表格、表单视图、仪表盘、文档、查询视图等。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列出指定 Base 当前版本下的全部 nsheet 节点,包括分区、AI 表格、表单视图、仪表盘、文档、查询视图等。”"
],
"examples": [
"dws aitable section list-nodes --base-id <BASE_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.section_move_node": {
"use_when": [
"把任意 nsheet 节点(分区 / 多维表 / 表单视图 / 仪表盘 / 文档 / 查询视图)移动到目标分区下,可选同时调整全局位置。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“把任意 nsheet 节点(分区 / 多维表 / 表单视图 / 仪表盘 / 文档 / 查询视图)移动到目标分区下,可选同时调整全局位置。”所述变更时不要使用"
],
"examples": [
"dws aitable section move-node --base-id <BASE_ID> --node-id <NODE_ID> --new-parent-section-id <SECTION_ID>",
"dws aitable section move-node --base-id <BASE_ID> --node-id <NODE_ID> --new-parent-section-id \"\" --target-index 0"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.section_rename": {
"use_when": [
"重命名指定分区。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“重命名指定分区。”所述变更时不要使用"
],
"examples": [
"dws aitable section rename --base-id <BASE_ID> --section-id <SECTION_ID> --new-name 新名称"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.section_reorder": {
"use_when": [
"在当前父分区下调整分区的展示顺序。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在当前父分区下调整分区的展示顺序。”所述变更时不要使用"
],
"examples": [
"dws aitable section reorder --base-id <BASE_ID> --section-id <SECTION_ID> --target-index 0"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.table_create": {
"use_when": [
"数据表/子表/table;创建"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建数据表并附带初始字段(最多 15 个)”所述变更时不要使用"
],
"examples": [
"dws aitable table create --base-id BASE_ID --name \"任务表\" --fields '[{\"fieldName\":\"任务名称\",\"type\":\"text\"},{\"fieldName\":\"优先级\",\"type\":\"singleSelect\",\"config\":{\"options\":[{\"name\":\"高\"},{\"name\":\"中\"},{\"name\":\"低\"}]}}]'"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.table_delete": {
"use_when": [
"数据表/子表/table;删除"
],
"avoid_when": [
"用户未明确要求“删除数据表(不可逆,高风险)”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws aitable table delete --base-id <base-id> --table-id <table-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.table_get": {
"use_when": [
"1. 查询表结构,拿到 primaryDoc 字段的 fieldId",
"2. 拿目标 sheet 的 tableId",
"3. 获取表结构 — 提取 fieldId",
"先获取 fieldId",
"数据表/子表/table;查看"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“批量获取数据表目录与字段、视图 summary”"
],
"examples": [
"dws aitable table get --base-id <BASE_ID> --table-id <TABLE_ID> --format json",
"dws aitable table get --base-id BASE_ID --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.table_list": {
"use_when": [
"批量获取指定 Tables(数据表)的表级信息、字段目录与视图目录。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“批量获取指定 Tables(数据表)的表级信息、字段目录与视图目录。”"
],
"examples": [
"dws aitable table list --base-id <base-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.table_update": {
"use_when": [
"数据表/子表/table;重命名",
"用户说\"恢复成默认(记录)\" → 传 ji_lu",
"用户说\"把这张表的行叫'任务'吧\" → 传 task",
"用户说\"换成项目\" → 传 project"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“重命名数据表”所述变更时不要使用"
],
"examples": [
"dws aitable table update --base-id BASE --table-id TBL --record-name-key task",
"dws aitable table update --base-id BASE --table-id TBL --record-name-key project"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.template_search": {
"use_when": [
"模板"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“按关键词搜索 AI 表格模板(不传返回热门模板)”"
],
"examples": [
"dws aitable template search --query \"项目管理\"",
"dws aitable template search"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_create": {
"use_when": [
"第 1 步:创建 Gantt 视图"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建视图(Grid/FormDesigner/Gantt/Calendar/Kanban/Gallery)”所述变更时不要使用"
],
"examples": [
"dws aitable view create --base-id BASE_ID --table-id TABLE_ID --view-type Gantt --name \"项目甘特图\" -f json",
"dws aitable view create --base-id BASE_ID --table-id TABLE_ID --view-type Grid"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_delete": {
"use_when": [
"删除视图(不可逆;禁止删除最后一个视图或锁定视图)"
],
"avoid_when": [
"用户未明确要求“删除视图(不可逆;禁止删除最后一个视图或锁定视图)”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws aitable view delete --base-id <base-id> --table-id <table-id> --view-id <view-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_duplicate": {
"use_when": [
"显式命名",
"系统自动命名(一般是 \"原视图名 (副本)\")"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“复制指定视图(View),生成一个与源视图结构一致的新视图(包含列顺序、筛选、排序、分组、自定义配置等)。”所述变更时不要使用"
],
"examples": [
"dws aitable view duplicate --view-id VIEW_ID --new-name \"副本视图\"",
"dws aitable view duplicate --view-id VIEW_ID --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_get_aggregate": {
"use_when": [
"获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。”"
],
"examples": [
"dws aitable view get aggregate --view-id VIEW_ID --format json # Grid"
]
},
"aitable.view_get_card": {
"use_when": [
"获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。”"
],
"examples": [
"dws aitable view get card --view-id VIEW_ID --format json # Kanban / Gallery",
"dws aitable view get card --view-id KANBAN_ID --format json"
]
},
"aitable.view_get_field_widths": {
"use_when": [
"获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。”"
],
"examples": [
"dws aitable view get field-widths --view-id VIEW_ID --format json # Grid"
]
},
"aitable.view_get_fill_color_rule": {
"use_when": [
"3) 查询当前规则",
"看实际生效的 conditionalFormats"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。”"
],
"examples": [
"dws aitable view get fill-color-rule --view-id GRID_ID --format json",
"dws aitable view get fill-color-rule --view-id VIEW_ID --format json"
]
},
"aitable.view_get_filter": {
"use_when": [
"获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。”"
],
"examples": [
"dws aitable view get filter --view-id VIEW_ID --format json # 所有"
]
},
"aitable.view_get_frozen_cols": {
"use_when": [
"查询当前冻结列数"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询指定视图(View)当前的冻结列数(左侧固定列)。”"
],
"examples": [
"dws aitable view get frozen-cols --view-id VIEW_ID --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_get_group": {
"use_when": [
"获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。”"
],
"examples": [
"dws aitable view get group --view-id VIEW_ID --format json"
]
},
"aitable.view_get_lock": {
"use_when": [
"查询当前是否锁定"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询指定视图(View)当前的锁定状态。”"
],
"examples": [
"dws aitable view get lock --view-id VIEW_ID --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_get_row_height": {
"use_when": [
"查询当前行高"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询指定视图(View)当前的单元格行高,单位为像素。”"
],
"examples": [
"dws aitable view get row-height --view-id VIEW_ID --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_get_sort": {
"use_when": [
"获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。”"
],
"examples": [
"dws aitable view get sort --view-id VIEW_ID --format json"
]
},
"aitable.view_get_timebar": {
"use_when": [
"获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。”"
],
"examples": [
"dws aitable view get timebar --view-id VIEW_ID --format json # Gantt"
]
},
"aitable.view_get_visible_fields": {
"use_when": [
"获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。”"
],
"examples": [
"dws aitable view get visible-fields --view-id VIEW_ID --format json"
]
},
"aitable.view_list": {
"use_when": [
"获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定数据表(Table)中的视图(View)完整信息,包括列顺序、筛选、排序、分组、条件格式、自定义配置等。”"
],
"examples": [
"dws aitable view list --base-id <base-id> --table-id <table-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_lock": {
"use_when": [
"4) 锁定视图,防止他人改坏",
"解锁",
"锁定(默认)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“锁定或解锁指定视图(View)。”所述变更时不要使用"
],
"examples": [
"dws aitable view lock --view-id VIEW_ID",
"dws aitable view lock --view-id VIEW_ID --off"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_update_aggregate": {
"use_when": [
"更新指定视图(View)的名称、描述或配置。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新指定视图(View)的名称、描述或配置。”所述变更时不要使用"
],
"examples": [
"dws aitable view update aggregate --view-id GRID_ID --field-id fldX --action SUM"
],
"interface_mode": "composite",
"availability": "available",
"interface_ref": null,
"interface_reason": "The CLI performs an aitable/get_views preflight, locally transforms the requested configuration, and then calls aitable/update_view; the two-call workflow has no single direct MCP interface."
},
"aitable.view_update_card": {
"use_when": [
"更新指定视图(View)的名称、描述或配置。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新指定视图(View)的名称、描述或配置。”所述变更时不要使用"
],
"examples": [
"dws aitable view update card --view-id KANBAN_ID --cover-field-id fldAttachment --cover-resize-mode contain",
"dws aitable view update card --view-id KANBAN_ID --no-cover"
],
"interface_mode": "composite",
"availability": "available",
"interface_ref": null,
"interface_reason": "The CLI performs an aitable/get_views preflight, locally transforms the requested configuration, and then calls aitable/update_view; the two-call workflow has no single direct MCP interface."
},
"aitable.view_update_field_widths": {
"use_when": [
"更新指定视图(View)的名称、描述或配置。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新指定视图(View)的名称、描述或配置。”所述变更时不要使用"
],
"examples": [
"dws aitable view update field-widths --view-id GRID_ID --field-id fldX --width 200",
"dws aitable view update field-widths --view-id GRID_ID --json '{\"fldA\":120,\"fldB\":200}'"
],
"interface_mode": "composite",
"availability": "available",
"interface_ref": null,
"interface_reason": "The CLI performs an aitable/get_views preflight, locally transforms the requested configuration, and then calls aitable/update_view; the two-call workflow has no single direct MCP interface."
},
"aitable.view_update_fill_color_rule": {
"use_when": [
"1) 给金额字段 > 100 的单元格上 firstLine5 色",
"2) 清空所有规则",
"3) 金额 > 100 的单元格上色"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“设置指定表格视图(Grid View)的条件填色规则(全量覆盖)。”所述变更时不要使用"
],
"examples": [
"dws aitable view update fill-color-rule --view-id GRID_ID --json '[",
"dws aitable view update fill-color-rule --view-id GRID_ID --json '[]'"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_update_filter": {
"use_when": [
"更新指定视图(View)的名称、描述或配置。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新指定视图(View)的名称、描述或配置。”所述变更时不要使用"
],
"examples": [
"dws aitable view update filter --view-id VIEW_ID --json '[{\"operator\":\"and\",\"operands\":[{\"operator\":\"eq\",\"operands\":[\"fldX\",\"value\"]}]}]'"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_update_frozen_cols": {
"use_when": [
"1) 关键字段冻结,避免横向滚动看不到",
"冻结从首列起 1 列",
"取消冻结"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“设置指定视图(View)的冻结列数(左侧固定列),默认 1。”所述变更时不要使用"
],
"examples": [
"dws aitable view update frozen-cols --view-id VIEW_ID --count 1",
"dws aitable view update frozen-cols --view-id VIEW_ID --count 0"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_update_group": {
"use_when": [
"更新指定视图(View)的名称、描述或配置。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新指定视图(View)的名称、描述或配置。”所述变更时不要使用"
],
"examples": [
"dws aitable view update group --view-id VIEW_ID --json '[{\"fieldId\":\"fldX\",\"direction\":\"asc\"}]'"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_update_name": {
"use_when": [
"更新指定视图(View)的名称、描述或配置。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新指定视图(View)的名称、描述或配置。”所述变更时不要使用"
],
"examples": [
"dws aitable view update name --view-id VIEW_ID --name \"新视图名\""
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_update_row_height": {
"use_when": [
"2) 加大行高让数据更易读",
"设置行高 — 推荐档位 32 / 56 / 88 / 128"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“设置指定视图(View)的单元格高度(行高),单位为像素,默认 32。”所述变更时不要使用"
],
"examples": [
"dws aitable view update row-height --view-id VIEW_ID --cell-height 56",
"dws aitable view update row-height --base-id $BASE --table-id $TABLE --view-id $VIEW --cell-height 56"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_update_sort": {
"use_when": [
"更新指定视图(View)的名称、描述或配置。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新指定视图(View)的名称、描述或配置。”所述变更时不要使用"
],
"examples": [
"dws aitable view update sort --view-id VIEW_ID --json '[{\"fieldId\":\"fldX\",\"direction\":\"asc\"}]'"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.view_update_timebar": {
"use_when": [
"第 2 步(必须):绑定日期字段,否则视图为空"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新指定视图(View)的名称、描述或配置。”所述变更时不要使用"
],
"examples": [
"dws aitable view update timebar --view-id GANTT_ID --start-field fldStart --end-field fldEnd --timeline-scale month",
"dws aitable view update timebar --view-id GANTT_ID --official-holiday=true"
],
"interface_mode": "composite",
"availability": "available",
"interface_ref": null,
"interface_reason": "The CLI performs an aitable/get_views preflight, locally transforms the requested configuration, and then calls aitable/update_view; the two-call workflow has no single direct MCP interface."
},
"aitable.view_update_visible_fields": {
"use_when": [
"传回全量列表解除隐藏",
"只保留首列和 fldA,其余字段被隐藏"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新指定视图(View)的名称、描述或配置。”所述变更时不要使用"
],
"examples": [
"dws aitable view update visible-fields --view-id VIEW_ID --field-ids fldPrimary,fldA",
"dws aitable view update visible-fields --view-id VIEW_ID --json '[\"fldPrimary\",\"fldA\",\"fldB\"]'"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.workflow_disable": {
"use_when": [
"2. 禁用"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“禁用指定 Base 中的自动化工作流。”所述变更时不要使用"
],
"examples": [
"dws aitable workflow disable --base-id <base-id> --workflow-id <workflow-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.workflow_enable": {
"use_when": [
"3. 调试做完后重启"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“启用指定 Base 中的自动化工作流。”所述变更时不要使用"
],
"examples": [
"dws aitable workflow enable --base-id BASE_ID --workflow-id WORKFLOW_ID --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.workflow_get": {
"use_when": [
"1. 留底当前状态"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定 Base 中某个自动化工作流的详细信息,直接返回下游 getFlowDetail 的详情结构。”"
],
"examples": [
"dws aitable workflow get --base-id BASE_ID --workflow-id WORKFLOW_ID --format json",
"dws aitable workflow get --base-id BASE_ID --workflow-id WORKFLOW_ID --format json > /tmp/wf-backup.json"
],
"interface_mode": "mcp",
"availability": "available"
},
"aitable.workflow_list": {
"use_when": [
"4. 确认 status=RUNNING"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列出指定 Base 中的自动化工作流,直接返回下游 searchFlows 的响应结构。”"
],
"examples": [
"dws aitable workflow list --base-id BASE_ID --format json",
"dws aitable workflow list --base-id BASE_ID --limit 50 --offset 100"
],
"interface_mode": "mcp",
"availability": "available"
},
"attendance.batch_get_employee_shifts": {
"use_when": [
"批量查询员工班次信息(间隔 ≤ 7 天,最多 50 人)"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“批量查询员工班次信息(间隔 ≤ 7 天,最多 50 人)”"
],
"examples": [
"dws attendance shift list --users userId1,userId2 --start 2026-03-03 --end 2026-03-07 # 查询 userId: dws contact user search --keyword \"姓名\""
],
"interface_mode": "mcp",
"availability": "available"
},
"attendance.get_attendance_summary": {
"use_when": [
"查看考勤统计摘要(--stats-type 必填:week 周统计 / month 月统计)",
"考勤汇总/统计"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询某个人的考勤统计摘要”"
],
"examples": [
"dws attendance summary --user USER_ID --date 2026-03-12 --stats-type week",
"dws attendance summary --user USER_ID --date \"2026-03-12 15:00:00\" --stats-type month"
]
},
"attendance.get_user_attendance_record": {
"use_when": [
"查询个人考勤详情"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询个人考勤详情”"
],
"examples": [
"dws attendance record get --user 011769261608 --date 2026-03-08",
"dws attendance record get --user USER_ID --date 2026-03-08 # 查询 userId: dws contact user search --keyword \"姓名\""
],
"interface_mode": "mcp",
"availability": "available"
},
"attendance.query_attendance_group_or_rules": {
"use_when": [
"1. 先查考勤组和关联班次(即使排休也需要确认考勤组)",
"1. 先查考勤组并获取关联班次(先查后排)",
"查看考勤组和规则",
"用户只属于一个考勤组,直接查询即可确定",
"考勤组/考勤规则/打卡规则",
"自动获取当前用户的考勤组(用户只属于一个考勤组,无需选择)"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询考勤组与考勤规则”"
],
"examples": [
"dws attendance rules --date <今天日期> --format json",
"dws attendance rules --date 2026-03-14"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.add_attachments": {
"use_when": [
"把附件挂到指定日程",
"日程附件/给会议加文件/上传日程材料;添加"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“为日程添加附件。”所述变更时不要使用"
],
"examples": [
"dws calendar attachment add --event <EVENT_ID> --files <FILE_ID>:report.pdf,<FILE_ID2>:slides.pptx",
"dws calendar attachment add --event <EVENT_ID> --files <FILE_ID>:report.pdf,<FILE_ID2>:slides.pptx --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.add_calendar_participant": {
"use_when": [
"参会人/与会者;邀请/添加",
"添加参会人(必须用 Step 1 返回的 eventId)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“添加参与者”所述变更时不要使用"
],
"examples": [
"dws calendar attendee add --event <EVENT_ID> --attendees <USER_ID_1>,<USER_ID_2>",
"dws calendar attendee add --event <EVENT_ID> --attendees <USER_ID> --optional"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.add_meeting_room": {
"use_when": [
"会议室/订会议室;给已有日程订会议室",
"预定会议室"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“预定会议室”所述变更时不要使用"
],
"examples": [
"dws calendar room add --event <EVENT_ID> --rooms <ROOM_ID>",
"dws calendar room add --event <EVENT_ID> --rooms <ROOM_ID> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.create_calendar_event": {
"use_when": [
"会议室/订会议室;创建新日程并订会议室",
"创建日程 — 提取 eventId",
"创建日程时直接指定参会人 + 会议室",
"日程/会议/约会/日历;创建/约/给自己留时间块/个人日程",
"给自己留一个明天下午的时间块/建个个人日程;创建个人日程"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建新的日程,支持设置时间、参与者、提醒,以及预定会议室等功能。”所述变更时不要使用"
],
"examples": [
"dws calendar event create --title \"Q1 复盘会\" --start \"2026-03-10T14:00:00+08:00\" --end \"2026-03-10T15:00:00+08:00\"",
"dws calendar event create --title \"周会\" --start \"2026-03-10T14:00:00+08:00\" --end \"2026-03-10T15:00:00+08:00\" --attendees userId1,userId2"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.delete_calendar_event": {
"use_when": [
"日程/会议/约会/日历;取消/删除"
],
"avoid_when": [
"用户未明确要求“删除日程”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws calendar event delete --id <id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.delete_meeting_room": {
"use_when": [
"会议室/订会议室;取消预定"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“移除会议室”所述变更时不要使用"
],
"examples": [
"dws calendar room delete --event <event> --rooms <rooms>"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.get_calendar": {
"use_when": [
"我有几个日历/查所有日历/别人共享给我的日历/他人共享给我的日历本;查指定日历本"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“根据日历id查询指定日历的信息。”"
],
"examples": [
"dws calendar book get --id primary",
"dws calendar book get --id CALENDAR_ID"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.get_calendar_detail": {
"use_when": [
"日程/会议/约会/日历;详情"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取日程详情”"
],
"examples": [
"dws calendar event get --id <EVENT_ID>",
"dws calendar event get --id <EVENT_ID> --calendar-id primary"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.get_calendar_participants": {
"use_when": [
"参会人/与会者;查看"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查看参与者”"
],
"examples": [
"dws calendar attendee list --event <EVENT_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.list_acls": {
"use_when": [
"我的日历共享给了谁/谁能看我日历/日历权限/取消共享/把日历分享给xxx;查看我共享出去的情况(即谁有权访问我的日历)"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“调用本接口,获取用户主日历的访问控制列表。”"
],
"examples": [
"dws calendar acl list"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.list_calendar_events": {
"use_when": [
"日程/会议/约会/日历;查看"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询当前用户指定日历本下的日程列表,按起止时间检索。”"
],
"examples": [
"dws calendar event list --start \"2026-03-10T14:00:00+08:00\" --end \"2026-03-10T18:00:00+08:00\"",
"dws calendar event list --calendar-id primary"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.list_calendars": {
"use_when": [
"我有几个日历/查所有日历/别人共享给我的日历/他人共享给我的日历本;列表",
"查下xxx的日程安排;查询是否有共享关系"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询用户的所有日历,其中id = \"primary\"为主日历(name = \"我的日历\"),为固定值。”"
],
"examples": [
"dws calendar book list"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.list_meeting_room_groups": {
"use_when": [
"会议室/订会议室;分组"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“会议室分组列表”"
],
"examples": [
"dws calendar room list-groups",
"dws calendar room list-groups --limit 20 --page 0"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.list_suggested_event_times": {
"use_when": [
"日程/会议/约会/日历;推荐时间/什么时候有空/协调时间"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“根据参会人推荐可用时间”"
],
"examples": [
"dws calendar event suggest --users userId1,userId2 --duration 60",
"dws calendar event suggest --start \"2026-03-10T09:00:00+08:00\" --end \"2026-03-10T18:00:00+08:00\" --users userId1"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.query_available_meeting_room": {
"use_when": [
"会议室/订会议室;哪个空闲",
"会议室/订会议室;按名找会议室(如「永澄亭」「永澄亭会议室」「约西湖厅」)",
"搜索空闲会议室",
"搜索空闲会议室,记下 roomId"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询 [startTime, endTime] 时间段内所有可用的会议室。”"
],
"examples": [
"dws calendar room search --start \"2026-03-10T14:00:00+08:00\" --end \"2026-03-10T15:00:00+08:00\"",
"dws calendar room search --start \"2026-03-10T14:00:00+08:00\" --end \"2026-03-10T15:00:00+08:00\" --group-id <GROUP_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.query_busy_status": {
"use_when": [
"同时查用户 + 会议室",
"有空吗/忙不忙/闲忙;查询会议室闲忙",
"有空吗/忙不忙/闲忙;查询用户闲忙",
"有空吗/忙不忙/闲忙;用户 + 会议室一起查",
"查会议室闲忙",
"查用户闲忙"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询用户闲忙状态”"
],
"examples": [
"dws calendar busy search --users <USER_ID_1>,<USER_ID_2> --start \"2026-03-10T14:00:00+08:00\" --end \"2026-03-10T18:00:00+08:00\"",
"dws calendar busy search --rooms <ROOM_ID_1>,<ROOM_ID_2> --start \"2026-03-10T14:00:00+08:00\" --end \"2026-03-10T18:00:00+08:00\""
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.remove_calendar_participant": {
"use_when": [
"参会人/与会者;移除"
],
"avoid_when": [
"用户未明确要求“移除参与者”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws calendar attendee delete --attendees <attendees> --event <event>"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.respond": {
"use_when": [
"日程/会议/约会/日历;接受/拒绝/暂定日程"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“作为日程参会人,设置自己的响应状态(接受、拒绝、暂定)。”所述变更时不要使用"
],
"examples": [
"dws calendar event respond --id <EVENT_ID> --status accepted",
"dws calendar event respond --id <EVENT_ID> --status declined"
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.search_calendar": {
"use_when": [
"我有几个日历/查所有日历/别人共享给我的日历/他人共享给我的日历本;按名称搜索日历本"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“搜索当前用户拥有的日历本,支持按日历本名模糊搜索。”"
],
"examples": [
"dws calendar book search --query \"项目\"",
"dws calendar book search --query \"团队周报\""
],
"interface_mode": "mcp",
"availability": "available"
},
"calendar.update_calendar_event": {
"use_when": [
"日程/会议/约会/日历;修改/改时间/改描述"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“修改现有日程的信息,支持更新标题、时间、地点等任意字段,需要组织者权限。”所述变更时不要使用"
],
"examples": [
"dws calendar event update --id <EVENT_ID> --title \"新标题\"",
"dws calendar event update --id <EVENT_ID> --desc \"新描述\" --timezone Asia/Tokyo"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.add_custom_group_role": {
"use_when": [
"创建/添加群身份"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“添加群身份”所述变更时不要使用"
],
"examples": [
"dws chat group-role add --group <openConversationId> --name \"管理员\""
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.add_emoji_reaction": {
"use_when": [
"emoji回应/表情回应/给消息加表情"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“消息添加 emoji 回应”所述变更时不要使用"
],
"examples": [
"dws chat message add-emoji --conversation-id <openConversationId> --msg-id <openMsgId> --emoji \"赞\"",
"dws chat message add-emoji --conversation-id <openConversationId> --msg-id <openMsgId> --emoji \"鼓掌\""
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.add_group_member": {
"use_when": [
"把张三拉进群;添加群成员",
"拉人进群/加群成员"
],
"avoid_when": [
"设管理员/取消管理员;设置群管理员"
],
"examples": [
"dws chat group members add --id <openconversation_id> --users userId1,userId2"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.add_robot_to_group": {
"use_when": [
"加机器人到群",
"邀请机器人进群"
],
"avoid_when": [
"从群里移除机器人/踢机器人;移除群内机器人"
],
"examples": [
"dws chat group members add-bot --robot-code <robot-code> --id <openconversation_id>",
"dws chat group members add-bot --group <openconversation_id> --robot-code <robot-code>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.add_text_emotion": {
"use_when": [
"文字表情回应/添加文字表情"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“添加文字表情”所述变更时不要使用"
],
"examples": [
"dws chat message add-text-emotion --conversation-id <openConversationId> --msg-id <openMsgId> --emotion-id <emotionId> --emotion-name \"赞\" --text \"nice\" --background-id im_bg_5"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.combine_forward_messages": {
"use_when": [
"合并转发/批量转发/合并转发多条消息",
"合并转发/批量转发/合并转发多条消息;合并转发多条消息"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“合并转发消息”所述变更时不要使用"
],
"examples": [
"dws chat message combine-forward --src-conversation-id <srcOpenCid> --msg-ids <id1>,<id2>,<id3> --dest-conversation-id <destOpenCid>",
"dws chat message combine-forward --src-conversation-id <srcOpenCid> --msg-ids <id1>,<id2> --dest-conversation-id <destOpenCid> --uuid <idempotencyKey>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.create_and_send_card": {
"use_when": [
"发卡片消息/推送流式卡片;创建并推送流式卡片"
],
"avoid_when": [
"更新卡片/流式更新卡片;流式更新卡片内容"
],
"examples": [
"dws chat message send-card --group <openConversationId>",
"dws chat message send-card --receiver <openDingTalkId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.create_smart_conv_category": {
"agent_summary": "创建按群名称关键词或群成员自动匹配会话的智能分组",
"use_when": [
"需要按群名称关键词或群成员自动归类会话时创建智能会话分组"
],
"avoid_when": [
"只需要普通静态会话分组,或不希望根据关键词和成员自动匹配会话时不要使用"
],
"examples": [
"dws chat category create-smart --name \"重点项目群\" --keywords \"项目,重点\""
],
"reviewed": true
},
"chat.create_group_conversation": {
"use_when": [
"帮我建一个项目群;创建群聊",
"建群/创建群聊"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建一个群聊,支持指定群名称、初始成员列表等参数。”所述变更时不要使用"
],
"examples": [
"dws chat group create --name \"Q1 项目冲刺群\" --users userId1,userId2,userId3"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.create_text_emotion": {
"use_when": [
"创建文字表情/新建文字表情"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建文字表情”所述变更时不要使用"
],
"examples": [
"dws chat message create-text-emotion --emotion-name \"赞\" --text \"nice\"",
"dws chat message create-text-emotion --emotion-name \"感谢\" --text \"感谢\" --background-id im_bg_5"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.dismiss_group": {
"use_when": [
"解散群/解散群聊",
"解散群/解散群聊;解散群聊"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“解散群聊”所述变更时不要使用"
],
"examples": [
"dws chat group dismiss --group <openConversationId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.download_media": {
"use_when": [
"下载聊天消息中的图片/视频/语音等资源到本地文件"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“下载聊天消息中的图片/视频/语音等资源到本地文件”"
],
"examples": [
"dws chat message download-media --type mediaId --resource-id <mediaId> --message-id <openMessageId> --open-conversation-id <openConversationId> --output ./photo.jpg",
"dws chat message download-media --type mediaId --resource-id <mediaId> --message-id <openMessageId> --open-conversation-id <openConversationId> --output ./downloads/photo.jpg"
],
"interface_mode": "composite",
"availability": "available",
"interface_reason": "命令包含多个 RPC、条件分派或本地 HTTP/文件步骤,不能绑定为单一 interface_ref"
},
"chat.forward_message": {
"use_when": [
"转发消息/把消息转到另一个群;转发单条消息",
"转发消息/转发一条消息/把消息转发到另一个群"
],
"avoid_when": [
"合并转发/批量转发/合并转发多条消息;合并转发多条消息",
"转发话题/转发话题消息/话题转发到另一个群;转发话题消息"
],
"examples": [
"dws chat message forward --src-conversation-id <srcOpenCid> --msg-id <openMessageId> --dest-conversation-id <destOpenCid>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.forward_topic": {
"use_when": [
"转发话题/转发话题消息",
"转发话题/转发话题消息/话题转发到另一个群;转发话题消息"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“转发某个话题到其他会话”所述变更时不要使用"
],
"examples": [
"dws chat message forward-topic --src-conversation-id <srcOpenCid> --src-msg-id <openMessageId> --src-thread-id <convThreadId> --dest-conversation-id <destOpenCid>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.get_conv_info_by_group_id": {
"use_when": [
"根据群号查群信息/群号查群/群号转openConversationId",
"根据群号查群信息/群号转openConversationId;群号查群聊信息"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“根据群号获取群聊信息”"
],
"examples": [
"dws chat group get-by-group-id --group-id 12345678"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.get_conversation_info": {
"use_when": [
"获取会话的基础信息"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取会话的基础信息”"
],
"examples": [
"dws chat conversation-info --group <openConversationId> --format json",
"dws chat conversation-info --user <userId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.get_group_invite_url": {
"use_when": [
"群邀请链接/入群链接/加群链接"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取群邀请链接”"
],
"examples": [
"dws chat group invite-url --group <openConversationId>",
"dws chat group invite-url --group <openConversationId> --expires-seconds 86400"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.get_group_members": {
"use_when": [
"查看群成员列表"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查看群成员列表”"
],
"examples": [
"dws chat group members list --id <id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.list_conversation_message_v2": {
"use_when": [
"2. 拉取群消息",
"和某人的单聊聊天记录/拉某人单聊历史",
"拉取一下上周项目群的聊天记录;拉取会话消息",
"拉取和张三的单聊记录;拉取单聊消息",
"拉取和某人的单聊记录/单聊消息",
"某个群的聊天记录",
"聊天记录/会话消息/拉取会话"
],
"avoid_when": [
"DING消息/查DING/DING历史;查询 DING 消息列表",
"查看我今天的所有消息;全量会话消息",
"查看钉住的消息/Pin列表/钉住消息列表;拉取钉住消息列表",
"看看张三发给我的消息;按发送者查询消息"
],
"examples": [
"dws chat message list --group <openconversation_id> --time \"2025-03-01 00:00:00\"",
"dws chat message list --user <userId> --time \"2025-03-01 00:00:00\" --limit 50"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.list_conversations_by_category": {
"use_when": [
"某个分组下有哪些会话;分组下会话列表",
"某个分组下的会话/分组会话列表"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“拉取用户指定自定义会话分组下的会话”"
],
"examples": [
"dws chat category list-conversations --category-id <分组ID>",
"dws chat category list-conversations --category-id <分组ID> --exclude-muted"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.list_custom_group_roles": {
"use_when": [
"查看群身份/群的自定义身份列表"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“拉取会话的群身份”"
],
"examples": [
"dws chat group-role list --group <openConversationId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.list_group_bots": {
"use_when": [
"群机器人列表/群里有哪些机器人/查看群机器人",
"群里有哪些机器人/查看群机器人/列出群机器人;查看群内机器人列表"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取群内所有机器人”"
],
"examples": [
"dws chat group bots --group <openConversationId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.list_individual_chat_message": {
"use_when": [
"拉取指定用户的单聊会话消息内容"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“拉取指定用户的单聊会话消息内容”"
],
"examples": [
"dws chat message list-direct --time <time> --user <user>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.list_messages_by_ids": {
"use_when": [
"批量查消息/按ID查消息/根据消息ID查"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“批量查消息”"
],
"examples": [
"dws chat message list-by-ids --msg-ids msgId1,msgId2,msgId3"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.list_owned_or_admin_groups": {
"use_when": [
"我创建的群/我管理的群/我是群主的群/我当管理员的群",
"我创建的群/我管理的群/我是群主的群/我当管理员的群;拉取我创建/管理的群"
],
"avoid_when": [
"我加入的所有群/拉取全部群列表/我的群;分页拉取所有群"
],
"examples": [
"dws chat group list-my-groups",
"dws chat group list-my-groups --role OWNER"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.list_pin_messages": {
"use_when": [
"查看钉住的消息/Pin列表/钉住消息列表;拉取钉住消息列表"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“拉取会话中钉住的(pin)消息列表”"
],
"examples": [
"dws chat message list-pin-msg --open-conversation-id <openConversationId>",
"dws chat message list-pin-msg --open-conversation-id <openConversationId> --size 50"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.list_special_focus_messages": {
"use_when": [
"我特别关注的人最近发了什么消息/关注的人最近聊了啥/星标联系人最近的动态",
"特别关注人的消息/关注的人的消息/星标联系人的消息"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“拉取特别关注人的消息”"
],
"examples": [
"dws chat message list-focused --limit 50",
"dws chat message list-focused --limit 20 --cursor <nextCursor>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.list_top_conversations": {
"use_when": [
"置顶会话/置顶消息",
"置顶会话/置顶消息/我的置顶/查看置顶"
],
"avoid_when": [
"所有会话/全部会话列表/我的会话;分页获取全部会话",
"置顶会话/取消置顶;设置/取消会话置顶"
],
"examples": [
"dws chat list-top-conversations --limit 1000",
"dws chat list-top-conversations --limit 1000 --cursor <nextCursor>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.list_topic_replies": {
"use_when": [
"群里某条话题的回复",
"话题回复/群话题消息回复/拉取话题回复"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“拉取群话题回复消息列表”"
],
"examples": [
"dws chat message list-topic-replies --group <openconversation_id> --topic-id <topicId>",
"dws chat message list-topic-replies --group <openconversation_id> --topic-id <topicId> --time \"2025-03-01 00:00:00\" --limit 20"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.list_user_define_conv_categories": {
"use_when": [
"查看会话分组/自定义分组",
"查看会话分组/自定义分组;获取会话分组"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取用户自定义会话分组”"
],
"examples": [
"dws chat category list"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.query_custom_user_roles": {
"use_when": [
"查询某人的群身份/某人在群里有什么身份"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“根据用户提供的群和成员为在群里查询成员的群身份”"
],
"examples": [
"dws chat group-role query-user --group <openConversationId> --user <userId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.query_message_send_status": {
"use_when": [
"查询消息发送状态/消息发没发成功/消息状态",
"消息发没发成功/查询消息发送状态;查询消息发送状态"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询以当前用户的身份发送的消息的发送状态”"
],
"examples": [
"dws chat message query-send-status --open-task-id <openTaskId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.query_msg_read_status": {
"use_when": [
"消息已读未读/谁看了消息/查读状态/消息读取状态",
"谁看了这条消息/消息已读未读/查读状态;查询消息已读状态"
],
"avoid_when": [
"DING接收状态/谁收到了DING;DING 接收状态",
"未读消息会话/未读会话列表/我的未读会话;未读会话列表"
],
"examples": [
"dws chat message read-status --conversation-id <openConversationId> --message-id <openMessageId>",
"dws chat message read-status --conversation-id <openConversationId> --message-id <openMessageId> --user userId1,userId2"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.quit_group": {
"use_when": [
"退群/退出群聊/离开群;退出群聊"
],
"avoid_when": [
"解散群/解散群聊;解散群聊"
],
"examples": [
"dws chat group quit --group <openConversationId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.recall_message": {
"use_when": [
"撤回我发的消息/撤回消息",
"撤回我发的消息/撤回消息;撤回个人消息"
],
"avoid_when": [
"撤回DING;撤回 DING 消息"
],
"examples": [
"dws chat message recall --conversation-id <openConversationId> --msg-id <openMessageId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.recall_robot_message": {
"use_when": [
"撤回机器人发的消息/机器人撤回消息",
"机器人撤回消息(--group 群聊 / 不传为单聊)",
"用同一个 robot-code + processQueryKey 撤回"
],
"avoid_when": [
"撤回我发的消息/撤回消息;撤回个人消息"
],
"examples": [
"dws chat message recall-by-bot --robot-code <robot-code> --group <openconversation_id> --keys <process-query-key>",
"dws chat message recall-by-bot --robot-code <robot-code> --keys key1,key2"
],
"interface_mode": "composite",
"availability": "available",
"interface_reason": "命令包含多个 RPC、条件分派或本地 HTTP/文件步骤,不能绑定为单一 interface_ref"
},
"chat.remove_custom_group_role": {
"use_when": [
"删除群身份"
],
"avoid_when": [
"用户未明确要求“删除群身份”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws chat group-role remove --group <openConversationId> --role-id <openRoleId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.remove_custom_user_roles": {
"use_when": [
"移除某人的群身份/撤销群身份"
],
"avoid_when": [
"用户未明确要求“移除用户的群身份”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws chat group-role remove-user --group <openConversationId> --user <userId> --role-ids roleId1,roleId2"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.remove_emoji_reaction": {
"use_when": [
"取消emoji回应/移除表情回应"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“消息删除emoji回应”所述变更时不要使用"
],
"examples": [
"dws chat message remove-emoji --conversation-id <openConversationId> --msg-id <openMsgId> --emoji \"赞\""
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.remove_group_member": {
"use_when": [
"踢人/移除群成员"
],
"avoid_when": [
"退群/退出群聊/离开群;退出群聊"
],
"examples": [
"dws chat group members remove --id <openconversation_id> --users userId1,userId2"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.remove_robot_in_group": {
"use_when": [
"从群里移除机器人/踢出机器人",
"从群里移除机器人/踢机器人;移除群内机器人"
],
"avoid_when": [
"用户未明确要求“从群内移除机器人”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws chat group members remove-bot --id <openConversationId> --bot-id <openBotId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.remove_text_emotion": {
"use_when": [
"取消文字表情回应/移除文字表情"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“删除文字表情”所述变更时不要使用"
],
"examples": [
"dws chat message remove-text-emotion --conversation-id <openConversationId> --msg-id <openMsgId> --emotion-id <emotionId> --emotion-name \"赞\" --text \"nice\" --background-id <backgroundId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.reply_personal_message": {
"use_when": [
"引用回复/回复消息/引用消息回复",
"引用消息回复/回复那条消息;引用回复消息",
"需要保留被回复消息的引用关系"
],
"avoid_when": [
"不需要引用上下文的普通发送使用 chat message send"
],
"examples": [
"dws chat message reply --conversation-id <openConversationId> --ref-msg-id <openMessageId> --ref-sender <openDingTalkId> --text \"收到,马上处理\""
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.search_at_me_message": {
"use_when": [
"@我的消息/at我的/提及我的",
"@我的消息/提及我的",
"谁@了我/查看提及我的消息;查询@我的消息"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“拉取 @我 的消息”"
],
"examples": [
"dws chat message list-mentions --start \"2026-03-10T00:00:00+08:00\" --end \"2026-03-11T00:00:00+08:00\" --limit 50 --cursor 0",
"dws chat message list-mentions --start \"2026-04-01T00:00:00+08:00\" --end \"2026-04-14T00:00:00+08:00\" --limit 20 --cursor 0"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.search_bots": {
"use_when": [
"搜索机器人 — 提取 openDingTalkId(必须用 find,search 没有此字段)",
"搜索机器人/找机器人/查机器人/帮我找XXX机器人",
"搜索机器人/找机器人/查机器人/帮我找XXX机器人;搜索全部可用机器人",
"给机器人发单聊/给机器人发消息/跟机器人聊天",
"给机器人发单聊/给机器人发消息/跟机器人聊天;给机器人发单聊消息"
],
"avoid_when": [
"我创建的机器人/我的机器人/我自己的机器人/查看我的机器人;搜索我创建的机器人"
],
"examples": [
"dws chat bot find --query \"日报\"",
"dws chat bot find --query \"日报\" --limit 20"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.search_common_groups": {
"use_when": [
"我和XX的共同群/我们都在哪些群/查共同群",
"我和某人的共同群",
"我和风雷的共同群/我们都在哪些群;搜索共同群"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“搜索共同群(指定昵称列表,查询共同所在的群聊)”"
],
"examples": [
"dws chat search-common --nicks \"风雷,山乔\" --limit 20 --cursor 0",
"dws chat search-common --nicks \"天鸡,乐函\" --match-mode OR --limit 20 --cursor 0"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.search_groups": {
"use_when": [
"1. 搜索群 — 提取 openconversation_id",
"搜索群/找群"
],
"avoid_when": [
"我创建的群/我管理的群/我是群主的群/我当管理员的群;拉取我创建/管理的群",
"我和风雷的共同群/我们都在哪些群;搜索共同群",
"搜一下消息里的changefree链接;消息搜索",
"根据群号查群信息/群号转openConversationId;群号查群聊信息"
],
"examples": [
"dws chat search --query \"项目冲刺\"",
"dws chat search --query \"项目冲刺\" --limit 20 --cursor 0"
]
},
"chat.search_messages": {
"use_when": [
"多维度搜索/按发送者搜索/按人搜消息/指定多个群搜索/@我的消息搜索",
"按发送者搜索/指定多个群搜索/多维度搜消息;多维度搜索消息",
"搜一下消息里的changefree链接;消息搜索",
"搜索消息/查找关键词/搜一下消息里的XX",
"搜索消息里的关键词/包含XX的消息"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“搜索消息,支持多种维度:时间范围、关键词、发送者、at我的、at指定用户、会话”"
],
"examples": [
"dws chat message search-advanced --query \"周报\" --start \"2026-04-01T00:00:00+08:00\" --end \"2026-04-15T00:00:00+08:00\"",
"dws chat message search-advanced --user <userId> --start \"2026-04-01T00:00:00+08:00\" --end \"2026-04-15T00:00:00+08:00\""
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.search_messages_by_keyword": {
"use_when": [
"按关键词搜索消息"
],
"avoid_when": [
"按发送者搜索/指定多个群搜索/多维度搜消息;多维度搜索消息",
"搜一下智能化方案/最近 OKR 相关邮件/最近发版相关消息;搜企业知识内容"
],
"examples": [
"dws chat message search --query \"changefree\" --start \"2026-04-01T00:00:00+08:00\" --end \"2026-04-15T00:00:00+08:00\" --limit 50 --cursor 0",
"dws chat message search --query \"codereview\" --group <openconversation_id> --start \"2026-04-01T00:00:00+08:00\" --end \"2026-04-15T00:00:00+08:00\" --limit 100 --cursor 0"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.search_messages_by_sender": {
"use_when": [
"某人发给我的消息/指定发送者/某人的消息",
"某人发给我的消息/指定发送者的消息/某人最近的消息",
"看看张三发给我的消息;按发送者查询消息"
],
"avoid_when": [
"拉取和张三的单聊记录;拉取单聊消息"
],
"examples": [
"dws chat message list-by-sender --sender-user-id <userId> --start \"2026-03-10T00:00:00+08:00\" --end \"2026-03-11T00:00:00+08:00\" --limit 50 --cursor 0",
"dws chat message list-by-sender --sender-open-dingtalk-id <openDingTalkId> --start \"2026-03-10T00:00:00+08:00\" --end \"2026-03-11T00:00:00+08:00\" --limit 50 --cursor 0"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.search_messages_by_time_range": {
"use_when": [
"我最近所有消息/我今天的消息",
"所有消息/全部会话消息/拉取全部消息/时间范围内消息/我的消息/我今天的消息/查我的钉钉消息/最近的消息",
"查看我今天的所有消息;全量会话消息"
],
"avoid_when": [
"谁@了我/查看提及我的消息;查询@我的消息"
],
"examples": [
"dws chat message list-all --start \"2025-03-01 00:00:00\" --end \"2025-03-31 23:59:59\" --limit 50",
"dws chat message list-all --start \"2025-03-01 00:00:00\" --end \"2025-03-31 23:59:59\" --limit 50 --cursor \"abc123token\""
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.search_my_robots": {
"use_when": [
"我创建的机器人/我的机器人/我自己的机器人/查看我的机器人",
"我创建的机器人/我的机器人/我自己的机器人/查看我的机器人;搜索我创建的机器人",
"查我的机器人 — 提取 robot-code",
"查看我的机器人"
],
"avoid_when": [
"搜索机器人/找机器人/查机器人/帮我找XXX机器人;搜索全部可用机器人",
"给机器人发单聊/给机器人发消息/跟机器人聊天;给机器人发单聊消息"
],
"examples": [
"dws chat bot search --page 1",
"dws chat bot search --page 1 --size 10 --name \"日报\""
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.send_message_by_custom_robot": {
"use_when": [
"7. Webhook 发告警",
"CPU 超过 90% 自动告警;Webhook 告警",
"Webhook 发消息/告警消息"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“自定义机器人 Webhook 发送群消息”所述变更时不要使用"
],
"examples": [
"dws chat message send-by-webhook --token <webhook-token> --title \"告警\" --text \"CPU 超 90% @10\" --at-all",
"dws chat message send-by-webhook --token <webhook-token> --title \"test\" --text \"hi @118785\" --at-users 118785"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.send_personal_message": {
"use_when": [
"3. 以个人身份发送群消息",
"4. 以个人身份单聊(通过 userId)",
"4b. 以个人身份单聊(通过 openDingTalkId,三方应用等无法获取 userId 时使用)",
"使用当前用户身份发送图片或本地文件",
"再 dws drive info --file-id <fileId> --space-id <spaceId> 获取 dentryId",
"单聊(推荐 --open-dingtalk-id)",
"发单聊消息(以个人身份)",
"发群消息(以个人身份)",
"发送图片",
"发送普通群消息或单聊消息",
"幂等发送(24h 内相同 uuid 不重复投递)",
"用 Markdown 语法发送",
"用 Markdown 语法发送(mediaId 作为图片引用)",
"用 openDingTalkId 发单聊消息",
"给机器人发单聊/给机器人发消息/跟机器人聊天;给机器人发单聊消息",
"群聊",
"通知群里的人都来开会;个人身份群发"
],
"avoid_when": [
"使用机器人身份发送时选择 send-by-bot 或 send-by-webhook",
"发DING/DING通知;发送 DING 消息",
"发卡片消息/推送流式卡片;创建并推送流式卡片",
"引用回复已有消息时使用 chat message reply",
"引用消息回复/回复那条消息;引用回复消息",
"让机器人每天推送日报;机器人定时推送",
"转发消息/把消息转到另一个群;转发单条消息"
],
"examples": [
"dws chat message send --group <openconversation_id> --text \"hello\"",
"dws chat message send --user <userId> --text \"请查收\""
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.send_robot_message": {
"use_when": [
"5. 机器人发群消息(Markdown)",
"6. 机器人单聊发消息",
"@所有人",
"尝试发送,若报\"机器人不存在\"则执行 Step 3",
"或者用 openDingtalkId 发送并 @",
"机器人发消息/机器人群发",
"机器人发送消息(--group 群聊 / --users 单聊)",
"用 userId 发送并 @(注意 text 中 @userId)",
"用机器人发消息 — 提取返回中的 processQueryKey",
"给张三发一条机器人单聊消息;机器人单聊",
"让机器人每天推送日报;机器人定时推送",
"重新发送"
],
"avoid_when": [
"CPU 超过 90% 自动告警;Webhook 告警",
"通知群里的人都来开会;个人身份群发"
],
"examples": [
"dws chat message send-by-bot --robot-code <robot-code> --group <openconversation_id> --title \"日报\" --text \"## 今日完成...\"",
"dws chat message send-by-bot --robot-code <robot-code> --users userId1,userId2 --title \"提醒\" --text \"请提交周报\""
],
"interface_mode": "composite",
"availability": "available",
"interface_reason": "命令包含多个 RPC、条件分派或本地 HTTP/文件步骤,不能绑定为单一 interface_ref"
},
"chat.set_custom_user_roles": {
"use_when": [
"给某人设置群身份/设定用户的群身份"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“根据用户提供的群和身份为用户设置群身份”所述变更时不要使用"
],
"examples": [
"dws chat group-role set-user --group <openConversationId> --user <userId> --role-ids roleId1,roleId2"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.set_group_member_mute_list": {
"use_when": [
"禁言某人/指定成员禁言/解除某人禁言",
"禁言某人/指定成员禁言;指定成员禁言"
],
"avoid_when": [
"全员禁言/群禁言;全员禁言或解除"
],
"examples": [
"dws chat group-mute-member --group <group> --users <users>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.set_group_mute": {
"use_when": [
"全员禁言/群禁言/解除禁言",
"全员禁言/群禁言;全员禁言或解除"
],
"avoid_when": [
"禁言某人/指定成员禁言;指定成员禁言"
],
"examples": [
"dws chat group-mute --group <group>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.set_pin_message": {
"use_when": [
"钉住消息/Pin消息/置顶消息到会话;钉住消息"
],
"avoid_when": [
"取消钉住/Unpin消息;取消钉住消息"
],
"examples": [
"dws chat message set-pin-msg --open-conversation-id <openConversationId> --msg-id <openMessageId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.set_top_conversation": {
"use_when": [
"置顶会话/取消置顶/会话置顶",
"置顶会话/取消置顶;设置/取消会话置顶"
],
"avoid_when": [
"置顶某条消息/把这条消息置顶;置顶消息",
"钉住消息/Pin消息/置顶消息到会话;钉住消息"
],
"examples": [
"dws chat set-top --conversation-id <conversation-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.transfer_group_owner": {
"use_when": [
"转让群主/换群主/群主转让"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“群主转让”所述变更时不要使用"
],
"examples": [
"dws chat group transfer-owner --group <openConversationId> --new-owner <openDingTalkId>",
"dws chat group transfer-owner --group <openConversationId> --user <userId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.unread_message_conversation_list": {
"use_when": [
"2b. 拉取未读会话列表",
"未读会话列表",
"未读消息会话/未读会话列表/我的未读会话",
"未读消息会话/未读会话列表/我的未读会话;未读会话列表"
],
"avoid_when": [
"谁看了这条消息/消息已读未读/查读状态;查询消息已读状态"
],
"examples": [
"dws chat message list-unread-conversations",
"dws chat message list-unread-conversations --count 20"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.unset_pin_message": {
"use_when": [
"取消钉住/Unpin消息;取消钉住消息"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“取消某条钉住的(pin)消息”所述变更时不要使用"
],
"examples": [
"dws chat message unset-pin-msg --open-conversation-id <openConversationId> --msg-id <openMessageId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.update_conv_member_roles": {
"use_when": [
"设管理员/取消管理员/设置群管理员",
"设管理员/取消管理员;设置群管理员"
],
"avoid_when": [
"改群设置/群设置开关/群权限/入群许可/禁止私聊;更新群设置"
],
"examples": [
"dws chat group set-admin --group <group> --users <users>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.update_custom_group_role": {
"use_when": [
"修改/更新群身份名称"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新群身份”所述变更时不要使用"
],
"examples": [
"dws chat group-role update --group <openConversationId> --role-id <openRoleId> --name \"新名称\""
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.update_group_icon": {
"use_when": [
"改群头像/更新群头像;更新群头像"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新群头像”所述变更时不要使用"
],
"examples": [
"dws chat group update-icon --group <openConversationId> --icon-media-id <mediaId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.update_group_name": {
"use_when": [
"改群名"
],
"avoid_when": [
"改群头像/更新群头像;更新群头像",
"改群昵称/设置群昵称/我在群里的名字;设置个人群昵称",
"群备注/给群加备注/修改群备注;设置群备注"
],
"examples": [
"dws chat group rename --id <openconversation_id> --name \"新群名\""
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.update_group_settings": {
"use_when": [
"改群设置/群设置开关/群权限/入群许可/禁止私聊;更新群设置"
],
"avoid_when": [
"新成员看历史/历史消息可见范围;设置新成员可见历史消息"
],
"examples": [
"dws chat group update-settings --group <openConversationId> --setting-key searchable --status 1",
"dws chat group update-settings --group <openConversationId> --setting-key onlyAdminCanAtAll --status 0"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.update_notification_off": {
"use_when": [
"免打扰/消息免打扰/静音/开启免打扰/关闭免打扰"
],
"avoid_when": [
"关闭@所有人通知/屏蔽@all/不接收@所有人;关闭 @所有人提醒",
"关闭红包通知/屏蔽红包/不接收红包提醒;关闭红包提醒",
"隐藏会话/隐藏群聊/隐藏对话;隐藏会话"
],
"examples": [
"dws chat mute --conversation-id <openConversationId>",
"dws chat mute --conversation-id <openConversationId> --off"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.update_show_history_msg_option": {
"use_when": [
"新成员看历史/历史消息可见范围;设置新成员可见历史消息",
"设置历史消息/新成员看历史/新成员可见消息"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“设置新成员入群可查看历史消息选项”所述变更时不要使用"
],
"examples": [
"dws chat group set-history --group <openConversationId> --option RECENT_100",
"dws chat group set-history --group <openConversationId> --option FORBIDDEN"
],
"interface_mode": "mcp",
"availability": "available"
},
"chat.update_streaming_card": {
"use_when": [
"更新卡片/流式更新卡片;流式更新卡片内容"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“流式更新卡片内容”所述变更时不要使用"
],
"examples": [
"dws chat message update-card --biz-id <bizId> --content \"更新的卡片内容\" --flow-status 2",
"dws chat message update-card --biz-id <bizId> --content \"最终内容\" --flow-status 3"
],
"interface_mode": "mcp",
"availability": "available"
},
"conference.ai_close_camera": {
"use_when": [
"关闭摄像头"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference camera close"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_close_simultaneous_interpretation": {
"use_when": [
"关闭同声传译"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference interpretation close"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_close_subtitle": {
"use_when": [
"关闭实时字幕"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference subtitle close"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_close_transcript": {
"use_when": [
"关闭智能听记"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference transcript close"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_end_meeting_for_all": {
"use_when": [
"结束整场会议并让所有参会者退出(不可逆)"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference end"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_leave_myself": {
"use_when": [
"本人离开当前会议(其他人继续)"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference leave"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_mute_all": {
"use_when": [
"主持人将会议内全体参会者静音"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference mic mute-all"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_mute_mic": {
"use_when": [
"静音自己"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference mic mute"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_one_click_call": {
"use_when": [
"一键呼叫所有人"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference invite all"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_open_annotation": {
"use_when": [
"打开共享批注"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference share annotate"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_open_beauty_setting_page": {
"use_when": [
"打开美颜设置面板"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference appearance beauty-setting"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_open_camera": {
"use_when": [
"打开摄像头"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference camera open"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_open_interactive_panel": {
"use_when": [
"打开表情互动面板"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference interaction panel"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_open_invite_member_panel": {
"use_when": [
"打开邀请选人面板"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference invite panel"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_open_security_menu": {
"use_when": [
"打开安全设置菜单"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference security menu"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_open_share_panel": {
"use_when": [
"打开共享选择面板"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference share panel"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_open_simultaneous_interpretation": {
"use_when": [
"开启同声传译"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference interpretation open"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_open_subtitle": {
"use_when": [
"开启实时字幕"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference subtitle open"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_open_transcript": {
"use_when": [
"开启智能听记"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference transcript open"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_open_virtual_background_setting_page": {
"use_when": [
"打开虚拟背景设置面板"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference appearance background-setting"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_request_record": {
"use_when": [
"申请录制权限"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference record request"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_share_desktop": {
"use_when": [
"开始共享桌面"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference share start"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_start_cloud_record": {
"use_when": [
"开始云端录制当前会议"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference record start"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_stop_cloud_record": {
"use_when": [
"停止当前会议的云端录制"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference record stop"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_stop_share": {
"use_when": [
"停止屏幕共享"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference share stop"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_switch_gallery_view": {
"use_when": [
"切换宫格视图"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference view grid"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_switch_speaker_view": {
"use_when": [
"切换演讲者视图"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference view speaker"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_switch_standard_view": {
"use_when": [
"切换标准视图"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference view standard"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_take_group_photo": {
"use_when": [
"发起全员合影"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference photo take"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.ai_unmute_mic": {
"use_when": [
"取消静音"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference mic unmute"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.create_conference": {
"use_when": [
"发起一场即时会议"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference start"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.get_conference_id": {
"use_when": [
"获取当前所在会议的会议 ID(需在会议中)"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference get-id"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"conference.get_conference_status": {
"use_when": [
"查询当前会议状态(是否在会议中)"
],
"avoid_when": [
"当前开源版本未提供可用会议后端;未安装并启用受审查的会议插件时不要使用"
],
"examples": [
"dws conference status"
],
"interface_mode": "local",
"availability": "unavailable",
"interface_reason": "当前开源版本的 conference 产品已下线,仅保留冻结兼容命令面,未注册静态 MCP 后端"
},
"contact.get_authorized_emp_rosterInfo": {
"use_when": [
"11. 根据字段 code 查询指定员工的花名册信息",
"12. 查询所有可见字段的花名册信息",
"花名册/员工档案/学历/家庭/银行卡/紧急联系人/合同"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询员工花名册字段信息,根据当前用户指定员工和字段列表,查询相应管理范围内员工的字段值信息”"
],
"examples": [
"dws contact user profile get --staff-id STAFF_ID",
"dws contact user profile get --staff-id STAFF_ID --fields fieldCode1,fieldCode2"
],
"interface_mode": "mcp",
"availability": "available"
},
"contact.get_current_user_profile": {
"use_when": [
"1. 查看自己的信息 — 提取 userId",
"我是谁/我的信息/我的 userId/当前用户/本人/self/me/whoami"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取当前用户信息”"
],
"examples": [
"dws contact user get-self",
"dws contact user get-self --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"contact.get_dept_info_by_dept_id": {
"use_when": [
"4. 查看部门详情(部门ID、名称、人数)",
"研发部有多少人;查部门人数",
"研发部的详细信息/部门信息;查部门详情",
"部门详情/部门信息/部门多少人"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“根据指定的部门 ID,获取部门详情。”"
],
"examples": [
"dws contact dept get-info --dept 12345",
"dws contact dept get-info --dept <deptId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"contact.get_dept_members_by_deptId": {
"use_when": [
"6. 查看部门成员",
"部门有谁/部门成员/人员名单"
],
"avoid_when": [
"研发部有多少人;查部门人数",
"研发部的详细信息/部门信息;查部门详情"
],
"examples": [
"dws contact dept list-members --depts 12345,67890",
"dws contact dept list-members --depts 1 # 根部门"
],
"interface_mode": "mcp",
"availability": "available"
},
"contact.get_sub_depts_by_dept_id": {
"use_when": [
"5. 查看直属子部门 — 提取子 deptId 列表",
"子部门/下设部门/部门有哪些下级部门/枚举二级部门"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“根据指定的部门 ID,获取其直接子部门列表,返回每个子部门的部门 ID、名称。”"
],
"examples": [
"dws contact dept list-children --dept 1 # 枚举根部门下的一级部门",
"dws contact dept list-children --dept 12345 # 枚举指定部门的直属子部门"
],
"interface_mode": "mcp",
"availability": "available"
},
"contact.get_user_info_by_user_ids": {
"use_when": [
"查用户详情/部门/主管/管理员"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“批量获取用户详情(逗号分隔 userId)”"
],
"examples": [
"dws contact user get --ids userId1,userId2",
"dws contact user get --ids userId1,userId2 # 查询 userId: dws contact user search --keyword \"姓名\""
],
"interface_mode": "mcp",
"availability": "available"
},
"contact.list_authorized_roster_fields": {
"use_when": [
"10. 查询花名册有权限的字段列表",
"花名册字段/有哪些字段/字段列表"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询花名册有权限的字段列表,根据当前用户查询花名册有权限的字段列表”"
],
"examples": [
"dws contact user profile fields"
],
"interface_mode": "mcp",
"availability": "available"
},
"contact.list_my_followings": {
"use_when": [
"我关注了谁/我的特别关注列表/我的星标联系人/特别关注的人有哪些"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取我的特别关注列表”"
],
"examples": [
"dws contact relation list-my-followings"
],
"interface_mode": "mcp",
"availability": "available"
},
"contact.query_dismission_employee_list": {
"use_when": [
"13. 查询全部离职员工",
"14. 按姓名/时间范围/部门筛选离职员工",
"离职员工/离职名单/离职人员/已离职"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取离职员工列表,支持按照员工姓名、离职时间范围、部门过滤”"
],
"examples": [
"dws contact user dismission search",
"dws contact user dismission search --name \"张三\""
],
"interface_mode": "mcp",
"availability": "available"
},
"contact.search_contact_by_key_word": {
"use_when": [
"2. 按名字搜索同事或好友 — 可提取 同事的userId,或好友的openDingTalkId"
],
"avoid_when": [
"找一下张三/搜同事/找人;AI搜人(首选)"
],
"examples": [
"dws contact user search --query \"张三\"",
"dws contact user search --query \"张三\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"contact.search_dept_by_keyword": {
"use_when": [
"3. 查看部门结构 — 提取 deptId",
"找部门/哪个部门"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“按关键词搜索部门”"
],
"examples": [
"dws contact dept search --query \"技术部\"",
"dws contact dept search --query \"技术部\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"contact.search_user_by_mobile": {
"use_when": [
"按手机号搜索用户"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“按手机号搜索用户”"
],
"examples": [
"dws contact user search-mobile --mobile 13800138000"
],
"interface_mode": "mcp",
"availability": "available"
},
"dev.add_dev_app_members": {
"use_when": [
"添加开放平台应用成员"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“添加开放平台应用成员”所述变更时不要使用"
],
"examples": [
"dws dev app member add --member-type <member-type> --unified-app-id <unified-app-id> --user-ids <user-ids>"
]
},
"dev.apply_dev_app_permissions": {
"use_when": [
"申请开放平台应用权限点"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“申请开放平台应用权限点”所述变更时不要使用"
],
"examples": [
"dws dev app permission add --unified-app-id <unifiedAppId> --scope-values <scopeValue> --format json"
]
},
"dev.connect_status": {
"use_when": [
"查看/停止后台连接器(status/list 忽略全局 --format,出 JSON 用专属 --json)",
"查看后台连接器守护进程状态(pid、运行时长、日志路径)"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查看后台连接器守护进程状态(pid、运行时长、日志路径)”"
],
"examples": [
"dws dev connect status --json"
],
"interface_mode": "local",
"availability": "available",
"interface_reason": "命令仅操作本地进程或策略文件,不调用 MCP 接口"
},
"dev.connect_stop": {
"use_when": [
"优雅停止后台连接器守护进程(释放单实例锁与 Stream 连接)",
"查看/停止后台连接器(status/list 忽略全局 --format,出 JSON 用专属 --json)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“优雅停止后台连接器守护进程(释放单实例锁与 Stream 连接)”所述变更时不要使用"
],
"examples": [
"dws dev connect stop"
],
"interface_mode": "local",
"availability": "available",
"interface_reason": "命令仅操作本地进程或策略文件,不调用 MCP 接口"
},
"dev.create_dev_app": {
"use_when": [
"创建应用",
"创建开放平台企业内部应用",
"创建开放平台应用,拿 unifiedAppId"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建开放平台企业内部应用”所述变更时不要使用"
],
"examples": [
"dws dev app create --name \"我的 AI 机器人\" --desc \"接 opencode\" --dry-run --format json"
]
},
"dev.create_dev_app_version": {
"use_when": [
"基于当前配置创建应用新版本",
"版本发布/审批,线上搜索、加群、路由消息以 RELEASE 为准"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“基于当前配置创建应用新版本”所述变更时不要使用"
],
"examples": [
"dws dev app version create --unified-app-id <unifiedAppId> --desc \"发布机器人能力\" --dry-run --format json"
]
},
"dev.delete_dev_app": {
"use_when": [
"删除应用(不可逆,需 --confirm-name 二次确认)",
"删除开放平台企业内部应用(不可逆,需 --confirm-name 二次确认)"
],
"avoid_when": [
"用户未明确要求“删除开放平台企业内部应用(不可逆,需 --confirm-name 二次确认)”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws dev app delete --unified-app-id <unified-app-id>"
]
},
"dev.disable_dev_app": {
"use_when": [
"停用/启用应用"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“停用开放平台应用,停用后应用能力对外不可用(可重新启用)”所述变更时不要使用"
],
"examples": [
"dws dev app disable --unified-app-id <unified-app-id>"
]
},
"dev.disable_dev_app_robot": {
"use_when": [
"启用/停用机器人"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“停用开放平台应用的机器人(可重新启用)”所述变更时不要使用"
],
"examples": [
"dws dev app robot disable --unified-app-id <unifiedAppId> --format json"
]
},
"dev.enable_dev_app": {
"use_when": [
"停用/启用应用",
"启用开放平台企业内部应用"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“启用开放平台企业内部应用”所述变更时不要使用"
],
"examples": [
"dws dev app enable --unified-app-id <unified-app-id>"
]
},
"dev.enable_dev_app_robot": {
"use_when": [
"启用/停用机器人",
"启用现有应用机器人能力(纯启用,无需配置字段)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“启用现有应用机器人能力(纯启用,无需配置字段)”所述变更时不要使用"
],
"examples": [
"dws dev app robot enable --unified-app-id <unifiedAppId> --format json"
]
},
"dev.get_dev_app": {
"use_when": [
"查询单个应用详情",
"查询开放平台企业内部应用详情"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询开放平台企业内部应用详情”"
],
"examples": [
"dws dev app get --unified-app-id <unifiedAppId> --format json"
]
},
"dev.get_dev_app_credentials": {
"use_when": [
"查询 clientId/clientSecret(credentials 下只有 get 子命令)",
"读取开放平台应用凭证"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“读取开放平台应用凭证”"
],
"examples": [
"dws dev app credentials get --unified-app-id <unifiedAppId> --format json"
]
},
"dev.get_dev_app_version_detail": {
"use_when": [
"查询指定版本详情"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询指定版本详情”"
],
"examples": [
"dws dev app version get --unified-app-id <unified-app-id> --version-id <version-id>"
]
},
"dev.get_dev_app_version_status": {
"use_when": [
"查询版本发布/审批状态",
"版本发布/审批,线上搜索、加群、路由消息以 RELEASE 为准"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询版本发布/审批状态”"
],
"examples": [
"dws dev app version status --unified-app-id <unifiedAppId> --version-id <versionId> --format json",
"dws dev app version status --unified-app-id <unifiedAppId> --version-id <versionId> --format json"
]
},
"dev.get_extension_robot_config": {
"use_when": [
"查询现有应用的机器人配置",
"查询现有机器人配置"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询现有应用的机器人配置”"
],
"examples": [
"dws dev app robot get --unified-app-id <unifiedAppId> --format json"
]
},
"dev.get_extension_webapp_config": {
"use_when": [
"查询网页应用配置"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询网页应用配置”"
],
"examples": [
"dws dev app webapp get --unified-app-id <unified-app-id>"
]
},
"dev.list_dev_app": {
"use_when": [
"查询应用列表",
"查询开放平台企业内部应用列表"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询开放平台企业内部应用列表”"
],
"examples": [
"dws dev app list --format json"
]
},
"dev.list_dev_app_events": {
"use_when": [
"查询应用已订阅的事件列表"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询应用已订阅的事件列表”"
],
"examples": [
"dws dev app event list --unified-app-id <unifiedAppId> --keyword <关键词> --format json"
]
},
"dev.list_dev_app_members": {
"use_when": [
"查询开放平台应用成员"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询开放平台应用成员”"
],
"examples": [
"dws dev app member list --unified-app-id <unified-app-id>"
]
},
"dev.list_dev_app_permissions": {
"use_when": [
"查询开放平台应用权限列表"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询开放平台应用权限列表”"
],
"examples": [
"dws dev app permission list --unified-app-id <unifiedAppId> --format json"
]
},
"dev.list_dev_app_versions": {
"use_when": [
"分页查询应用版本列表"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“分页查询应用版本列表”"
],
"examples": [
"dws dev app version list --unified-app-id <unified-app-id>"
]
},
"dev.publish_dev_app_version": {
"use_when": [
"发布指定版本(含高敏权限需 --confirmed-sensitive)",
"版本发布/审批,线上搜索、加群、路由消息以 RELEASE 为准"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“发布指定版本(含高敏权限需 --confirmed-sensitive)”"
],
"examples": [
"dws dev app version publish --unified-app-id <unifiedAppId> --version-id <versionId> --dry-run --format json"
]
},
"dev.query_robot_create_result": {
"use_when": [
"建号:轮询结果",
"查询机器人异步创建任务结果"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询机器人异步创建任务结果”"
],
"examples": [
"dws dev app robot result --task-id <taskId> --format json"
]
},
"dev.remove_dev_app_members": {
"use_when": [
"移除开放平台应用的协作成员"
],
"avoid_when": [
"用户未明确要求“移除开放平台应用的协作成员”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws dev app member remove --member-type <member-type> --unified-app-id <unified-app-id> --user-ids <user-ids>"
]
},
"dev.remove_dev_app_permissions": {
"use_when": [
"移除开放平台应用已授予的权限点"
],
"avoid_when": [
"用户未明确要求“移除开放平台应用已授予的权限点”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws dev app permission remove --scope-values <scope-values> --unified-app-id <unified-app-id>"
]
},
"dev.search_open_platform_docs_rag": {
"use_when": [
"搜索开放平台文档"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“搜索开放平台文档”"
],
"examples": [
"dws dev doc search --query <query>"
],
"interface_mode": "mcp",
"availability": "available"
},
"dev.set_extension_robot_config": {
"use_when": [
"创建/更新机器人配置(upsert)",
"创建或更新现有应用的机器人配置(upsert)",
"在明确的 unifiedAppId 上配置机器人能力"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建或更新现有应用的机器人配置(upsert)”所述变更时不要使用"
],
"examples": [
"dws dev app robot config --unified-app-id <unifiedAppId> --name \"小助手\" --desc \"接 opencode\" --dry-run --format json"
]
},
"dev.set_extension_webapp_config": {
"use_when": [
"配置网页应用能力"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“配置网页应用能力”所述变更时不要使用"
],
"examples": [
"dws dev app webapp config --homepage-url <homepage-url> --unified-app-id <unified-app-id>"
]
},
"dev.submit_robot_create_task": {
"use_when": [
"建号:异步提交",
"异步提交钉钉智能体机器人创建任务(支持失败重试)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“异步提交钉钉智能体机器人创建任务(支持失败重试)”所述变更时不要使用"
],
"examples": [
"dws dev app robot submit --name <智能体名> --robot-name <机器人名> --desc <描述> --dry-run --format json"
]
},
"dev.subscribe_dev_app_events": {
"use_when": [
"订阅应用事件回调"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“订阅应用事件回调”所述变更时不要使用"
],
"examples": [
"dws dev app event subscribe --unified-app-id <unifiedAppId> --event-codes <code1>,<code2> --dry-run --format json"
]
},
"dev.unsubscribe_dev_app_events": {
"use_when": [
"取消订阅应用事件"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“取消订阅应用事件”所述变更时不要使用"
],
"examples": [
"dws dev app event unsubscribe --event-codes <event-codes> --unified-app-id <unified-app-id>"
]
},
"dev.update_dev_app": {
"use_when": [
"修改开放平台企业内部应用基础信息",
"更新应用信息(写操作:先 --dry-run 预览,确认后加 --yes 执行;不加 --yes 会被拦下)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“修改开放平台企业内部应用基础信息”所述变更时不要使用"
],
"examples": [
"dws dev app update --unified-app-id <unifiedAppId> --name <新名称> --dry-run --format json"
]
},
"dev.update_dev_app_security_config": {
"use_when": [
"更新开放平台应用安全配置"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新开放平台应用安全配置”所述变更时不要使用"
],
"examples": [
"dws dev app security config --redirect-urls <redirect-urls> --unified-app-id <unified-app-id>"
]
},
"devdoc.devdoc_rag_pretest": {
"use_when": [
"按关键词检索钉钉开放平台文档,只返回参考资料、参考资料链接和RAG上下文,不生成AI分析答案。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“按关键词检索钉钉开放平台文档,只返回参考资料、参考资料链接和RAG上下文,不生成AI分析答案。”"
],
"examples": [
"dws devdoc article rag-pretest <keyword> --keyword <keyword>"
],
"interface_mode": "mcp",
"availability": "available"
},
"devdoc.search_dingtalk_open_docs": {
"use_when": [
"根据关键词搜索钉钉开放平台的开发文档,返回匹配的文档条目列表,包含标题、摘要、文档链接和相关标签。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“根据关键词搜索钉钉开放平台的开发文档,返回匹配的文档条目列表,包含标题、摘要、文档链接和相关标签。”"
],
"examples": [
"dws devdoc article legacy-search <keyword> --keyword <keyword>"
],
"interface_mode": "mcp",
"availability": "available"
},
"devdoc.search_open_error_code_rag": {
"use_when": [
"按原始问题、requestId/traceId、错误码或错误描述排查钉钉开放平台调用错误;"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“按原始问题、requestId/traceId、错误码或错误描述排查钉钉开放平台调用错误;”"
],
"examples": [
"dws devdoc error diagnose --query <query>"
],
"interface_mode": "mcp",
"availability": "available"
},
"devdoc.search_open_platform_docs": {
"use_when": [
"根据关键词搜索钉钉开放平台的开发文档,返回匹配的文档条目列表,包含标题、摘要、文档链接和相关标签。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“根据关键词搜索钉钉开放平台的开发文档,返回匹配的文档条目列表,包含标题、摘要、文档链接和相关标签。”"
],
"examples": [
"dws devdoc article legacy-search-open-platform <keyword> --keyword <keyword>"
],
"interface_mode": "mcp",
"availability": "available"
},
"devdoc.search_open_platform_docs_rag": {
"use_when": [
"命中结果多时翻页",
"开发文档/API 文档/接口文档",
"开发者问\"OAuth2 怎么接",
"查错误码 / 字段含义"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“按关键词搜索 open.dingtalk.com 开放平台文档”"
],
"examples": [
"dws devdoc article search --query \"OAuth2 接入\"",
"dws devdoc article search --query \"消息卡片\" --page 2 --size 5"
],
"interface_mode": "mcp",
"availability": "available"
},
"ding.recall_ding_message": {
"use_when": [
"撤回 DING",
"撤回DING;撤回 DING 消息",
"机器人身份: 撤回"
],
"avoid_when": [
"以我的名义撤回DING/个人撤回DING;以用户身份撤回 DING"
],
"examples": [
"dws ding message recall --robot-code <ROBOT_CODE> --id <OPEN_DING_ID>",
"dws ding message recall --robot-code <ROBOT_CODE> --id <OPEN_DING_ID> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"ding.send_ding_message": {
"use_when": [
"DING 一下/紧急通知/电话提醒",
"发DING/DING通知;发送 DING 消息",
"机器人身份: 应用内 DING (免费)",
"机器人身份: 电话 DING (紧急, 有成本!)"
],
"avoid_when": [
"以我的名义发DING/个人发DING/用户身份DING;以用户身份发 DING"
],
"examples": [
"dws ding message send --robot-code <ROBOT_CODE> --users <USER_ID_1>,<USER_ID_2> --content \"请查看\"",
"dws ding message send --robot-code <ROBOT_CODE> --type app --users userId1,userId2 --content \"请查看\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.add_permission": {
"use_when": [
"给单人开 READER 权限",
"给多人开 EDITOR 权限(最多 30 个 uid)",
"给某人开权限/分享给某人/授权某文档/把这篇文档给 xxx 看;> - \"把某篇文档授权给某人",
"给某人开权限/分享给某人/授权某文档/把这篇文档给 xxx 看;新增权限",
"设为管理者",
"通过 alidocs URL 直接授权"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“为知识库下的节点(文档、文件夹、文件)添加指定角色的企业用户成员(仅支持 USER 类型)。”所述变更时不要使用"
],
"examples": [
"dws doc permission add --node <DOC_ID> --users uid1 --role READER",
"dws doc permission add --node <DOC_ID> --users uid1,uid2 --role EDITOR"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.copy_document": {
"use_when": [
"复制到指定文件夹(异步)",
"复制到目标知识库根目录",
"复制到目标知识库根目录(不传 --folder 时)",
"复制文档/拷贝一份/复制到;复制",
"复制文档到指定文件夹(--node 支持 ID 或 URL)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“将指定节点复制到目标文件夹。”所述变更时不要使用"
],
"examples": [
"dws doc copy --node <DOC_ID> --folder <TARGET_FOLDER_ID>",
"dws doc copy --node <DOC_ID> --workspace <TARGET_WS_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.create_comment": {
"use_when": [
"2. 在文档上创建评论",
"再将 userId 传入 --mention",
"创建全文评论",
"提取 userId 后:"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建文档评论”所述变更时不要使用"
],
"examples": [
"dws doc comment create --node <DOC_ID> --content \"这里需要修改\"",
"dws doc comment create --node <DOC_ID> --content \"请review\" --mention uid1,uid2"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.create_document": {
"use_when": [
"1. 创建空文档拿 nodeId",
"2. 一步创建+写入:",
"2. 创建文档 — 提取 nodeId",
"5. 完整流程: 创建文档 → 写入内容 → 插入附件",
"JSONML 创建到指定文件夹",
"写文档/创建文档;新建文字文档(adoc)",
"创建到指定文件夹",
"创建到知识库",
"创建空文档(仅取 nodeId 后再分步写入,适合 >200KB 兜底)",
"完整流程:创建文档 → 写入内容 → 插入附件",
"查看具体命令的完整参数说明",
"短纯文本字面量(< 2KB 且无换行/表格才允许)",
"详见 doc-create-workflow.md §JSONML 起稿判定",
"默认创建到「我的文档」根目录(推荐文件路径)"
],
"avoid_when": [
"在知识库里创建一个文档;创建空文件实体"
],
"examples": [
"dws doc create --help",
"dws doc create --name \"项目周报\""
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.create_file": {
"use_when": [
"创建文件(文档/表格/脑图/白板/多维表/文件夹等)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建文件(文档/表格/脑图/白板/多维表/文件夹等)”所述变更时不要使用"
],
"examples": [
"dws doc file create --name \"项目周报\" --type adoc",
"dws doc file create --name \"数据统计\" --type axls --folder FOLDER_ID"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.create_folder": {
"use_when": [
"在「我的文档」根目录创建",
"在指定父文件夹下创建",
"在知识库下创建"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建文件夹”所述变更时不要使用"
],
"examples": [
"dws doc folder create --name \"项目资料\"",
"dws doc folder create --name \"子文件夹\" --folder <PARENT_DOC_FOLDER_NODE_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.create_inline_comment": {
"use_when": [
"7. 创建划词评论并附带引用原文 + @ 相关人",
"划词评论 + 引用原文 + @人",
"确定选中文本在块内的起始偏移量 (start) 和结束偏移量 (end)",
"计算偏移后:"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在钉钉文档中创建划词评论,评论关联文档内指定块的文本范围,支持 @提及用户。”所述变更时不要使用"
],
"examples": [
"dws doc comment create-inline --node <DOC_ID> --block-id <BLOCK_ID> --start 0 --end 10 --content \"这里需要修改\"",
"dws doc comment create-inline --node <DOC_ID> --block-id <BLOCK_ID> --start 5 --end 20 --content \"建议调整\" --selected-text \"被选中的原文\""
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.delete_document": {
"use_when": [
"── delete(用户确认后才加 --yes)──",
"删除文档/删掉这个文件/移到回收站/丢掉这篇文档;删除节点",
"正确流程:1.向用户展示\"即将删除「文档名」到回收站\" → 2.等用户确认 → 3.执行下面命令"
],
"avoid_when": [
"用户未明确要求“将指定节点移入回收站,30 天内可从回收站恢复,超过 30 天将被永久删除。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws doc delete --node <DOC_ID> --format json # 查询 nodeId: dws drive search --query \"...\" 或 dws drive list"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.delete_document_block": {
"use_when": [
"5. 删除块",
"删除(无需 format 区分)",
"删除(用户确认后)",
"编辑块/改段落/插入标题/删除块;删除"
],
"avoid_when": [
"用户未明确要求“删除块元素(不可逆)”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws doc block delete --block-id <block-id> --node <node>"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.download_doc_attachment": {
"use_when": [
"下载文件/导出文件/下载到本地;下载",
"下载文档中的附件(resourceId 从 block list 获取)",
"下载附件/获取附件/取出文档里的附件;下载附件"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取钉钉文档中指定附件的临时下载 URL。”"
],
"examples": [
"dws doc media download --node <DOC_ID> --resource-id <RESOURCE_ID>",
"dws doc media download --node \"https://alidocs.dingtalk.com/i/nodes/xxx\" --resource-id <RESOURCE_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.download_file": {
"use_when": [
"指定文件路径",
"自动推断文件名,下到目录"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取文件下载凭证,供 AI Agent 自行发起 HTTP GET 请求下载文件内容。”"
],
"examples": [
"dws doc download --node <NODE_ID>",
"dws doc download --node <NODE_ID> --output ./report.pdf"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.get_document_content": {
"use_when": [
"1. 读出完整 JSONML 结构(输出含 revision,普通改写场景下不需要)",
"4. 读取文档内容 (Markdown 格式)",
"JSONML 完整结构 → 文件(无损改写前置)",
"alidocs URL 直传",
"查看具体命令的完整参数说明",
"看文档/读内容/文档内容;读取",
"给某人开权限/分享给某人/授权某文档/把这篇文档给 xxx 看;\"帮我看看这个文档",
"给某人开权限/分享给某人/授权某文档/把这篇文档给 xxx 看;默认",
"编辑块/改段落/插入标题/删除块;\"帮我看看这个文档",
"编辑块/改段落/插入标题/删除块;默认",
"默认 Markdown 输出(最常用)"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“读取文档内容(Markdown)”"
],
"examples": [
"dws doc read --help",
"dws doc read --node <DOC_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.get_document_info": {
"use_when": [
"3. 获取文档元信息 (标题、类型、权限)",
"alidocs URL 直传(CLI 自动解析)",
"document/edit URL 直传(必须完整 URL,禁止单独提取 dentryKey)",
"document/preview URL 直传",
"❌ workspaceId(应作为 --workspace 用)",
"❌ 单独的 dentryKey(必须带完整 URL)",
"❌ 纯数字 dentryId(drive 链路)",
"标准用法(nodeId 直传)",
"步骤 1: 查询文件类型",
"看文档/读内容/文档内容;元信息",
"给某人开权限/分享给某人/授权某文档/把这篇文档给 xxx 看;\"这个文档的信息",
"编辑块/改段落/插入标题/删除块;\"这个文档的信息",
"这个 alidocs 表格链接帮我看下\"(粘贴原始 URL);先 probe 节点类型"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取文档元信息(标题/类型/创建者/权限等)”"
],
"examples": [
"dws doc info --node <DOC_ID>",
"dws doc info --node \"https://alidocs.dingtalk.com/i/nodes/<DOC_UUID>\""
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.insert_document_block": {
"use_when": [
"2. 在文档末尾插入段落",
"3. 在指定块之前插入标题",
"Callout(element JSON 次选;首选 JSONML container[subType=colorBlocks])",
"分栏(2 栏)",
"单元格内含多段落 + 代码块",
"在指定 block 之前插入",
"在某个 block 后插入",
"容器内定位插入(指定 parent + index)",
"嵌入文件预览",
"带格式文本(多个 leaf)",
"带链接(link 是与 text 并列的子节点)",
"引用块",
"待办列表(checkbox)",
"插入 JSONML 节点(同级定位)",
"插入 JSONML 节点(容器内定位)",
"插入分栏块(columns):2 栏,children 为每栏的内容",
"插入复杂块(callout / 分栏)—— element 默认按 JSON 解析",
"插入引用块(blockquote)",
"插入段落(同级定位)",
"插入行内图片(inline image):构造一个空 paragraph,在 children 中用 image elementType 指定图片 src",
"插入表格(table):2 行 3 列",
"插入附件块(attachment):resourceId 为资源ID,type 为 MIME 类型,viewType 可选 preview/summary",
"文本段落",
"无序列表项",
"有序列表项(仅第一项设 start,后续项不设,系统自动递增)",
"查看具体命令的完整参数说明",
"标题(level 1-6)",
"纯文本段落",
"编辑块/改段落/插入标题/删除块;插入",
"缩进子项(level: 1)",
"群名片",
"蓝色高亮块",
"表格(2x3)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“将一个新的块元素插入指定文档,需要提供文档ID(dentryUuid)与块元素内容(必须包含 blockType 及对应类型的属性对象)。”所述变更时不要使用"
],
"examples": [
"dws doc block insert --help",
"dws doc block insert --node <DOC_ID> --text \"这是一段文字\""
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.list_comments": {
"use_when": [
"1. 查看文档的所有评论",
"仅看未解决的划词评论",
"查看文档全部评论"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询文档评论列表”"
],
"examples": [
"dws doc comment list --node <DOC_ID>",
"dws doc comment list --node <DOC_ID> --type inline --resolve-status unresolved"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.list_document_blocks": {
"use_when": [
"1. 列出所有 block 拿到 uuid",
"1. 查看文档块结构 — 获取 blockId",
"1. 获取当前结构",
"2. 读单个 block 完整子树",
"划词评论(先 block list 取 blockId + paragraph.text,计算 start/end)",
"列出 + 取 uuid",
"列出所有 block,定位 BLOCK_ID",
"列出顶层 JSONML 节点",
"编辑块/改段落/插入标题/删除块;查看结构",
"读单个 block 完整子树",
"读取指定 uuid 的完整子树"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询文档一级块元素列表”"
],
"examples": [
"dws doc block list --node <DOC_ID>",
"dws doc block list --node <DOC_ID> --start-index 0 --end-index 5"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.list_nodes": {
"use_when": [
"遍历文件夹或知识库下的直接子节点"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“遍历文件夹或知识库下的直接子节点”"
],
"examples": [
"dws doc list",
"dws doc list --folder FOLDER_ID"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.list_permission": {
"use_when": [
"拉取更多结果(默认 50,最大 200)",
"按角色过滤查看",
"查看谁有权限",
"给某人开权限/分享给某人/授权某文档/把这篇文档给 xxx 看;查看谁有权限"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询知识库节点当前的成员权限列表。”"
],
"examples": [
"dws doc permission list --node <DOC_ID>",
"dws doc permission list --node <DOC_ID> --limit 50"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.media_insert": {
"use_when": [
"1. 基本用法: 插入本地文件到文档",
"2. 指定附件显示名称",
"3. 指定 MIME 类型 (文件扩展名无法推断时)",
"4. 在指定块之前插入附件",
"上传本地文件并作为附件插入文档(3 步合一:prepare + PUT + insert)",
"在指定块之前插入附件",
"基本用法:插入本地文件到文档",
"指定 MIME 类型(扩展名无法推断时)",
"指定附件显示名称",
"提取 nodeId 后:",
"插入图片/加图片/放张图/嵌入图片/往文档里插图;插入图片",
"插入附件/上传附件到文档/往文档里加文件/加附件;插入附件"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“上传本地文件并作为附件插入文档(3 步合一:prepare + PUT + insert)”所述变更时不要使用"
],
"examples": [
"dws doc media insert --node <DOC_ID> --file ./report.pdf",
"dws doc media insert --node <DOC_ID> --file ./data.bin --name \"数据文件.dat\" --mime-type application/octet-stream"
],
"interface_mode": "composite",
"availability": "available",
"interface_reason": "命令包含多个 RPC、条件分派或本地 HTTP/文件步骤,不能绑定为单一 interface_ref"
},
"doc.move_document": {
"use_when": [
"移动到指定文件夹",
"移动到目标知识库根目录(不传 --folder 时)",
"移动到知识库根目录",
"移动文档/搬到/移到/转移文件;移动",
"移动文档到指定文件夹"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“将指定节点移动到目标文件夹。”所述变更时不要使用"
],
"examples": [
"dws doc move --node <DOC_ID> --folder <TARGET_FOLDER_ID>",
"dws doc move --node <DOC_ID> --workspace <TARGET_WS_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.query_export_job": {
"use_when": [
"兜底:超时或中断后手动查任务"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“用于查询通过 submit_export_job 提交的文字文档导出任务的执行状态,任务完成时返回文件下载链接。”"
],
"examples": [
"dws doc export get --job-id <JOB_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.remove_permission": {
"use_when": [
"从知识库节点移除指定企业用户的权限(仅支持 USER 类型)。"
],
"avoid_when": [
"用户未明确要求“从知识库节点移除指定企业用户的权限(仅支持 USER 类型)。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws doc permission remove --node <node> --users <users>"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.rename_document": {
"use_when": [
"── rename ──",
"给某人开权限/分享给某人/授权某文档/把这篇文档给 xxx 看;\"把这个文档标题改成 X\" / \"这个文档改名为 X",
"重命名/rename/改名/改文档名/修改文档名称/修改文档标题/把这个文档叫做...;重命名",
"重命名文档"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“对指定节点进行重命名。”所述变更时不要使用"
],
"examples": [
"dws doc rename --node <DOC_ID> --name \"新名称\"",
"dws doc rename --node \"https://alidocs.dingtalk.com/i/nodes/<DOC_UUID>\" --name \"项目周报 v2\""
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.reply_comment": {
"use_when": [
"4. 回复某条评论(commentKey 从 list 或 create 返回中获取)",
"5. 用表情回复评论",
"文字回复",
"表情回复(--content 填表情名称)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“回复文档评论”所述变更时不要使用"
],
"examples": [
"dws doc comment reply --node <DOC_ID> --comment-key <COMMENT_KEY> --content \"同意\"",
"dws doc comment reply --node <DOC_ID> --comment-key <COMMENT_KEY> --content \"比心\" --emoji"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.search_documents": {
"use_when": [
"搜索文档(不传关键词返回最近访问)"
],
"avoid_when": [
"搜一下 OAuth2 接入文档;搜索开发文档",
"搜一下智能化方案/最近 OKR 相关邮件/最近发版相关消息;搜企业知识内容"
],
"examples": [
"dws doc search --query \"会议纪要\"",
"dws doc search"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.update_document": {
"use_when": [
"2. 一步写入:",
"2. 逐个追加:",
"3. 写入内容 (追加模式)",
"3. 逐个追加:",
"4. 提交修改(默认直接覆盖,不做并发检查)",
"JSONML 整篇无损 overwrite(默认不做并发检查;并发敏感时加 --revision <N>)",
"append 到指定 block 前(index 通过 doc block list 获取)",
"append 末尾追加",
"heredoc(真实换行,含表格)",
"overwrite 整段(用户已确认)",
"stdin(heredoc,含表格)",
"写文档/创建文档;整篇覆盖替换",
"写文档/创建文档;追加内容",
"插入分割线:使用 doc update --mode append 以 Markdown 格式追加",
"短文本字面量(<2KB 无换行)",
"给某人开权限/分享给某人/授权某文档/把这篇文档给 xxx 看;\"往这个文档追加内容",
"编辑块/改段落/插入标题/删除块;\"往这个文档追加内容"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新文档内容(追加 / 覆盖)”所述变更时不要使用"
],
"examples": [
"dws doc update --node <DOC_ID> --content \"# 追加内容\" --mode append",
"dws doc update --node <DOC_ID> --content \"# 完整替换\" --mode overwrite"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.update_document_block": {
"use_when": [
"2. 修改后写回(uuid 不变)",
"3. 改完后写回(uuid 必须 == --block-id)",
"4. 更新某个块的内容",
"修改某块文本",
"修改标题",
"改一个 block 的文本",
"整体替换(update 时 uuid 必须等于 --block-id)",
"整体替换(update 的 uuid 必须等于 --block-id)",
"更新已有标题",
"给某人开权限/分享给某人/授权某文档/把这篇文档给 xxx 看;\"把正文里的一级标题/章节标题改成 X",
"编辑块/改段落/插入标题/删除块;\"编辑这个文档的标题",
"编辑块/改段落/插入标题/删除块;修改"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新指定文档的指定块元素内容或样式,需要提供文档ID(dentryUuid)、块元素ID(blockId)与块元素内容(必须包含 blockType 及对应类型的属性对象)。”所述变更时不要使用"
],
"examples": [
"dws doc block update --node <DOC_ID> --block-id <BLOCK_ID> --text \"新内容\"",
"dws doc block update --node <DOC_ID> --block-id <BLOCK_ID> --element '{\"blockType\":\"heading\",\"heading\":{\"text\":\"新标题\",\"level\":1}}'"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.update_permission": {
"use_when": [
"修改某人角色(READER → EDITOR)",
"给某人开权限/分享给某人/授权某文档/把这篇文档给 xxx 看;修改权限"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“修改企业用户在知识库节点上的角色(仅支持 USER 类型)。”所述变更时不要使用"
],
"examples": [
"dws doc permission update --node <DOC_ID> --users uid1 --role EDITOR",
"dws doc permission update --node <DOC_ID> --users uid1,uid2 --role READER"
],
"interface_mode": "mcp",
"availability": "available"
},
"doc.upload": {
"use_when": [
"1. 上传到\"我的文档\"根目录",
"2. 上传到指定文件夹",
"3. 上传到知识库并转换为在线文档",
"上传到「我的文档」根目录",
"上传到指定文件夹",
"上传到知识库并转换为在线文档",
"上传文件/传文件/上传到文档/上传到知识库;上传",
"上传文件/传文件/上传到文档/上传到知识库;上传并转换",
"上传文件到钉钉文档或知识库"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“上传文件到钉钉文档或知识库”所述变更时不要使用"
],
"examples": [
"dws doc upload --file ./report.pdf",
"dws doc upload --file ./slides.pptx --name \"Q1汇报.pptx\" --folder <FOLDER_ID>"
],
"interface_mode": "composite",
"availability": "available",
"interface_reason": "命令包含多个 RPC、条件分派或本地 HTTP/文件步骤,不能绑定为单一 interface_ref"
},
"drive.add_permission": {
"use_when": [
"给文档授权/分享权限"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“为知识库下的节点(文档、文件夹、文件)添加指定角色的企业用户成员(仅支持 USER 类型)。”所述变更时不要使用"
],
"examples": [
"dws drive permission add --node <ID> --users uid1,uid2 --role READER"
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.commit_upload": {
"use_when": [
"提交文件上传"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“提交文件上传”所述变更时不要使用"
],
"examples": [
"dws drive commit --file-name \"report.pdf\" --file-size 102400 --upload-id <UPLOAD_ID>",
"dws drive commit --file-name \"报告.pdf\" --file-size 102400 --upload-id <uploadId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.copy_document": {
"use_when": [
"── 场景 A: 复制钉盘文件到知识库空间根目录 ──",
"── 场景 C: 复制钉盘文件到钉盘 space 下的子文件夹 ──",
"── 场景默认: 用户未指定目标位置 → 复制/移动到「我的文件」根目录 ──",
"复制文件/移动文件/搬到/移到"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“将指定节点复制到目标文件夹。”所述变更时不要使用"
],
"examples": [
"dws drive copy --node <ID> [--folder <TARGET>] [--workspace <WS>]",
"dws drive copy --node <源文件dentryUuid> --folder <我的文件rootFolderId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.create_folder": {
"use_when": [
"5. 创建文件夹",
"新建文件夹/创建目录"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建文件夹”所述变更时不要使用"
],
"examples": [
"dws drive mkdir --name \"项目资料\"",
"dws drive mkdir --name \"子目录\" --folder <dentryUuid>"
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.delete_document": {
"use_when": [
"删除文件/删除文件夹/移到回收站",
"正确流程:1.向用户展示\"即将删除「文件名」到回收站\" → 2.等用户确认 → 3.执行下面命令"
],
"avoid_when": [
"用户未明确要求“将指定节点移入回收站,30 天内可从回收站恢复,超过 30 天将被永久删除。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws drive delete --node <dentryUuid> --format json # 查询 fileId: dws drive list"
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.download_file": {
"use_when": [
"4. 下载文件到本地",
"下载文件",
"查看具体命令的完整参数说明",
"读一下这个 xlsx 的数据\" / xlsx 节点链接;下载本地表格文件"
],
"avoid_when": [
"把这个在线表格导出为 xlsx 文件;在线表格格式转换"
],
"examples": [
"dws drive download --help",
"dws drive download --node <dentryUuid> --output ./report.pdf"
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.get_file_info": {
"use_when": [
"3. 查看文件元数据",
"文件详情/文件信息"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取文件元数据信息”"
],
"examples": [
"dws drive info --node <dentryUuid>",
"dws drive info --node <dentryUuid> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.get_upload_info": {
"use_when": [
"获取文件上传信息"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取文件上传信息”"
],
"examples": [
"dws drive upload-info --file-name \"report.pdf\" --file-size 102400",
"dws drive upload-info --file-name \"slides.pptx\" --file-size 512000 --folder <dentryUuid>"
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.list_files": {
"use_when": [
"1. 浏览「我的文件」根目录",
"2. 进入子目录 — 提取 dentryUuid 作为 folder",
"── 场景 C: 复制钉盘文件到钉盘 space 下的子文件夹 ──",
"── 场景默认: 用户未指定目标位置 → 复制/移动到「我的文件」根目录 ──",
"我的文件/钉盘/网盘/云盘",
"查看具体命令的完整参数说明"
],
"avoid_when": [
"帮我看看知识库里的文件;知识库节点列表"
],
"examples": [
"dws drive list --help",
"dws drive list --limit 20"
],
"interface_mode": "composite",
"availability": "available",
"interface_ref": null,
"interface_reason": "The CLI command routes by --workspace between drive/list_files and doc/list_nodes, so the reviewed executable wrapper has no single direct MCP interface."
},
"drive.list_permission": {
"use_when": [
"查询知识库节点当前的成员权限列表。"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询知识库节点当前的成员权限列表。”"
],
"examples": [
"dws drive permission list --node <ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.list_spaces": {
"use_when": [
"获取当前用户可访问的空间列表。"
],
"avoid_when": [
"列出钉盘团队空间;列出钉盘空间"
],
"examples": [
"dws drive list-spaces # deprecated",
"dws drive list-spaces --space-type orgSpace --limit 20 --cursor <TOKEN>"
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.move_document": {
"use_when": [
"── 场景 B: 移动钉盘文件到另一个钉盘 space 根目录 ──"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“将指定节点移动到目标文件夹。”所述变更时不要使用"
],
"examples": [
"dws drive move --node <ID> [--folder <TARGET>] [--workspace <WS>]",
"dws drive move --node <源文件dentryUuid> --folder <目标space的rootFolderId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.permission_remove": {
"use_when": [
"从知识库节点移除指定企业用户的权限(仅支持 USER 类型)。"
],
"avoid_when": [
"用户未明确要求“从知识库节点移除指定企业用户的权限(仅支持 USER 类型)。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws drive permission remove --node <ID> --users uid1"
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.permission_update": {
"use_when": [
"修改企业用户在知识库节点上的角色(仅支持 USER 类型)。"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“修改企业用户在知识库节点上的角色(仅支持 USER 类型)。”所述变更时不要使用"
],
"examples": [
"dws drive permission update --node <ID> --users uid1 --role EDITOR"
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.rename_document": {
"use_when": [
"重命名/改名"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“对指定节点进行重命名。”所述变更时不要使用"
],
"examples": [
"dws drive rename --node <ID> --name \"新名称\""
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.search_files": {
"use_when": [
"搜一下有没有叫XX的文件;全局搜索",
"搜索钉盘文件/钉盘里找个文件/查找某个钉盘文件/钉盘中搜索",
"查看具体命令的完整参数说明",
"钉盘/网盘/我的文件里搜"
],
"avoid_when": [
"在知识库里搜方案;空间内搜索"
],
"examples": [
"dws drive search --help",
"dws drive search --query \"季度汇报\""
],
"interface_mode": "mcp",
"availability": "available"
},
"drive.upload": {
"use_when": [
"6. 上传文件(首选 upload 命令,自动完成三步流程)",
"上传文件\"(未指定目标);默认钉盘",
"上传文件/传文件到钉盘",
"上传文件到钉盘/我的文件;钉盘上传",
"上传本地文件到钉盘",
"帮我把这个文件传到网盘;钉盘上传",
"查看具体命令的完整参数说明"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“上传本地文件到钉盘”所述变更时不要使用"
],
"examples": [
"dws drive upload --help",
"dws drive upload --file ./report.pdf"
],
"interface_mode": "composite",
"availability": "available",
"interface_reason": "命令包含多个 RPC、条件分派或本地 HTTP/文件步骤,不能绑定为单一 interface_ref"
},
"event.consume": {
"agent_summary": "订阅并持续消费指定个人事件,将事件流输出给 Agent 或本地管道。",
"use_when": [
"需要实时接收一个已知个人事件码的后续事件时"
],
"avoid_when": [
"只需查看事件目录或 payload 字段时分别使用 event list 或 event schema;只查历史聊天记录时使用 chat 查询命令"
],
"examples": [
"dws event consume user_im_message_receive_at --max-events 1 --format ndjson"
],
"effect": "write",
"risk": "medium",
"confirmation": "not_required",
"idempotency": "non_idempotent",
"reviewed": true
},
"event.list": {
"agent_summary": "列出当前支持的个人事件目录及其规则、状态和说明。",
"use_when": [
"尚不知道可用 event_key,或需要盘点当前个人事件目录时"
],
"avoid_when": [
"需要查看某个事件的 payload 字段时使用 event schema;需要开始监听事件时使用 event consume"
],
"examples": [
"dws event list --format json"
],
"effect": "read",
"risk": "low",
"confirmation": "not_required",
"idempotency": "idempotent",
"reviewed": true,
"interface_mode": "local",
"availability": "available",
"interface_reason": "命令读取 CLI 内置的个人事件目录,不绑定 pinned MCP RPC"
},
"event.schema": {
"agent_summary": "查询指定个人事件码的 payload 字段 Schema。",
"use_when": [
"已知 event_key,需要在消费前理解事件 payload 字段结构时"
],
"avoid_when": [
"需要查询 CLI 命令参数契约时使用顶层 dws schema;需要实际接收事件时使用 event consume"
],
"examples": [
"dws event schema user_im_message_receive_at --format json"
],
"effect": "read",
"risk": "low",
"confirmation": "not_required",
"idempotency": "idempotent",
"reviewed": true,
"interface_mode": "local",
"availability": "available",
"interface_reason": "命令读取 CLI 内置的个人事件 payload 定义,不绑定 pinned MCP RPC"
},
"event.status": {
"agent_summary": "查看个人事件订阅、本地 event bus 和消费进程状态。",
"use_when": [
"需要检查个人事件订阅是否活跃、bus 是否运行或 consume 进程是否仍在消费时"
],
"avoid_when": [
"需要列出支持的事件类型时使用 event list;需要取消订阅时使用 event stop"
],
"examples": [
"dws event status --format json"
],
"effect": "read",
"risk": "low",
"confirmation": "not_required",
"idempotency": "idempotent",
"reviewed": true
},
"event.stop": {
"agent_summary": "取消个人事件订阅并停止对应本地消费。",
"use_when": [
"用户明确要求取消一个已知个人事件订阅并停止对应消费时"
],
"avoid_when": [
"只需检查运行状态时使用 event status;目标订阅不明确或用户尚未确认取消订阅时不要使用"
],
"examples": [
"dws event stop SUBSCRIBE_ID"
],
"effect": "destructive",
"risk": "high",
"confirmation": "user_required",
"idempotency": "unknown",
"reviewed": true
},
"live.get_my_lives": {
"use_when": [
"查看我的直播列表"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查看我的直播列表”"
],
"examples": [
"dws live stream list"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.batch_delete_message": {
"use_when": [
"批量删除邮件"
],
"avoid_when": [
"用户未明确要求“批量删除邮件”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws mail message batch-delete --email user@company.com --ids <id1>,<id2>"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.batch_delete_user_mail_contacts": {
"use_when": [
"批量删除用户邮箱联系人"
],
"avoid_when": [
"用户未明确要求“批量删除用户邮箱联系人”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws mail contact batch-delete --email user@company.com --contact-ids <id1>,<id2>"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.batch_move_message": {
"use_when": [
"批量移动邮件到指定文件夹"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“批量移动邮件到指定文件夹”所述变更时不要使用"
],
"examples": [
"dws mail message batch-move --email user@company.com --ids <id1>,<id2> --folder 6"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.create_download_session": {
"use_when": [
"下载到指定目录",
"再下载指定附件到当前目录(每次只能下载一个附件)",
"步骤 5.3:对每个附件逐个下载(没有批量下载命令,必须循环调用)"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“下载邮件附件”"
],
"examples": [
"dws mail attachment download --email user@company.com --message-id <messageId> --attachment-id <attachmentId> --name report.pdf",
"dws mail attachment download --email user@company.com --message-id <messageId> --attachment-id <attachmentId> --name img.png --output /tmp"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.create_draft": {
"use_when": [
"创建邮件草稿"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建邮件草稿”所述变更时不要使用"
],
"examples": [
"dws mail draft create --from user@company.com --to colleague@company.com --subject \"草稿标题\" --content \"草稿正文\"",
"dws mail draft create --from user@company.com --subject \"草稿标题\""
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.create_forward_draft": {
"use_when": [
"创建转发草稿"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建转发草稿”所述变更时不要使用"
],
"examples": [
"dws mail message forward --from user@company.com --id <messageId>",
"dws mail message forward --from user@company.com --to colleague@company.com --id <messageId> --subject \"Fwd: 周报\""
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.create_mail_folder": {
"use_when": [
"1b. 创建顶层邮件文件夹",
"1c. 创建子文件夹 — 先通过 folder list 获取父文件夹 id,再传给 --folder",
"创建邮件文件夹/新建邮箱文件夹/新建邮件目录"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建邮件文件夹”所述变更时不要使用"
],
"examples": [
"dws mail folder create --email user@company.com --name \"项目资料\"",
"dws mail folder create --email user@company.com --name \"子文件夹\" --folder <folderId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.create_reply_draft": {
"use_when": [
"创建回复草稿"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建回复草稿”所述变更时不要使用"
],
"examples": [
"dws mail message reply --from user@company.com --id <messageId>",
"dws mail message reply --from user@company.com --id <messageId> --subject \"Re: 周报\" --content \"已收到,谢谢!\""
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.create_replyall_draft": {
"use_when": [
"创建回复全部草稿"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建回复全部草稿”所述变更时不要使用"
],
"examples": [
"dws mail message reply-all --from user@company.com --id <messageId>",
"dws mail message reply-all --from user@company.com --id <messageId> --subject \"Re: 周报\" --content \"感谢大家的参与!\""
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.create_user_mail_contact": {
"use_when": [
"创建用户邮箱联系人"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建用户邮箱联系人”所述变更时不要使用"
],
"examples": [
"dws mail contact create --email user@company.com --contact-email colleague@company.com --display-name \"张三\"",
"dws mail contact create --email user@company.com --contact-email colleague@company.com --first-name \"三\" --last-name \"张\""
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.create_user_message_template": {
"use_when": [
"创建个人邮件模板"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建个人邮件模板”所述变更时不要使用"
],
"examples": [
"dws mail template create --email user@company.com --name \"周报模板\" --subject \"周报\" --content \"本周工作总结...\"",
"dws mail template create --email user@company.com --from user@company.com --name \"通知模板\" --subject \"通知\" --content \"...\" --to a@x.com,b@x.com --cc c@x.com"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.delete_mail_folder": {
"use_when": [
"1d. 更新或删除邮件文件夹 — 先通过 folder list 获取目标文件夹 id,再传给 --id"
],
"avoid_when": [
"用户未明确要求“删除邮件文件夹”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws mail folder delete --email user@company.com --id <folderId>",
"dws mail folder delete --email user@company.com --id <folderId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.delete_user_message_template": {
"use_when": [
"删除用户邮件模板"
],
"avoid_when": [
"用户未明确要求“删除用户邮件模板”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws mail template delete --email user@company.com --id <templateId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.get_email_by_message_id": {
"use_when": [
"3. 查看邮件详情"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查看邮件完整内容”"
],
"examples": [
"dws mail message get --email user@company.com --id <messageId>",
"dws mail message get --email user@company.com --id <messageId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.get_thread": {
"use_when": [
"步骤 5.2:用 conversationId 获取会话详情",
"步骤 5.3(可选):同时返回会话内所有邮件列表"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取会话详情”"
],
"examples": [
"dws mail thread get --email user@company.com --id <conversationId>",
"dws mail thread get --email user@company.com --id <conversationId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.get_user_message_template": {
"use_when": [
"获取用户邮件模板详情"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取用户邮件模板详情”"
],
"examples": [
"dws mail template get --email user@company.com --id <templateId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.list_folders": {
"use_when": [
"1c. 创建子文件夹 — 先通过 folder list 获取父文件夹 id,再传给 --folder",
"1d. 更新或删除邮件文件夹 — 先通过 folder list 获取目标文件夹 id,再传给 --id",
"1h. 列出文件夹中的邮件会话 — 先通过 folder list 获取文件夹 id,再传给 --folder",
"列出邮件会话/查看会话列表/查看某个文件夹里的邮件会话",
"删除邮件文件夹/删除邮箱文件夹/删除邮件目录",
"在某个邮件文件夹下创建子文件夹",
"重命名邮件文件夹/修改邮箱文件夹名称/更新邮件目录名称"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列举邮件文件夹”"
],
"examples": [
"dws mail folder list --email user@company.com",
"dws mail folder list --email user@company.com --folder <folderId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.list_mail_attachments": {
"use_when": [
"先列出附件获取 id 和 name",
"(对搜索结果中的每封邮件都要执行一次)"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列举邮件附件”"
],
"examples": [
"dws mail attachment list --email user@company.com --id <messageId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.list_tags": {
"use_when": [
"1f. 创建子标签 — 先通过 tag list 获取父标签 id,再传给 --parent-id",
"1g. 更新或删除邮件标签 — 先通过 tag list 获取目标标签 id,再传给 --id",
"删除邮件标签/删除邮箱标签/删除 label",
"在某个邮件标签下创建子标签",
"查看邮件标签/列出邮箱标签/查看邮箱 label",
"重命名邮件标签/修改邮箱标签名称/更新 label 名称"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列举邮件标签”"
],
"examples": [
"dws mail tag list --email user@company.com",
"dws mail tag list --email user@company.com --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.list_user_mail_contacts": {
"use_when": [
"列出用户邮箱联系人"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列出用户邮箱联系人”"
],
"examples": [
"dws mail contact list --email user@company.com --limit 20",
"dws mail contact list --email user@company.com --limit 20 --cursor <nextCursor>"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.list_user_mailboxes": {
"use_when": [
"1. 查看可用邮箱 — 提取邮箱地址",
"发带附件的邮件/发邮件附件",
"发邮件/写邮件",
"我的邮箱/邮箱地址",
"获取/查找/得到 某人的邮箱地址"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询可用邮箱地址”"
],
"examples": [
"dws mail mailbox list",
"dws mail mailbox list --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.list_user_message_templates": {
"use_when": [
"列出用户邮件模板"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列出用户邮件模板”"
],
"examples": [
"dws mail template list --email user@company.com --limit 20",
"dws mail template list --email user@company.com --limit 20 --cursor <nextCursor>"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.list_emails": {
"agent_summary": "列出收件箱或指定文件夹中的邮件,无需编写 KQL 查询",
"use_when": [
"列出收件箱、已发送、草稿、垃圾邮件或其他指定文件夹中的邮件"
],
"avoid_when": [
"需要按主题、发件人、日期或附件等条件组合搜索时使用 mail message search"
],
"examples": [
"dws mail message list --email user@company.com",
"dws mail message list --email user@company.com --folder-id 1 --limit 50"
],
"effect": "read",
"risk": "low",
"confirmation": "not_required",
"idempotency": "idempotent",
"reviewed": true,
"interface_mode": "composite",
"availability": "available",
"interface_reason": "CLI wrapper converts the reviewed folder selection into a KQL query and maps pagination before calling the pinned search_emails RPC; the local transform plus RPC call is not a one-to-one interface contract"
},
"mail.search_emails": {
"use_when": [
"2. 搜索邮件 — 提取 messageId",
"下载附件/保存附件/把附件存到本地/把所有附件下载到...",
"发送草稿/把草稿发出去/发这封草稿",
"取返回中的 nextCursor,传入下一次请求(nextCursor=\"$\" 时停止)",
"找邮件/搜邮件/查邮件",
"把XX邮件的所有附件都下载",
"查看会话/获取会话/看这封邮件的会话",
"查看附件/邮件附件/有什么附件",
"步骤 5.1:先通过 message search 或 message get 获取邮件中的 conversationId",
"看邮件/打开邮件/邮件内容",
"示例:下载4月所有发票邮件的附件",
"第一页"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“搜索邮件 (KQL 语法)”"
],
"examples": [
"dws mail message search --email <email> --query <query>"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.search_mail_users": {
"use_when": [
"搜索/查找/联系 邮箱用户/联系人/某人的邮箱地址",
"翻页继续搜索联系人/通讯录",
"路径 2:mail user search(仅企业邮箱可用,个人邮箱会报权限错误可忽略)"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“搜索账号”"
],
"examples": [
"dws mail user search --email <当前邮箱> --keyword \"姓名\" --format json",
"dws mail user search --keyword \"张三\""
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.send_draft": {
"use_when": [
"发送草稿箱中的邮件"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“发送草稿箱中的邮件”所述变更时不要使用"
],
"examples": [
"dws mail draft send --from user@company.com --id <messageId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.send_email": {
"use_when": [
"4. 发送邮件(纯文本)",
"4b. 发送带附件的邮件(自动编排:创建草稿→上传附件→发送草稿)",
"4c. 发送带内联图片的邮件(正文自动转 HTML,<img> 标签自动注入)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“发送邮件”所述变更时不要使用"
],
"examples": [
"dws mail message send --from user@company.com --to colleague@company.com --subject \"周报\" --content \"本周完成任务A和任务B\"",
"dws mail message send --from user@company.com --to colleague@company.com --subject \"周报\" --content \"见附件\" --attachment ./report.pdf"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.update_draft": {
"use_when": [
"更新邮件草稿"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新邮件草稿”所述变更时不要使用"
],
"examples": [
"dws mail draft update --from user@company.com --id <messageId> --subject \"新标题\" --content \"新正文\"",
"dws mail draft update --from user@company.com --id <messageId> --content \"见附件\" --attachment ./report.pdf"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.update_mail_folder": {
"use_when": [
"1d. 更新或删除邮件文件夹 — 先通过 folder list 获取目标文件夹 id,再传给 --id"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新邮件文件夹”所述变更时不要使用"
],
"examples": [
"dws mail folder update --email user@company.com --id <folderId> --name \"新文件夹名\"",
"dws mail folder update --email user@company.com --id <folderId> --name \"新文件夹名\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.update_user_mail_contact": {
"use_when": [
"修改用户邮箱联系人信息"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“修改用户邮箱联系人信息”所述变更时不要使用"
],
"examples": [
"dws mail contact update --email user@company.com --contact-id <contactId> --display-name \"李四\"",
"dws mail contact update --email user@company.com --contact-id <contactId> --contact-email new@company.com --first-name \"四\" --last-name \"李\""
],
"interface_mode": "mcp",
"availability": "available"
},
"mail.update_user_message_template": {
"use_when": [
"更新用户邮件模板"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新用户邮件模板”所述变更时不要使用"
],
"examples": [
"dws mail template update --email user@company.com --id <templateId> --subject \"新标题\" --content \"新正文\"",
"dws mail template update --email user@company.com --id <templateId> --name \"新模板名\""
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.add_member_permission": {
"use_when": [
"加/添加/共享/分享/让...看/让...访问",
"把某人加到这个听记中/共享听记给某人/给某人添加听记权限/把听记分享给同事/让某人也能看这个听记",
"添加参会者/加参会者/批量添加参会者/添加成员/加成员/批量添加成员/加参会人/添加参会人",
"添加参会者/批量添加参会者/添加成员/批量添加成员/加参会人/加入成员"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“批量给多个听记增加成员,并且设置成员的权限。”所述变更时不要使用"
],
"examples": [
"dws minutes permission add --ids <uuid1,uuid2> --member-uids 123456,789012 --policy 3",
"dws minutes permission add --ids <uuid> --member-uids 123456 --policy 2 --cover"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.add_personal_hot_word": {
"use_when": [
"10. 添加个人热词",
"加热词/添加热词/设置热词/把某个词加到热词里/这个词总是识别错"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“添加个人热词 (优化识别专有名词 / 人名)”所述变更时不要使用"
],
"examples": [
"dws minutes hot-word add --words \"钉钉\"",
"dws minutes hot-word add --words \"OKR,钉钉,Copilot\""
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.batch_get_minutes_details": {
"use_when": [
"批量查询/查多个听记"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“批量查询听记详情 (标题 / 时长 / 参与人 / 创建时间 / 状态)”"
],
"examples": [
"dws minutes get batch --ids uuid1,uuid2,uuid3"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.cancel_upload_session": {
"use_when": [
"12d.(可选)取消上传会话",
"取消上传"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“取消文件上传会话,释放服务端资源”所述变更时不要使用"
],
"examples": [
"dws minutes upload cancel --session-id <sessionId>",
"dws minutes upload cancel --session-id <sessionId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.complete_upload_session": {
"use_when": [
"12c. 通知服务端上传完成,创建听记"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“完成文件上传并创建听记(幂等:同一 sessionId 重复调用返回已有任务)”所述变更时不要使用"
],
"examples": [
"dws minutes upload complete --session-id <sessionId>",
"dws minutes upload complete --session-id <sessionId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.create_mind_graph": {
"use_when": [
"8. 思维导图",
"生成思维导图/创建脑图/帮我添加思维导图/基于这个听记做思维导图/把会议内容做成脑图"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“触发思维导图生成任务 (完成状态走 mind-graph status 轮询)”所述变更时不要使用"
],
"examples": [
"dws minutes mind-graph create --id <taskUuid>",
"dws minutes mind-graph create --id <taskUuid> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.create_speaker_summary": {
"use_when": [
"9b. 发言人段落总结(异步:create 触发 → 延迟 5s → 轮询 get,最多 20 次)"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“触发创建发言人的段落总结任务,该任务将听记的发言人的所有撰写内容汇总总结,触发后需要继续调用查询接口去查询总结任务的结果”"
],
"examples": [
"dws minutes speaker summary create --ids <uuid1,uuid2>",
"dws minutes speaker summary create --task-uuids <uuid1,uuid2>"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.create_upload_session": {
"use_when": [
"12a. 创建上传会话,获取预签名 URL 和 sessionId",
"把文件转成听记/上传音频文件/上传录音/把这个 mp3 转成听记/帮我把会议录音转写一下/把附件里的音频文件做转写"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建文件上传会话(获取预签名 URL,供 HTTP PUT 上传)”所述变更时不要使用"
],
"examples": [
"dws minutes upload create --file-name \"meeting.mp4\" --file-size 102400",
"dws minutes upload create --file-name \"meeting.mp4\" --file-size 102400 --title \"周会录音\""
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.get_minutes_ai_summary": {
"use_when": [
"2. 获取 AI 摘要",
"修改纪要/更新纪要/编辑纪要内容/重新整理纪要/纪要格式优化/纪要精简",
"把 XX 改成 YY;用户只要整体纪要、未指定特定人物",
"摘要/总结/会议纪要/纪要"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取听记 AI 摘要 (Markdown 格式)”"
],
"examples": [
"dws minutes get summary --id <taskUuid>",
"dws minutes get summary --id <taskUuid> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.get_minutes_basic_info": {
"use_when": [
"听记详情/听记信息"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取听记基础信息 (创建人 / 起止时间 / 标题 / 访问链接)”"
],
"examples": [
"dws minutes get info --id <taskUuid>"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.get_minutes_keywords": {
"use_when": [
"关键字/关键词"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取听记关键字列表”"
],
"examples": [
"dws minutes get keywords --id <taskUuid>"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.get_minutes_transcription": {
"use_when": [
"3. 查看完整转写原文(拉完后默认按时间线返回,AI 必须主动追问\"是否按发言人聚类\")",
"原文/转写/录音文字/逐字稿"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取听记语音转写原文 (含发言人 / 时间戳)”"
],
"examples": [
"dws minutes get transcription --id <taskUuid>",
"dws minutes get transcription --id <taskUuid> --direction 1"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.get_speaker_summary": {
"use_when": [
"等待至少 5 秒..."
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询发言人的段落总结任务的结果,该任务将听记的发言人的所有撰写内容汇总总结返回,配合创建任务使用”"
],
"examples": [
"dws minutes speaker summary get --ids <uuid1,uuid2>",
"dws minutes speaker summary get --task-uuids <uuid1,uuid2>"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.list_accessible_minutes": {
"use_when": [
"查看当前用户有权限访问的全部听记",
"未限定创建来源时按关键词和时间范围搜索听记",
"我可访问的听记/我能看到的听记/所有听记/全部听记"
],
"avoid_when": [
"明确只查询自己创建的听记时使用 dws minutes list mine;明确只查询别人共享的听记时使用 dws minutes list shared;修改数据时不要使用"
],
"examples": [
"dws minutes list all --format json"
]
},
"minutes.list_by_keyword_and_time_range": {
"use_when": [
"查看我自己创建的听记列表并提取 taskUuid",
"从我创建、我发起或我自己录制的听记中按关键词和时间范围搜索"
],
"avoid_when": [
"查询别人共享的听记时使用 dws minutes list shared;覆盖全部可访问听记时使用 dws minutes list all;修改数据时不要使用"
],
"examples": [
"dws minutes list mine --format json"
]
},
"minutes.list_shared_minutes": {
"use_when": [
"查看别人共享给我的听记列表",
"在共享听记中按关键词和时间范围搜索"
],
"avoid_when": [
"查询自己创建的听记时使用 dws minutes list mine;覆盖全部可访问听记时使用 dws minutes list all;修改数据时不要使用"
],
"examples": [
"dws minutes list shared --format json"
]
},
"minutes.list_minutes_todos": {
"use_when": [
"4. 提取待办事项",
"会议待办/听记待办/待办事项",
"把 XX 改成 YY;用户想提取待办"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取听记中提取的待办事项”"
],
"examples": [
"dws minutes get todos --id <taskUuid>",
"dws minutes get todos --id <taskUuid> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.list_my_hotwords": {
"use_when": [
"看看我的热词/我加了哪些热词/热词列表/查热词"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询我的热词列表,返回个人的所有听记配置过的热词列表”"
],
"examples": [
"dws minutes hot-word list"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.query_mind_graph_status": {
"use_when": [
"8. 思维导图",
"思维导图状态/脑图进度/思维导图好了吗"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询思维导图任务状态 (0=进行中 / 1=成功 / 2=失败)”"
],
"examples": [
"dws minutes mind-graph status --id <taskUuid>",
"dws minutes mind-graph status --id <taskUuid> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.query_minutes_audio_url": {
"use_when": [
"4b. 获取音频/视频地址(用于下载或播放原始媒体文件)",
"音频地址/音频链接/录音文件/下载录音/音频下载/视频文件/媒体地址"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询听记的音频/视频地址,入参为 taskUuid 和操作人 uid,操作人需拥有该听记的\"读\"权限及以上才会返回;”"
],
"examples": [
"dws minutes get audio --id <taskUuid> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.query_minutes_by_tag_id": {
"use_when": [
"查看某个标签下的听记/这个标签下有哪些听记/按标签查听记"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“根据用户的标签或者分组信息来查询听记列表信息,用户的标签通过听记页面手动创建。”"
],
"examples": [
"dws minutes tag query --tag-id <tagId>",
"dws minutes tag query --tag-id <tagId> --limit 20"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.query_user_tag_list": {
"use_when": [
"我的听记标签/听记分组/听记有哪些标签/有哪些分组",
"按标签查/某个标签下的听记/标签筛选",
"标签列表/分组列表/有哪些标签/有哪些分组"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询我的的听记的标签或者分组列表,标签或者分组在听记页面创建。”"
],
"examples": [
"dws minutes tag list"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.record_pause": {
"use_when": [
"7. 录音控制(基于 start 返回的 taskUuid)",
"暂停一下/暂停录音",
"暂停听记录音"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“暂停听记录音”所述变更时不要使用"
],
"examples": [
"dws minutes record pause --id <taskUuid>",
"dws minutes record pause --id <taskUuid> --session-id <sessionId>"
]
},
"minutes.record_resume": {
"use_when": [
"7. 录音控制(基于 start 返回的 taskUuid)",
"恢复听记录音",
"继续/继续录音"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“恢复听记录音”所述变更时不要使用"
],
"examples": [
"dws minutes record resume --id <taskUuid>",
"dws minutes record resume --id <taskUuid> --session-id <sessionId>"
]
},
"minutes.record_start": {
"use_when": [
"0. 发起听记(开始录音)",
"发起听记 (开始录音)",
"开始听记/开始录音/发起一个听记/启动听记/开始听记录这次会议/我要开始听记了/录音开始/我要听记"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“发起听记 (开始录音)”所述变更时不要使用"
],
"examples": [
"dws minutes record start",
"dws minutes record start --session-id <sessionId>"
]
},
"minutes.record_stop": {
"use_when": [
"7. 录音控制(基于 start 返回的 taskUuid)",
"结束听记/结束录音/停止录音/结束",
"结束听记录音"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“结束听记录音”所述变更时不要使用"
],
"examples": [
"dws minutes record stop --id <taskUuid>",
"dws minutes record stop --id <taskUuid> --session-id <sessionId>"
]
},
"minutes.remove_member_permission": {
"use_when": [
"移除/取消/删除/不让...看",
"移除某人的权限/取消共享/不让某人看这个听记了"
],
"avoid_when": [
"用户未明确要求“批量移除多个听记的成员的权限。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws minutes permission remove --ids <uuid1,uuid2> --member-uids 123456,789012",
"dws minutes permission remove --ids <uuid> --member-uids 123456"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.replace_minutes_text": {
"use_when": [
"11. 查找替换听记文字",
"把所有的A替换成B/查找替换/批量替换文字"
],
"avoid_when": [
"用户未明确要求“在段落 + 纪要中全量替换文字 (区分大小写,精确匹配)”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws minutes replace-text --id <taskUuid> --search \"旧文字\" --replace \"新文字\"",
"dws minutes replace-text --id <taskUuid> --search \"发言人1\" --replace \"张三\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.replace_speaker": {
"use_when": [
"3b. 用户提供\"某某人讲了 XX\" → AI 模糊匹配关键词后,引导确认替换发言人",
"9. 替换发言人",
"把 XX 改成 YY;用户直接说\"把发言人1改成张三",
"替换发言人/修改发言人/换发言人名字/把说话人改成某某/发言人标注错了"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“批量替换听记中指定发言人”所述变更时不要使用"
],
"examples": [
"dws minutes speaker replace --id <taskUuid> --from \"张三\" --to \"李四\"",
"dws minutes speaker replace --id <taskUuid> --from \"张三\" --to \"李四\" --target-uid <uid>"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.update_minutes_summary": {
"use_when": [
"6. 更新纪要内容"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“全量覆盖纪要内容 (不触发 AI 重算)”所述变更时不要使用"
],
"examples": [
"dws minutes update summary --id <taskUuid> --content \"新的纪要内容\"",
"dws minutes update summary --id <taskUuid> --content \"新的纪要内容\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"minutes.update_minutes_title": {
"use_when": [
"5. 修改标题",
"改听记标题/重命名听记/修改标题"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“修改听记标题”所述变更时不要使用"
],
"examples": [
"dws minutes update title --id <taskUuid> --title \"Q2 复盘会议\"",
"dws minutes update title --id <taskUuid> --title \"新标题\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.approve_processInstance": {
"use_when": [
"4a. 同意审批",
"同意审批/批准"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“同意审批”所述变更时不要使用"
],
"examples": [
"dws oa approval approve --instance-id <id> --task-id <taskId>",
"dws oa approval approve --instance-id <id> --task-id <taskId> --remark \"同意\""
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.dingflow_comments": {
"use_when": [
"13. 对审批实例添加评论(processInstanceId 来自 list-pending 或 detail)",
"评论审批/添加评论/写评论"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“用户添加审批评论”所述变更时不要使用"
],
"examples": [
"dws oa approval oa-comments --instance-id <processInstanceId> --content \"同意,请尽快处理\"",
"dws oa approval oa-comments --instance-id <processInstanceId> --content \"同意,请尽快处理\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.get_done_tasks": {
"use_when": [
"9. 我处理过的审批单",
"我审批/处理过的审批单"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取员工已处理任务列表”"
],
"examples": [
"dws oa approval list-executed --limit <pageSize> --page <pageNumber> --query 关键词",
"dws oa approval list-executed --limit <pageSize> --page <pageNumber> --query 关键词 --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.get_noticed_instances": {
"use_when": [
"11. 抄送我的审批单",
"抄送我的审批单"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取抄送用户的列表”"
],
"examples": [
"dws oa approval list-cc --limit <pageSize> --page <pageNumber> --query 关键词",
"dws oa approval list-cc --limit <pageSize> --page <pageNumber> --query 关键词 --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.get_processInstance_detail": {
"use_when": [
"2. 查看审批详情 — 了解审批内容",
"审批详情/看审批"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取审批实例详情”"
],
"examples": [
"dws oa approval detail --instance-id <processInstanceId>",
"dws oa approval detail --instance-id <processInstanceId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.get_processInstance_records": {
"use_when": [
"6. 查看审批操作记录",
"审批记录/操作历史"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取审批操作记录”"
],
"examples": [
"dws oa approval records --instance-id <processInstanceId>",
"dws oa approval records --instance-id <processInstanceId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.get_submitted_instances": {
"use_when": [
"10. 我发起的审批单",
"我发起的审批单"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取已提交实例列表”"
],
"examples": [
"dws oa approval list-submitted --limit <pageSize> --page <pageNumber> --query 关键词",
"dws oa approval list-submitted --limit <pageSize> --page <pageNumber> --query 关键词 --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.list_initiated_instances": {
"use_when": [
"8. 查看自己发起的审批列表(--process-code 来自 list-forms / search-forms / detail)",
"我发起的审批"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询已发起的审批实例列表”"
],
"examples": [
"dws oa approval list-initiated --process-code <code> --start \"2026-03-10T00:00:00+08:00\" --end \"2026-03-10T23:59:59+08:00\" --cursor 0 --limit 20",
"dws oa approval list-initiated --process-code <code> --start \"2026-03-10T00:00:00+08:00\" --end \"2026-03-10T23:59:59+08:00\" --cursor 0 --limit 20 --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.list_pending_approvals": {
"use_when": [
"1. 查看待我处理的审批 — 提取 processInstanceId",
"待审批/待处理审批",
"待我审批/我要审批的"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询待我处理的审批”"
],
"examples": [
"dws oa approval list-pending --start \"2026-03-10T00:00:00+08:00\" --end \"2026-03-10T23:59:59+08:00\"",
"dws oa approval list-pending --start \"2026-03-10T00:00:00+08:00\" --end \"2026-03-10T23:59:59+08:00\" --query 关键词"
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.list_pending_tasks": {
"use_when": [
"3. 获取待审批任务 ID — 提取 taskId",
"同意审批/批准",
"我有哪些待审的任务",
"拒绝审批/驳回"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询待我审批的任务 ID”"
],
"examples": [
"dws oa approval tasks --instance-id <processInstanceId>",
"dws oa approval tasks --instance-id <processInstanceId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.list_user_visible_process": {
"use_when": [
"7. 获取可见审批表单(得到 processCode)",
"有哪些审批表单/可见表单"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取当前用户可见的审批表单列表”"
],
"examples": [
"dws oa approval list-forms --cursor 0 --limit 100",
"dws oa approval list-forms --cursor 0 --limit 100 --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.oa_cc_noticer": {
"use_when": [
"14. 对审批实例进行抄送(processInstanceId 来自 list-pending 或 detail)",
"抄送审批/添加抄送人"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“抄送审批人”所述变更时不要使用"
],
"examples": [
"dws oa approval oa-cc-noticer --instance-id <processInstanceId> --users \"68674200835816\"",
"dws oa approval oa-cc-noticer --instance-id <processInstanceId> --users \"userId1,userId2\" --operator-id \"123123\""
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.redirect_task": {
"use_when": [
"12. 转交审批任务(taskId 来自 tasks,toActionerId 来自 contact user search)",
"转交审批/转交任务"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“转交审批任务”所述变更时不要使用"
],
"examples": [
"dws oa approval redirect-task --task-id <taskId> --to-actioner-id <userId>",
"dws oa approval redirect-task --task-id <taskId> --to-actioner-id <userId> --remark \"请帮忙处理\""
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.reject_processInstance": {
"use_when": [
"4b. 拒绝审批",
"拒绝审批/驳回"
],
"avoid_when": [
"用户未明确要求“拒绝审批”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws oa approval reject --instance-id <id> --task-id <taskId> --remark \"不同意\"",
"dws oa approval reject --instance-id <id> --task-id <taskId> --remark \"不符合要求\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"oa.revoke_processInstance": {
"use_when": [
"5. 撤销自己发起的审批",
"撤回审批/取消审批",
"撤销审批/撤回"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“撤销已发起的审批”所述变更时不要使用"
],
"examples": [
"dws oa approval revoke --instance-id <instance-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"pat.batch_grant": {
"use_when": [
"执行批量行为授权(高影响,必须先让用户确认)",
"授予 Agent 行为权限/授权 scope/批量授权产品/一次性授权/会话授权/永久授权",
"预览按产品展开的批量授权计划,不写入授权"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“按可信上下文为当前用户执行 PAT 批量授权,支持 dryRun 和 pending flow。”所述变更时不要使用"
],
"examples": [
"dws pat chmod --products calendar,aitable --grant-type session --session-id <SESSION_ID> --dry-run --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"pat.browser_policy": {
"use_when": [
"PAT 授权时允许或禁止打开浏览器/配置浏览器授权策略",
"允许 PAT 授权流程打开本地浏览器",
"禁止指定 Agent 的 PAT 授权流程打开本地浏览器",
"配置 PAT 授权时是否打开浏览器"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“配置 PAT 授权时是否打开浏览器”所述变更时不要使用"
],
"examples": [
"dws pat browser-policy --enabled --format json",
"dws pat browser-policy --enabled=false --agentCode <AGENT_CODE> --format json"
],
"interface_mode": "local",
"availability": "available",
"interface_reason": "命令仅操作本地进程或策略文件,不调用 MCP 接口"
},
"report.create_report": {
"use_when": [
"2b. 提交日志(从步骤 1/2 取 templateId 与 contents 字段)— 推荐 --contents-file 传入避免 shell 引号",
"内联(短内容)",
"推荐:长内容走文件,避免 shell 引号问题"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“提交一份新日报(按模版)”所述变更时不要使用"
],
"examples": [
"dws report entry submit --template-id <templateId> --contents-file ./report.json --format json",
"dws report entry submit --template-id <templateId> --contents '[{\"key\":\"今日完成\",\"sort\":\"0\",\"content\":\"完成了需求评审\",\"contentType\":\"markdown\",\"type\":\"1\"}]' --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"report.get_available_report_templates": {
"use_when": [
"1. 获取当前用户可用的日志模版",
"写日报/提交周报/发日志/填日志",
"有什么日志模版"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取当前用户可用的日志模版列表”"
],
"examples": [
"dws report template list",
"dws report template list --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"report.get_received_report_list": {
"use_when": [
"3. 查看收到的日报列表 — 提取 reportId",
"别人发给我的日志/我收到的日志",
"我收到的日志",
"查日志/看日报/看正文"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列出我收到的日报”"
],
"examples": [
"dws report inbox list --start-date 2026-05-04 --end-date 2026-05-11 --format json",
"dws report inbox list --date 2026-05-11 --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"report.get_report_entry_details": {
"use_when": [
"2c. 仅当 submit 返回中缺少 dingtalkOpenUrl 时,手动补取 dingtalk:// 跳转链接",
"4. 查看日报详情(正文/字段明细)",
"从列表结果提取 reportId 后,再查正文",
"先通过 report inbox list / outbox list / entry submit 取得 reportId,再查正文与跳转链接",
"已知 reportId",
"我发过 / 我创建的日志",
"我收到的日志"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“读取单份日报正文(含字段明细 + 钉钉跳转链接)”"
],
"examples": [
"dws report entry get --report-id <reportId> --format json",
"dws report entry get --report-id <reportId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"report.get_report_statistics_by_id": {
"use_when": [
"5. 查看日报已读统计",
"日志统计/已读统计"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“读取单份日报的已读统计”"
],
"examples": [
"dws report entry stats --report-id <reportId>",
"dws report entry stats --report-id <reportId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"report.get_send_report_list": {
"use_when": [
"6. 查看我发出的日报列表",
"我发过 / 我创建的日志",
"我发过的日志/我创建的日志"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列出我发出的日报”"
],
"examples": [
"dws report outbox list --cursor 0 --size 20 --format json",
"dws report outbox list --cursor 0 --size 20"
],
"interface_mode": "mcp",
"availability": "available"
},
"report.get_template_details_by_name": {
"use_when": [
"2. 按名称读取模版字段定义"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“读取单个日志模版的字段定义”"
],
"examples": [
"dws report template get --name <templateName>",
"dws report template get --name \"日报\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.add_dimension": {
"use_when": [
"追加空行/追加空列/增加行数/增加列数/扩展表格/在末尾加空行;追加空行/空列"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在钉钉表格的指定工作表末尾追加空行或空列。”所述变更时不要使用"
],
"examples": [
"dws sheet add-dimension --node <NODE_ID> --sheet-id <SHEET_ID> --dimension ROWS --length 5",
"dws sheet add-dimension --node <NODE_ID> --sheet-id <SHEET_ID> --dimension COLUMNS --length 3"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.append_rows": {
"use_when": [
"3. 追加单行数据",
"4. 追加多行数据",
"插入行/插入列/在某行前插入/在某列前插入;在末尾追加",
"追加数据/添加行/在末尾加数据/新增记录;追加数据"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在钉钉电子表格的指定工作表末尾追加若干行数据。”所述变更时不要使用"
],
"examples": [
"dws sheet append --node <NODE_ID> --sheet-id <SHEET_ID> --values '[[\"张三\",\"销售部\",50000]]'",
"dws sheet append --node <NODE_ID> --sheet-id \"Sheet1\" --values '[[\"李四\",\"市场部\",38000],[\"王五\",\"销售部\",62000]]'"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.clear_range": {
"use_when": [
"删除行/删除列/删掉第几行/删掉某列/移除行/移除列;仅清空内容但保留行/列",
"清空/清除区域/擦除内容/清除格式;仅清除值",
"清空/清除区域/擦除内容/清除格式;仅清除格式",
"清空/清除区域/擦除内容/清除格式;全部清除",
"清空/清除区域/擦除内容/清除格式;清除区域",
"清空整片区域请改用 range clear"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“清除钉钉电子表格中指定工作表指定范围的单元格内容、格式或全部。”所述变更时不要使用"
],
"examples": [
"dws sheet range clear --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A1:B3\""
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.copy_sheet": {
"use_when": [
"只指定名称",
"复制工作表/拷贝工作表/克隆工作表/工作表副本;复制工作表",
"复制工作表/拷贝工作表/克隆工作表/工作表副本;复制并指定位置",
"复制工作表/拷贝工作表/克隆工作表/工作表副本;复制并指定名称",
"指定副本名称和位置",
"按默认位置复制"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“复制钉钉电子表格中的指定工作表,在同一表格中创建一个副本,可同时指定副本的目标位置。”所述变更时不要使用"
],
"examples": [
"dws sheet copy --node <NODE_ID> --sheet-id <SHEET_ID>",
"dws sheet copy --node <NODE_ID> --sheet-id <SHEET_ID> --title \"销售副本\" --index 2"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.create_cond_format": {
"use_when": [
"创建条件格式/设置条件格式/大于某值时标红/包含某文本时高亮/数据条/图标集/色阶/重复值高亮;创建条件格式规则",
"基于辅助列值做条件格式(用 formulaCondition 引用辅助列)",
"数值条件:大于 80 时标红加粗",
"数据条",
"文本条件:包含\"延期\"时加删除线",
"色阶(三色)",
"虽然逻辑等价,但产物里缺辅助列 → 用户打开表格看不到\"是/否\"列",
"重复值高亮"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在指定工作表中创建一条条件格式规则。”所述变更时不要使用"
],
"examples": [
"dws sheet cond-format create --node NODE_ID --sheet-id SHEET_ID --ranges '[\"A2:H100\"]' --condition '{\"formulaCondition\":{\"formula\":\"=$H2=\\\"是\\\"\"}}' --cell-style '{\"backgroundColor\":\"#FFECEC\"}'",
"dws sheet cond-format create --node NODE_ID --sheet-id SHEET_ID --ranges '[\"A2:H100\"]' --condition '{\"formulaCondition\":{\"formula\":\"=$A2>$B2\"}}' --cell-style '{\"backgroundColor\":\"#FFECEC\"}'"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.create_filter": {
"use_when": [
"创建筛选并同时设置条件(按值筛选)",
"创建筛选并设置条件筛选",
"创建筛选框架(不设条件)",
"筛选/过滤/只看某些值/只显示满足条件的行/筛选数据/创建筛选/删除筛选/设置筛选条件/清除筛选/排序;创建筛选"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在钉钉电子表格的指定工作表中创建筛选。”所述变更时不要使用"
],
"examples": [
"dws sheet filter create --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A1:E100\"",
"dws sheet filter create --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A1:E100\" --criteria '[{\"column\":1,\"filterType\":\"values\",\"visibleValues\":[\"北京\",\"上海\"]}]'"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.create_filter_view": {
"use_when": [
"3. 创建筛选视图(不带条件)",
"创建不带筛选条件的筛选视图",
"创建带按值筛选条件的筛选视图",
"创建带按条件筛选的筛选视图(大于等于 200000)",
"创建筛选视图/新建筛选视图/添加筛选视图;创建筛选视图",
"创建筛选视图时直接指定筛选条件",
"查看具体命令的完整参数说明"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在钉钉电子表格的指定工作表中创建一个筛选视图。”所述变更时不要使用"
],
"examples": [
"dws sheet filter-view create --help",
"dws sheet filter-view create --node <NODE_ID> --sheet-id <SHEET_ID> --name \"我的视图\" --range \"A1:E10\""
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.create_float_image": {
"use_when": [
"再创建浮动图片",
"带偏移量"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在钉钉电子表格的指定工作表中插入一张浮动图片。”所述变更时不要使用"
],
"examples": [
"dws sheet create-float-image --node <NODE_ID> --sheet-id <SHEET_ID> --src \"/core/api/resources/img/xxxx...\" --range A1 --width 400 --height 300",
"dws sheet create-float-image --node <NODE_ID> --sheet-id <SHEET_ID> --src \"/core/api/resources/img/xxxx...\" --range B2 --width 200 --height 150 --offset-x 10 --offset-y 20"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.create_sheet": {
"use_when": [
"1. 新建工作表",
"加工作表/新增Sheet;新建工作表"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“新建工作表”所述变更时不要使用"
],
"examples": [
"dws sheet new --node <NODE_ID> --name \"Sheet2\"",
"dws sheet new --node <NODE_ID> --name \"数据汇总\""
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.create_workspace_sheet": {
"use_when": [
"1. 创建表格文档 — 提取 nodeId",
"4. 完整流程: 创建表格 → 上传附件",
"4. 完整流程: 创建表格 → 写表头 → 写入图片",
"创建表格/新建电子表格;创建表格文档"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建钉钉表格文档”所述变更时不要使用"
],
"examples": [
"dws sheet create --name \"销售数据\"",
"dws sheet create --name \"Q1 数据\" --folder <FOLDER_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.delete_cond_format": {
"use_when": [
"删除条件格式/移除条件格式/取消条件格式;删除条件格式规则",
"删除条件格式规则(必须加 --yes 确认)"
],
"avoid_when": [
"用户未明确要求“删除指定工作表中的一条条件格式规则。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws sheet cond-format delete --node <node> --rule-id <rule-id> --sheet-id <sheet-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.delete_dimension": {
"use_when": [
"2. 从第 3 行开始删除 2 行",
"3. 从 A 列开始删除 1 列",
"4. 使用工作表前缀指定位置",
"从 A 列开始删除 1 列",
"从 AB 列开始删除 3 列",
"从第 3 行开始删除 2 行",
"使用工作表前缀(忽略 --sheet-id)",
"删除行/删除列/删掉第几行/删掉某列/移除行/移除列;删除行或列"
],
"avoid_when": [
"用户未明确要求“在钉钉表格指定工作表中,从指定位置起删除若干连续的行或列。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws sheet delete-dimension --node <NODE_ID> --sheet-id <SHEET_ID> --dimension ROWS --position \"3\" --length 2",
"dws sheet delete-dimension --node <NODE_ID> --sheet-id <SHEET_ID> --dimension COLUMNS --position \"A\" --length 1"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.delete_dropdown_lists": {
"use_when": [
"删除下拉列表/移除下拉/取消下拉/清除下拉;删除下拉列表"
],
"avoid_when": [
"用户未明确要求“删除钉钉表格指定单元格范围内的下拉列表配置。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws sheet delete-dropdown --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A2:A100\"",
"dws sheet delete-dropdown --node <NODE_ID> --sheet-id <SHEET_ID> --range \"B1:D10\""
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.delete_filter": {
"use_when": [
"筛选/过滤/只看某些值/只显示满足条件的行/筛选数据/创建筛选/删除筛选/设置筛选条件/清除筛选/排序;删除筛选"
],
"avoid_when": [
"用户未明确要求“删除钉钉电子表格中指定工作表的筛选。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws sheet filter delete --node <node> --sheet-id <sheet-id>"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.delete_filter_view": {
"use_when": [
"8. 删除筛选视图",
"删除筛选视图/移除筛选视图;删除筛选视图"
],
"avoid_when": [
"用户未明确要求“删除钉钉电子表格中指定工作表的筛选视图。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws sheet filter-view delete --node <NODE_ID> --sheet-id <SHEET_ID> --filter-view-id <FV_ID>",
"dws sheet filter-view delete --node <NODE_ID> --sheet-id <SHEET_ID> --filter-view-id <FV_ID> -f json"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.delete_float_image": {
"use_when": [
"删除浮动图片/移除浮动图片;删除浮动图片"
],
"avoid_when": [
"用户未明确要求“删除钉钉电子表格中指定的浮动图片。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws sheet delete-float-image --node <NODE_ID> --sheet-id <SHEET_ID> --float-image-id <FI_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.delete_sheet": {
"use_when": [
"删除工作表/移除工作表/删掉这个Sheet;删除工作表"
],
"avoid_when": [
"用户未明确要求“删除钉钉电子表格中的指定工作表”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws sheet delete-sheet --node <NODE_ID> --sheet-id <SHEET_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.fill_range": {
"use_when": [
"自动填充/填充序列/向下填充/拖拽填充/序列递增;自动填充"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“基于源数据范围自动填充到目标范围。”所述变更时不要使用"
],
"examples": [
"dws sheet range fill --node <NODE_ID> --sheet-id <SHEET_ID> --source-range \"A1:A5\" --target-range \"A6:A20\"",
"dws sheet range fill --node <NODE_ID> --sheet-id <SHEET_ID> --source-range \"A1:A5\" --target-range \"A6:A20\" --fill-type copy"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.filter_clear_criteria": {
"use_when": [
"清除第 1 列(A 列)的筛选条件",
"清除第 2 列(B 列)的筛选条件",
"筛选/过滤/只看某些值/只显示满足条件的行/筛选数据/创建筛选/删除筛选/设置筛选条件/清除筛选/排序;清除某一列条件"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“清除钉钉电子表格中指定工作表筛选的某一列的筛选条件。”所述变更时不要使用"
],
"examples": [
"dws sheet filter clear-criteria --node <NODE_ID> --sheet-id <SHEET_ID> --column 1",
"dws sheet filter clear-criteria --node <NODE_ID> --sheet-id <SHEET_ID> --column 0"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.filter_view_delete_criteria": {
"use_when": [
"7. 清除某列的筛选条件",
"删除第 1 列(A 列)的筛选条件",
"删除第 3 列(C 列)的筛选条件",
"清除筛选条件/移除筛选条件/取消筛选条件;清除筛选视图列条件"
],
"avoid_when": [
"用户未明确要求“清除钉钉电子表格中指定工作表筛选视图的某一列的筛选条件。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws sheet filter-view delete-criteria --node <NODE_ID> --sheet-id <SHEET_ID> --filter-view-id <FV_ID> --column 0",
"dws sheet filter-view delete-criteria --node <NODE_ID> --sheet-id <SHEET_ID> --filter-view-id <FV_ID> --column 2"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.filter_view_get_criteria": {
"use_when": [
"查看第 1 列(偏移量 0)的筛选条件",
"查看第 3 列(偏移量 2)的筛选条件",
"查看筛选条件/有哪些筛选条件/筛选视图设了什么条件/列出筛选条件;查看某一列的条件",
"获取单列筛选条件"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取单列筛选条件”"
],
"examples": [
"dws sheet filter-view get-criteria --node <NODE_ID> --sheet-id <SHEET_ID> --filter-view-id <FV_ID> --column 0",
"dws sheet filter-view get-criteria --node <NODE_ID> --sheet-id <SHEET_ID> --filter-view-id <FV_ID> --column 2"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.filter_view_info": {
"use_when": [
"查看指定筛选视图的详情",
"筛选视图详情/查看某个筛选视图/筛选视图信息/筛选视图配置;获取单个筛选视图详情",
"获取单个筛选视图详情"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取单个筛选视图详情”"
],
"examples": [
"dws sheet filter-view info --node <NODE_ID> --sheet-id <SHEET_ID> --filter-view-id <FV_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.filter_view_list_criteria": {
"use_when": [
"列出筛选视图所有列条件",
"列出筛选视图的所有条件",
"查看筛选条件/有哪些筛选条件/筛选视图设了什么条件/列出筛选条件;列出所有列条件"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列出筛选视图所有列条件”"
],
"examples": [
"dws sheet filter-view list-criteria --node <NODE_ID> --sheet-id <SHEET_ID> --filter-view-id <FV_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.filter_view_update_criteria": {
"use_when": [
"4. 为筛选视图设置列条件(按值筛选)",
"5. 为筛选视图设置列条件(按条件筛选)",
"多条件筛选:大于等于 60 且 小于等于 90",
"按值筛选:只显示\"销售部\"和\"市场部",
"按条件筛选:大于 100",
"按条件筛选:大于等于 200000",
"按条件筛选:小于 100",
"按颜色筛选:背景色为红色",
"更新筛选视图列条件",
"设置筛选条件/添加筛选条件/配置筛选视图条件/按值筛选/按条件筛选/按颜色筛选;设置筛选视图列条件"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新筛选视图列条件”所述变更时不要使用"
],
"examples": [
"dws sheet filter-view update-criteria --node <NODE_ID> --sheet-id <SHEET_ID> --filter-view-id <FV_ID> --column 0 --filter-criteria '{\"filterType\":\"values\",\"visibleValues\":[\"销售部\",\"市场部\"]}'",
"dws sheet filter-view update-criteria --node <NODE_ID> --sheet-id <SHEET_ID> --filter-view-id <FV_ID> --column 2 --filter-criteria '{\"filterType\":\"condition\",\"conditions\":[{\"operator\":\"greater\",\"value\":\"100\"}]}'"
]
},
"sheet.find_cells": {
"use_when": [
"2. 基本搜索 — 在指定工作表中查找文本",
"3. 在指定范围内搜索",
"4. 正则搜索(不区分大小写)",
"5. 精确匹配整个单元格",
"6. 搜索公式文本",
"在指定范围内搜索",
"基本搜索",
"导出/下载xlsx/存为Excel/存成表格文件/把表格变成xlsx/导出表格/下载表格/导出为 excel;\"帮我找一下表格里的XXX",
"搜索/查找/找单元格/搜内容/精确搜索/精确匹配/完全匹配/全字匹配;搜索公式",
"搜索/查找/找单元格/搜内容/精确搜索/精确匹配/完全匹配/全字匹配;搜索单元格",
"搜索/查找/找单元格/搜内容/精确搜索/精确匹配/完全匹配/全字匹配;正则搜索",
"搜索/查找/找单元格/搜内容/精确搜索/精确匹配/完全匹配/全字匹配;精确匹配(只匹配完全等于的,不匹配包含的)",
"搜索公式文本",
"正则表达式搜索(不区分大小写)",
"精确匹配整个单元格内容"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“在钉钉电子表格的指定工作表中查找匹配指定文本的所有单元格,返回匹配的单元格地址列表。”"
],
"examples": [
"dws sheet find --node <NODE_ID> --sheet-id <SHEET_ID> --find \"销售额\"",
"dws sheet find --node <NODE_ID> --sheet-id <SHEET_ID> --find \"合计\" --range \"A1:D100\""
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.get_all_sheets": {
"use_when": [
"1. 先查 sheetId",
"1. 获取工作表列表",
"2. 查看工作表列表 — 提取 sheetId",
"导出/下载xlsx/存为Excel/存成表格文件/把表格变成xlsx/导出表格/下载表格/导出为 excel;\"这个表格有哪些工作表",
"导出/下载xlsx/存为Excel/存成表格文件/把表格变成xlsx/导出表格/下载表格/导出为 excel;extension=axls",
"看工作表/有哪些工作表/表格结构;列出工作表"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取全部工作表列表”"
],
"examples": [
"dws sheet list --node <NODE_ID>",
"dws sheet list --node \"https://alidocs.dingtalk.com/i/nodes/<DOC_UUID>\""
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.get_cond_format": {
"use_when": [
"条件格式/条件样式/自动变色/满足条件时高亮/按条件设样式/条件格式规则;查看已有条件格式",
"条件格式/条件样式/自动变色/满足条件时高亮/按条件设样式/条件格式规则;查看指定规则详情",
"获取单个规则的详情",
"获取所有条件格式规则"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定工作表中的所有条件格式规则,或通过 ruleId 获取单个规则的详情。”"
],
"examples": [
"dws sheet cond-format list --node NODE_ID --sheet-id SHEET_ID"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.get_dropdown_lists": {
"use_when": [
"查看下拉列表/获取下拉配置/下拉列表有哪些选项;获取下拉列表配置"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询钉钉表格指定范围内的下拉列表配置。”"
],
"examples": [
"dws sheet get-dropdown --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A2:A100\"",
"dws sheet get-dropdown --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A1\""
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.get_filter": {
"use_when": [
"筛选/过滤/只看某些值/只显示满足条件的行/筛选数据/创建筛选/删除筛选/设置筛选条件/清除筛选/排序;查看当前筛选"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取钉钉电子表格中指定工作表的筛选信息。”"
],
"examples": [
"dws sheet filter get --node <NODE_ID> --sheet-id <SHEET_ID>",
"dws sheet filter get --node \"https://alidocs.dingtalk.com/i/nodes/<DOC_UUID>\" --sheet-id \"Sheet1\""
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.get_filter_views": {
"use_when": [
"2. 查看已有筛选视图",
"筛选视图/查看筛选视图/有哪些筛选视图/筛选视图列表;获取所有筛选视图"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取钉钉电子表格中指定工作表的所有筛选视图列表。”"
],
"examples": [
"dws sheet filter-view list --node <NODE_ID> --sheet-id <SHEET_ID>",
"dws sheet filter-view list --node \"https://alidocs.dingtalk.com/i/nodes/<DOC_UUID>\" --sheet-id \"Sheet1\""
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.get_float_image": {
"use_when": [
"查看浮动图片/有哪些浮动图片/浮动图片列表;查看某个浮动图片详情"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取钉钉电子表格中指定浮动图片的详细信息。”"
],
"examples": [
"dws sheet get-float-image --node <NODE_ID> --sheet-id <SHEET_ID> --float-image-id <FI_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.get_range_as_csv": {
"use_when": [
"2. 查看数据范围确认列对应关系",
"读数据/看表格内容;快速查看纯值数据、批量处理、大表分批读"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“以 RFC 4180 CSV 格式读取钉钉电子表格中指定工作表的指定范围数据。”"
],
"examples": [
"dws sheet csv-get --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A1:E5\"",
"dws sheet csv-get --node <NODE_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.info": {
"use_when": [
"2. 查看工作表详情(确认列结构)",
"2. 查看工作表详情(行列数、最后非空位置、mergedRanges 等)",
"2. 查看工作表详情(行列数、最后非空位置等)",
"看工作表/有哪些工作表/表格结构;工作表详情",
"读数据/看表格内容;需要查看合并单元格 / 表头合并结构"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定工作表详情”"
],
"examples": [
"dws sheet info --node <NODE_ID>",
"dws sheet info --node <NODE_ID> --sheet-id <SHEET_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.insert_dimension": {
"use_when": [
"2. 在第 3 行之前插入 2 行",
"3. 在 A 列之前插入 1 列",
"4. 使用工作表前缀指定位置",
"使用工作表前缀(忽略 --sheet-id)",
"在 A 列之前插入 1 列",
"在 AB 列之前插入 3 列",
"在第 3 行之前插入 2 行",
"插入行/插入列/在某行前插入/在某列前插入;插入行或列",
"查看具体命令的完整参数说明"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在钉钉表格指定工作表的指定位置之前(before)插入若干空行或空列。”所述变更时不要使用"
],
"examples": [
"dws sheet insert-dimension --help",
"dws sheet insert-dimension --node <NODE_ID> --sheet-id <SHEET_ID> --dimension ROWS --position \"3\" --length 2"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.list_float_images": {
"use_when": [
"查看浮动图片/有哪些浮动图片/浮动图片列表;列出所有浮动图片"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列出钉钉电子表格指定工作表中的所有浮动图片。”"
],
"examples": [
"dws sheet list-float-images --node <NODE_ID> --sheet-id <SHEET_ID>"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.media_upload": {
"use_when": [
"1. 基本用法: 上传本地文件到表格",
"2. 自定义附件显示名称 (--name 指定上传后在表格中显示的名称)",
"3. 指定 MIME 类型 (文件扩展名无法推断时)",
"上传附件/传文件到表格/上传文件到表格/上传到表格;上传附件",
"上传附件/传文件到表格/上传文件到表格/上传到表格;用户指定了上传后的名称",
"上传附件到表格",
"先上传图片获取 resourceUrl",
"提取 nodeId 后:",
"浮动图片/悬浮图片/在表格上放一张图/加个浮动的图;创建浮动图片"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“上传附件到表格”所述变更时不要使用"
],
"examples": [
"dws sheet media-upload --node <NODE_ID> --file ./report.pdf",
"dws sheet media-upload --node <NODE_ID> --file ./data.bin --name \"数据文件.dat\" --mime-type application/octet-stream"
],
"interface_mode": "composite",
"availability": "available",
"interface_reason": "命令包含多个 RPC、条件分派或本地 HTTP/文件步骤,不能绑定为单一 interface_ref"
},
"sheet.merge_cells": {
"use_when": [
"2. 合并所有单元格(默认 mergeAll)",
"3. 按行合并",
"4. 按列合并",
"使用带工作表前缀的范围(忽略 --sheet-id)",
"合并单元格/合并/合并区域/按行合并/按列合并;合并所有单元格",
"合并单元格/合并/合并区域/按行合并/按列合并;按列合并",
"合并单元格/合并/合并区域/按行合并/按列合并;按行合并",
"合并所有单元格(默认)",
"按列合并",
"按行合并"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“将钉钉电子表格中指定工作表的指定区域内的单元格合并为一个或多个合并区域。”所述变更时不要使用"
],
"examples": [
"dws sheet merge-cells --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A1:B3\"",
"dws sheet merge-cells --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A1:C3\" --merge-type mergeRows"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.move_dimension": {
"use_when": [
"将 B~C 列移动到 E 列的位置",
"将 B~C 列(共 2 列)移动到 D 列的位置",
"将第 2 行移动到第 5 行的位置",
"将第 2 行移动到第 5 行的位置(索引从 0 开始)",
"将第 2~4 行移动到第 1 行之前",
"将第 2~4 行(共 3 行)移动到第 1 行的位置(最前面)",
"移动行/移动列/调整行顺序/调整列顺序/行列拖拽/把第N行移到第M行;移动行或列"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在钉钉表格的指定工作表中,将指定范围的行或列移动到目标位置。”所述变更时不要使用"
],
"examples": [
"dws sheet move-dimension --node <NODE_ID> --sheet-id <SHEET_ID> --dimension ROWS --start-index 1 --end-index 1 --destination-index 4",
"dws sheet move-dimension --node <NODE_ID> --sheet-id <SHEET_ID> --dimension ROWS --start-index 1 --end-index 3 --destination-index 0"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.range_batch_set_style": {
"use_when": [
"设置样式/改颜色/设背景色/加粗/居中/换行/字体颜色/字号;批量设置不同 range 的样式"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“对于一个钉钉在线表格,更新指定区域内单元格信息,包括单元格中的值、超链接、数字格式等内容。”所述变更时不要使用"
],
"examples": [
"dws sheet range batch-set-style --node <NODE_ID> --batch ./styles.json",
"dws sheet range batch-set-style --node <NODE_ID> --batch ./styles.json --continue-on-error"
],
"interface_mode": "composite",
"availability": "available",
"interface_ref": null,
"interface_reason": "The CLI reads a local batch file and performs multiple sheet/update_range calls with local continue-on-error control; the workflow has no single direct MCP interface."
},
"sheet.range_copy_to": {
"use_when": [
"复制区域/把这块数据复制到/复制到另一个工作表;复制区域",
"复制区域/把这块数据复制到/复制到另一个工作表;跨工作表"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“将源范围的数据复制到目标位置。”所述变更时不要使用"
],
"examples": [
"dws sheet range copy-to --node <NODE_ID> --sheet-id <SHEET_ID> --source-range \"A1:C5\" --target-range \"D1\"",
"dws sheet range copy-to --node <NODE_ID> --sheet-id <SHEET_ID> --source-range \"A1:C5\" --target-range \"A1\" --target-sheet-id \"Sheet2\""
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.range_move_to": {
"use_when": [
"移动区域/把数据移到/剪切粘贴/移到另一个工作表;移动区域",
"移动区域/把数据移到/剪切粘贴/移到另一个工作表;跨工作表"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“将源范围的数据移动到目标位置,源区域将被清空。”所述变更时不要使用"
],
"examples": [
"dws sheet range move-to --node <NODE_ID> --sheet-id <SHEET_ID> --source-range \"A1:C5\" --target-range \"D1\"",
"dws sheet range move-to --node <NODE_ID> --sheet-id <SHEET_ID> --source-range \"A1:C5\" --target-range \"A1\" --target-sheet-id \"Sheet2\""
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.range_read": {
"use_when": [
"3. 读取全部数据",
"4. 读取指定区域",
"导出/下载xlsx/存为Excel/存成表格文件/把表格变成xlsx/导出表格/下载表格/导出为 excel;\"帮我看看这个表格有什么数据",
"指定取值模式:原始值 / 公式文本",
"读数据/看表格内容;读取数据",
"读数据/看表格内容;需要结构化信息(值+样式+数据验证+富文本+单元格级超链接)、查看公式或原始值"
],
"avoid_when": [
"读一下这个 xlsx 的数据\" / xlsx 节点链接;下载本地表格文件"
],
"examples": [
"dws sheet range read --node <NODE_ID>",
"dws sheet range read --node <NODE_ID> --sheet-id <SHEET_ID>"
]
},
"sheet.range_set_style": {
"use_when": [
"2. 设置数字格式(人民币)",
"2. 设置数字格式(人民币)——批量刷整列走 set-style",
"3. 商品 ID / 规格 ID 按文本展示,避免科学计数法",
"整片 range 启用自动换行",
"方式 B: 单独用 set-style 设置(适合只改格式不改值)",
"给 A1:B3 打上黄底粗体居中",
"给 C1:C5 逐单元格设置不同背景色",
"设置数字格式/改成百分比/用人民币显示/按日期显示/文本格式/保留几位小数;批量设置数字格式",
"设置数字格式/改成百分比/用人民币显示/按日期显示/文本格式/保留几位小数;设置数字格式",
"设置样式/改颜色/设背景色/加粗/居中/换行/字体颜色/字号;仅设样式不改值",
"设置样式/改颜色/设背景色/加粗/居中/换行/字体颜色/字号;设置单元格样式"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“对于一个钉钉在线表格,更新指定区域内单元格信息,包括单元格中的值、超链接、数字格式等内容。”所述变更时不要使用"
],
"examples": [
"dws sheet range set-style --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A1:B3\" --bg-color \"#FFF2CC\" --font-weight bold --h-align center",
"dws sheet range set-style --node <NODE_ID> --sheet-id <SHEET_ID> --range \"C1:C5\" --bg-colors-json '[[\"#FF0000\"],[\"#00FF00\"],[\"#0000FF\"],[\"#FFFF00\"],[\"#FF00FF\"]]'"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.range_update": {
"use_when": [
"2. 在新工作表中写入汇总公式(公式写在 text,以 = 开头)",
"3. 写入表头和数据",
"3. 写入表头和数据(每个单元格必须是 object;数字也写成字符串)",
"3. 写入超链接(写在 cell 的 hyperlink 字段)",
"3. 长数字 ID 写值时同步设置文本格式,避免科学计数法",
"4. 写入单元格级超链接",
"写入公式",
"写入公式(text 以 = 开头识别为公式)",
"写入单元格级超链接",
"写入单元格级超链接(写在 cell 的 hyperlink 字段,没有 --hyperlinks flag)",
"写入文本",
"写入文本(每个单元格必须是 object)",
"写数据/填表/更新单元格/写入公式;更新数据",
"只更新部分单元格:用 {} 空对象占位保留原值",
"导出/下载xlsx/存为Excel/存成表格文件/把表格变成xlsx/导出表格/下载表格/导出为 excel;\"往这个表格写入数据",
"提取 nodeId 后:",
"查看具体命令的完整参数说明",
"每个单元格必须是 object,公式写在 text(以 = 开头);不支持裸字符串",
"清理单元格级超链接,保留当前值",
"清空单个单元格(text 为空字符串)",
"设置数字格式/改成百分比/用人民币显示/按日期显示/文本格式/保留几位小数;写值时顺带设置数字格式",
"设置样式/改颜色/设背景色/加粗/居中/换行/字体颜色/字号;写值同时附带样式"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新工作表指定区域内容(--values 与 --hyperlinks 至少传一项)”所述变更时不要使用"
],
"examples": [
"dws sheet range update --help",
"dws sheet range update --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A1:B2\" --values '[[{\"type\":\"text\",\"text\":\"姓名\"},{\"type\":\"text\",\"text\":\"分数\"}],[{\"type\":\"text\",\"text\":\"张三\"},{\"type\":\"text\",\"text\":\"90\"}]]'"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.replace_all": {
"use_when": [
"替换/查找替换/全局替换/批量替换/把A替换成B/把所有的X改成Y;删除匹配内容",
"替换/查找替换/全局替换/批量替换/把A替换成B/把所有的X改成Y;查找替换",
"替换/查找替换/全局替换/批量替换/把A替换成B/把所有的X改成Y;正则替换",
"替换/查找替换/全局替换/批量替换/把A替换成B/把所有的X改成Y;精确匹配后替换(只替换内容完全等于的单元格)"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在钉钉表格的指定工作表中,全局查找并替换文本内容。”所述变更时不要使用"
],
"examples": [
"dws sheet replace --node <NODE_ID> --sheet-id <SHEET_ID> --find \"旧文本\" --replacement \"新文本\"",
"dws sheet replace --node <NODE_ID> --sheet-id <SHEET_ID> --find \"待处理\" --replacement \"已完成\" --match-entire-cell"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.set_dropdown_lists": {
"use_when": [
"设置下拉列表/下拉选项/下拉菜单/添加下拉/配置下拉;设置下拉列表",
"设置下拉列表/下拉选项/下拉菜单/添加下拉/配置下拉;设置多选下拉",
"设置单选下拉列表",
"设置带颜色的多选下拉列表"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在钉钉表格的指定单元格范围内设置下拉列表。”所述变更时不要使用"
],
"examples": [
"dws sheet set-dropdown --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A2:A100\" --options '[{\"value\":\"选项1\"},{\"value\":\"选项2\"},{\"value\":\"选项3\"}]'",
"dws sheet set-dropdown --node <NODE_ID> --sheet-id <SHEET_ID> --range \"B2:B50\" --options '[{\"value\":\"高\",\"color\":\"#ff0000\"},{\"value\":\"中\",\"color\":\"#ffaa00\"},{\"value\":\"低\",\"color\":\"#00ff00\"}]' --multi-select"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.set_range_from_csv": {
"use_when": [
"内联多行 CSV:必须用 $'...' 让 \\n 变成真换行;普通单引号 '...\\n...' 里的 \\n 是字面量,会写成一行含字面 \\n 的错误数据",
"多行数据推荐用 @文件,最稳妥",
"批量写入CSV/导入CSV/CSV写入表格/把CSV贴到表格里;写入 CSV"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“将 RFC 4180 格式的 CSV 文本写入指定工作表的指定单元格位置。”所述变更时不要使用"
],
"examples": [
"dws sheet csv-put --node <NODE_ID> --sheet-id <SHEET_ID> --start-cell A1 --csv $'name,score\\nAlice,95\\nBob,87'",
"dws sheet csv-put --node <NODE_ID> --sheet-id <SHEET_ID> --start-cell B2 --csv @data.csv --allow-overwrite"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.sort_filter": {
"use_when": [
"按第 1 列(A 列)升序排序",
"按第 3 列(C 列)降序排序",
"筛选/过滤/只看某些值/只显示满足条件的行/筛选数据/创建筛选/删除筛选/设置筛选条件/清除筛选/排序;按列排序"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“对钉钉电子表格中指定工作表的筛选范围内的数据进行排序。”所述变更时不要使用"
],
"examples": [
"dws sheet filter sort --node <NODE_ID> --sheet-id <SHEET_ID> --column 0 --ascending",
"dws sheet filter sort --node <NODE_ID> --sheet-id <SHEET_ID> --column 2 --ascending=false"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.sort_range": {
"use_when": [
"排序/给数据排序/按某列排序/升序/降序;区域排序"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“对钉钉电子表格中指定工作表指定范围的数据进行排序。”所述变更时不要使用"
],
"examples": [
"dws sheet range sort --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A1:D10\" --sort-keys '[{\"column\":\"A\",\"ascending\":true}]'",
"dws sheet range sort --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A1:D10\" --sort-keys '[{\"column\":\"A\",\"ascending\":true},{\"column\":\"C\",\"ascending\":false}]' --has-header"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.submit_export_job": {
"use_when": [
"--output 为目录时,自动按下载链接中的文件名保存",
"仅导出,返回 downloadUrl(链接有时效性,请尽快下载)",
"场景 A:仅获取下载链接(命令内部自动完成提交+轮询,最终返回 downloadUrl)",
"场景 B:导出并自动下载为本地文件",
"场景 C:下载到目录,自动按链接推断文件名",
"导出/下载xlsx/存为Excel/存成表格文件/把表格变成xlsx/导出表格/下载表格/导出为 excel;导出表格",
"导出/下载xlsx/存为Excel/存成表格文件/把表格变成xlsx/导出表格/下载表格/导出为 excel;需要落盘到本地",
"导出并自动下载为本地文件",
"把这个在线表格导出为 xlsx 文件;在线表格格式转换"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“用于将钉钉在线表格导出为 xlsx。”"
],
"examples": [
"dws sheet export --node <NODE_ID>",
"dws sheet export --node \"https://alidocs.dingtalk.com/i/nodes/<DOC_UUID>\""
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.unmerge_range": {
"use_when": [
"取消合并/拆分单元格/还原合并;取消合并单元格"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“取消钉钉表格指定工作表中指定范围内的合并单元格。”所述变更时不要使用"
],
"examples": [
"dws sheet unmerge-cells --node <NODE_ID> --sheet-id <SHEET_ID> --range \"A1:D5\""
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.update_cond_format": {
"use_when": [
"修改应用范围",
"修改条件格式/更新条件格式规则/改条件/改样式/改范围;更新条件格式规则",
"修改条件(改为大于 90)",
"修改样式"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新指定工作表中的一条条件格式规则。”所述变更时不要使用"
],
"examples": [
"dws sheet cond-format update --node <NODE_ID> --sheet-id <SHEET_ID> --rule-id <RULE_ID> --condition '{\"numberCondition\":{\"operator\":\"greater\",\"value1\":\"90\"}}'",
"dws sheet cond-format update --node <NODE_ID> --sheet-id <SHEET_ID> --rule-id <RULE_ID> --cell-style '{\"backgroundColor\":\"#C8E6C9\",\"fontColor\":\"#1B5E20\"}'"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.update_dimension": {
"use_when": [
"2. 隐藏第 3~4 行",
"3. 显示 A~B 列",
"4. 设置第 1~5 行行高为 40px",
"5. 设置 C 列列宽为 200px 并隐藏",
"使用工作表前缀(忽略 --sheet-id)",
"显示 A~B 列",
"设置 C 列列宽为 200px 并隐藏",
"设置第 1~5 行行高为 40px",
"隐藏第 3~4 行",
"隐藏行/隐藏列/显示行/显示列/设置行高/设置列宽/调整行高/调整列宽/行列属性;同时修改尺寸与显隐",
"隐藏行/隐藏列/显示行/显示列/设置行高/设置列宽/调整行高/调整列宽/行列属性;设置行高/列宽",
"隐藏行/隐藏列/显示行/显示列/设置行高/设置列宽/调整行高/调整列宽/行列属性;隐藏/显示行或列"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“批量更新钉钉表格指定工作表中连续多行/多列的属性,支持设置显隐状态(hidden)与行高/列宽(pixelSize)。”所述变更时不要使用"
],
"examples": [
"dws sheet update-dimension --node <NODE_ID> --sheet-id <SHEET_ID> --dimension ROWS --start-index \"3\" --length 2 --hidden",
"dws sheet update-dimension --node <NODE_ID> --sheet-id <SHEET_ID> --dimension COLUMNS --start-index \"A\" --length 2 --hidden=false"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.update_filter": {
"use_when": [
"同时设置多列的筛选条件",
"按颜色筛选",
"筛选/过滤/只看某些值/只显示满足条件的行/筛选数据/创建筛选/删除筛选/设置筛选条件/清除筛选/排序;批量设置多列条件"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“批量更新钉钉电子表格中指定工作表的筛选条件。”所述变更时不要使用"
],
"examples": [
"dws sheet filter update --node <NODE_ID> --sheet-id <SHEET_ID> --criteria '[{\"column\":0,\"filterType\":\"values\",\"visibleValues\":[\"已完成\",\"进行中\"]},{\"column\":2,\"filterType\":\"condition\",\"conditions\":[{\"operator\":\"greater\",\"value\":\"50\"}]}]'",
"dws sheet filter update --node <NODE_ID> --sheet-id <SHEET_ID> --criteria '[{\"column\":1,\"filterType\":\"color\",\"backgroundColor\":\"#FF0000\"}]'"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.update_filter_view": {
"use_when": [
"6. 更新筛选视图名称和范围",
"更新筛选条件",
"更新筛选视图/修改筛选视图/改筛选视图名称/改筛选视图范围;更新筛选视图属性",
"更新筛选视图名称",
"更新筛选视图范围"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新钉钉电子表格中指定工作表的筛选视图属性(名称、范围和/或筛选条件)。”所述变更时不要使用"
],
"examples": [
"dws sheet filter-view update --node <NODE_ID> --sheet-id <SHEET_ID> --filter-view-id <FV_ID> --name \"新名称\"",
"dws sheet filter-view update --node <NODE_ID> --sheet-id <SHEET_ID> --filter-view-id <FV_ID> --range \"A1:F20\""
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.update_float_image": {
"use_when": [
"替换图片(需先 media-upload 新图片获取 resourceUrl)",
"移动浮动图片/调整浮动图片大小/修改浮动图片/更新浮动图片;更新浮动图片属性",
"移动浮动图片到新位置",
"调整尺寸"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新钉钉电子表格中指定浮动图片的属性。”所述变更时不要使用"
],
"examples": [
"dws sheet update-float-image --node <NODE_ID> --sheet-id <SHEET_ID> --float-image-id <FI_ID> --range C5",
"dws sheet update-float-image --node <NODE_ID> --sheet-id <SHEET_ID> --float-image-id <FI_ID> --width 600 --height 400"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.update_sheet": {
"use_when": [
"修改工作表名称/重命名工作表/移动工作表位置/隐藏工作表/显示工作表/冻结行/冻结列/取消冻结/更新工作表属性;冻结行列",
"修改工作表名称/重命名工作表/移动工作表位置/隐藏工作表/显示工作表/冻结行/冻结列/取消冻结/更新工作表属性;取消冻结",
"修改工作表名称/重命名工作表/移动工作表位置/隐藏工作表/显示工作表/冻结行/冻结列/取消冻结/更新工作表属性;显示工作表",
"修改工作表名称/重命名工作表/移动工作表位置/隐藏工作表/显示工作表/冻结行/冻结列/取消冻结/更新工作表属性;更新工作表属性",
"修改工作表名称/重命名工作表/移动工作表位置/隐藏工作表/显示工作表/冻结行/冻结列/取消冻结/更新工作表属性;移动工作表位置",
"修改工作表名称/重命名工作表/移动工作表位置/隐藏工作表/显示工作表/冻结行/冻结列/取消冻结/更新工作表属性;重命名工作表",
"修改工作表名称/重命名工作表/移动工作表位置/隐藏工作表/显示工作表/冻结行/冻结列/取消冻结/更新工作表属性;隐藏工作表",
"取消冻结",
"改名 + 调整冻结",
"显示工作表",
"移动工作表到第一个位置",
"隐藏工作表"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“更新钉钉电子表格中指定工作表的属性,包括名称、位置、可见性、冻结行列等。”所述变更时不要使用"
],
"examples": [
"dws sheet update --node <NODE_ID> --sheet-id <SHEET_ID> --title \"汇总表\" --frozen-row-count 2 --frozen-column-count 1",
"dws sheet update --node <NODE_ID> --sheet-id <SHEET_ID> --hidden=true"
],
"interface_mode": "mcp",
"availability": "available"
},
"sheet.write_image": {
"use_when": [
"1. 基本用法: 写入图片到指定单元格",
"2. 指定显示尺寸",
"3. 自定义图片名称",
"写入图片/插入图片/加图片/放图片到单元格/嵌入图片到表格;写入图片",
"写入图片/插入图片/加图片/放图片到单元格/嵌入图片到表格;用户指定了图片尺寸",
"提取 nodeId 后:"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在钉钉表格的指定单元格中插入图片。”所述变更时不要使用"
],
"examples": [
"dws sheet write-image --node <NODE_ID> --sheet-id <SHEET_ID> --range A1:A1 --file ./chart.png",
"dws sheet write-image --node <NODE_ID> --sheet-id <SHEET_ID> --range B2:B2 --file ./logo.png --width 200 --height 100"
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.add_task_executors": {
"use_when": [
"10. 添加待办执行人",
"加个执行人/添加执行者"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“添加待办执行人”所述变更时不要使用"
],
"examples": [
"dws todo task add-executor --task-id <taskId> --executors <USER_ID_1>,<USER_ID_2>",
"dws todo task add-executor --task-id <taskId> --executors userId1,userId2 --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.add_task_participants": {
"use_when": [
"12. 添加待办参与人",
"加个参与人/添加参与者"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“添加待办参与人”所述变更时不要使用"
],
"examples": [
"dws todo task add-participant --task-id <taskId> --participants <USER_ID_1>,<USER_ID_2>",
"dws todo task add-participant --task-id <taskId> --participants userId1,userId2 --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.add_todo_attachment": {
"use_when": [
"18. 上传附件(真实上传,先确认待办存在)— 从返回 result.attachmentIds 取 attachmentId"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“添加待办任务附件”所述变更时不要使用"
],
"examples": [
"dws todo task add-attachment --task-id <taskId> --file-path /path/to/file.pdf",
"dws todo task add-attachment --task-id <taskId> --file-path /path/to/file.pdf --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.add_todo_comment": {
"use_when": [
"7. 给待办新增评论",
"给待办加条评论/留个备注"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“给待办添加评论”所述变更时不要使用"
],
"examples": [
"dws todo comment add --task-id <taskId> --content \"评论内容\"",
"dws todo comment add --task-id <taskId> --content \"已开始处理\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.add_todo_reminder": {
"use_when": [
"14. 添加待办提醒(基于截止时间偏移,待办必须有截止时间)",
"15. 添加待办提醒(自定义时间戳)",
"给待办加个提醒/设置提醒"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“添加待办提醒”所述变更时不要使用"
],
"examples": [
"dws todo task add-reminder --task-id <taskId> --base-time dueTime --due-date-offset -30",
"dws todo task add-reminder --task-id <taskId> --base-time customTime --reminder-time-stamp \"2026-03-10T18:00:00+08:00\""
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.create_personal_sub_todo": {
"use_when": [
"1c. 创建子待办(需先获取父待办 ID)",
"加个子任务/创建子待办"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在当前企业组织内创建一条个人待办的子待办事项(要求父待办必须是操作者本人创建),支持设置标题、执行人列表、截止时间、优先级(如高/中/低)。”所述变更时不要使用"
],
"examples": [
"dws todo task create-sub --parent-id <PARENT_TASK_ID> --title \"子任务标题\" --executors <USER_ID_1>,<USER_ID_2> --priority 40",
"dws todo task create-sub --parent-id <PARENT_TASK_ID> --title \"子任务标题\" --executors <USER_ID> --due \"2026-03-20T10:00:00+08:00\""
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.create_personal_todo": {
"use_when": [
"1. 创建待办 — 从返回 result.taskId 提取任务 ID",
"1b. 创建按天循环的待办(必须先有 --due;recurrence 与 MCP create_personal_todo 一致)",
"加个待办/记一下/TODO",
"每天重复/循环待办/按天重复"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建待办”所述变更时不要使用"
],
"examples": [
"dws todo task create --title \"修复线上Bug\" --executors <USER_ID_1>,<USER_ID_2> --priority 40",
"dws todo task create --title \"每日站会\" --executors <USER_ID> --due \"2026-03-20T10:00:00+08:00\" --recurrence \"DTSTART:20260320T020000Z\\nRRULE:FREQ=DAILY;INTERVAL=1\""
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.delete_todo": {
"use_when": [
"6. 删除待办",
"删除待办/取消待办"
],
"avoid_when": [
"用户未明确要求“删除待办”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws todo task delete --task-id <taskId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.delete_todo_comment": {
"use_when": [
"9. 删除待办评论",
"删除这条评论"
],
"avoid_when": [
"用户未明确要求“删除待办的评论”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws todo comment delete --task-id <taskId> --comment-id <commentId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.get_todo_detail": {
"use_when": [
"3. 查看待办详情",
"看看待办详情"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“待办详情”"
],
"examples": [
"dws todo task get --task-id <taskId>",
"dws todo task get --task-id <taskId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.get_user_todos_in_current_org": {
"use_when": [
"2. 查看未完成待办",
"看看待办/我有啥要做"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取当前用户在所属组织中的个人待办事项列表,返回每项待办的标题、截止日期、优先级(如高/中/低)、完成状态。”"
],
"examples": [
"dws todo task list --page 1 --size 20 --status false",
"dws todo task list --page 1 --size 20 --status false --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.list_todo_comment": {
"use_when": [
"8. 查看待办评论列表",
"看看这个待办的评论"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取待办的评论”"
],
"examples": [
"dws todo comment list --task-id <taskId>",
"dws todo comment list --task-id <taskId> --page 1 --size 20"
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.remove_task_executors": {
"use_when": [
"11. 移除待办执行人",
"移除执行人/删除执行者"
],
"avoid_when": [
"用户未明确要求“移除待办执行人”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws todo task remove-executor --task-id <taskId> --executors <USER_ID_1>,<USER_ID_2>",
"dws todo task remove-executor --task-id <taskId> --executors userId1 --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.remove_task_participants": {
"use_when": [
"13. 移除待办参与人",
"移除参与人/删除参与者"
],
"avoid_when": [
"用户未明确要求“移除待办参与人”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws todo task remove-participant --task-id <taskId> --participants <USER_ID_1>,<USER_ID_2>",
"dws todo task remove-participant --task-id <taskId> --participants userId1 --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.reset_todo_reminder": {
"use_when": [
"16. 重置待办提醒",
"17. 重置待办提醒(指定新规则)",
"重置提醒/清除提醒/修改提醒规则"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“重置待办提醒”所述变更时不要使用"
],
"examples": [
"dws todo task reset-reminder --task-id <taskId>",
"dws todo task reset-reminder --task-id <taskId> --reminder-rules '[{\"dueDateOffset\":-30,\"baseTime\":\"dueTime\"},{\"reminderTimeStamp\":\"2026-03-10T18:00:00+08:00\",\"baseTime\":\"customTime\"}]'"
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.update_todo_done_status": {
"use_when": [
"5. 标记待办完成",
"做完了/完成待办/标记完成"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“修改执行者的待办完成状态”所述变更时不要使用"
],
"examples": [
"dws todo task done --task-id <taskId> --status true",
"dws todo task done --task-id <taskId> --status false"
],
"interface_mode": "mcp",
"availability": "available"
},
"todo.update_todo_task": {
"use_when": [
"4. 修改待办信息",
"改个待办/修改待办标题/改优先级"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“修改待办任务”所述变更时不要使用"
],
"examples": [
"dws todo task update --task-id <taskId> --title \"新标题\"",
"dws todo task update --task-id <taskId> --priority 40 --due \"2026-03-10T18:00:00+08:00\""
],
"interface_mode": "mcp",
"availability": "available"
},
"wiki.add_member": {
"use_when": [
"2. 添加成员",
"把知识库分享给某人/给某人加入知识库/邀请进知识库",
"查看具体命令的完整参数说明"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“为知识库添加指定角色的成员。”所述变更时不要使用"
],
"examples": [
"dws wiki member add --help",
"dws wiki member add --workspace <WS_ID> --users uid1 --role READER"
],
"interface_mode": "mcp",
"availability": "available"
},
"wiki.create_file": {
"use_when": [
"1. 创建文档节点",
"2. 创建文件夹",
"3. 在指定文件夹下创建",
"在知识库里创建一个文档;创建空文件实体",
"在知识库里创建文档/新建文件夹"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“在指定位置创建一个新的文件(文档、表格、演示、白板、脑图、多维表或文件夹)。”所述变更时不要使用"
],
"examples": [
"dws wiki node create --workspace <workspaceId> --name \"新文档\" --format json",
"dws wiki node create --workspace <workspaceId> --name \"方案目录\" --type folder --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"wiki.create_wikiSpace": {
"use_when": [
"创建知识库",
"创建知识库/新建知识库"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“创建一个新的钉钉文档知识库(WikiSpace)。”所述变更时不要使用"
],
"examples": [
"dws wiki space create --name \"产品文档库\" --format json",
"dws wiki space create --name \"技术方案\" --desc \"团队技术方案归档\" --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"wiki.delete_document": {
"use_when": [
"删除知识库里的文档/节点",
"删除节点(会要求确认)"
],
"avoid_when": [
"用户未明确要求“将指定节点移入回收站,30 天内可从回收站恢复,超过 30 天将被永久删除。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws wiki node delete --workspace <workspaceId> --node <nodeId>"
],
"interface_mode": "mcp",
"availability": "available"
},
"wiki.delete_wikiSpace": {
"use_when": [
"2. 删除知识库",
"删除知识库/移除知识库/把知识库删了"
],
"avoid_when": [
"用户未明确要求“将指定知识库移入回收站。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws wiki space delete --workspace <workspaceId>",
"dws wiki space delete --workspace \"https://alidocs.dingtalk.com/i/spaces/xxx/overview\""
],
"interface_mode": "mcp",
"availability": "available"
},
"wiki.get_wikiSpace": {
"use_when": [
"1. 确认知识库信息",
"查看具体命令的完整参数说明",
"查看知识库/知识库详情",
"查看知识库详情"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取指定知识库的详细信息,包括名称、描述、创建者、创建时间、成员数量等。”"
],
"examples": [
"dws wiki space get --help",
"dws wiki space get --workspace <workspaceId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"wiki.list_member": {
"use_when": [
"1. 查看当前成员(只返回 name/role/type,拿不到 userId)",
"3. 查看当前成员",
"知识库有哪些成员/查看知识库成员"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“查询知识库当前的成员权限列表,支持按角色过滤。”"
],
"examples": [
"dws wiki member list --workspace <WS_ID>",
"dws wiki member list --workspace <WS_ID> --limit 100"
],
"interface_mode": "mcp",
"availability": "available"
},
"wiki.list_nodes": {
"use_when": [
"2. 列出根目录节点",
"3. 进入子目录",
"帮我看看知识库里的文件;知识库节点列表",
"知识库下的文件/知识库里有哪些文档/浏览知识库内容",
"读某个知识库里的某篇文档"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“列出指定文件夹或知识库下的直接子节点列表(文件夹/文档/文件等),支持分页。”"
],
"examples": [
"dws wiki node list --workspace <workspaceId> --format json",
"dws wiki node list --workspace <workspaceId> --folder <parentNodeId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"wiki.list_wikiSpaces": {
"use_when": [
"1. 先确认知识库 ID(避免授权到「我的文档」)",
"1. 获取知识库 ID",
"列出我有权访问的组织知识库",
"列出钉盘企业空间",
"列出钉盘团队空间;列出钉盘空间",
"列出钉盘空间/钉盘团队空间",
"我的文档/个人空间",
"我的知识库/知识库列表/有哪些知识库",
"获取「我的文档」个人空间",
"获取钉盘「我的文件」"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“获取当前用户有权访问的知识库列表,支持按类型区分。”"
],
"examples": [
"dws wiki space list --format json # 组织知识库(默认)",
"dws wiki space list --type myWikiSpace --format json # 我的文档"
],
"interface_mode": "composite",
"availability": "available",
"interface_ref": null,
"interface_reason": "The CLI command routes by --type between wiki/list_wikiSpaces and drive/list_spaces, so the reviewed executable wrapper has no single direct MCP interface."
},
"wiki.node_copy": {
"use_when": [
"复制知识库里的文档",
"复制节点到另一个文件夹"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“将指定节点复制到目标文件夹。”所述变更时不要使用"
],
"examples": [
"dws wiki node copy --workspace <workspaceId> --node <nodeId> --format json",
"dws wiki node copy --workspace <workspaceId> --node <nodeId> --folder <targetFolderId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"wiki.node_move": {
"use_when": [
"移动知识库里的文档",
"移动节点到另一个文件夹"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“将指定节点移动到目标文件夹。”所述变更时不要使用"
],
"examples": [
"dws wiki node move --workspace <workspaceId> --node <nodeId> --folder <targetFolderId> --format json",
"dws wiki node move --workspace <workspaceId> --node <nodeId> --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"wiki.node_search": {
"use_when": [
"在指定知识库内搜索",
"在知识库里搜文档/空间内搜索",
"在知识库里搜方案;空间内搜索",
"按文件类型过滤"
],
"avoid_when": [
"搜一下有没有叫XX的文件;全局搜索"
],
"examples": [
"dws wiki node search --workspace <workspaceId> --query \"方案\" --format json",
"dws wiki node search --workspace <workspaceId> --query \"周报\" --limit 10 --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"wiki.remove_member": {
"use_when": [
"3. 移除成员",
"移除知识库成员/把某人从知识库移除/删除知识库成员"
],
"avoid_when": [
"用户未明确要求“从知识库中移除指定的企业用户成员(仅支持 USER 类型)。”、目标不清楚或尚未确认时不要使用"
],
"examples": [
"dws wiki member remove --workspace <WS_ID> --users uid1",
"dws wiki member remove --workspace <WS_ID> --users uid1,uid2"
],
"interface_mode": "mcp",
"availability": "available"
},
"wiki.search_wikiSpaces": {
"use_when": [
"搜索知识库",
"搜索知识库/找知识库"
],
"avoid_when": [
"需要创建、修改或删除数据时不要使用;本命令只用于“根据关键词搜索当前用户有权限访问的知识库列表。”"
],
"examples": [
"dws wiki space search --query \"产品文档\" --format json",
"dws wiki space search --query \"技术方案\" --limit 20 --format json"
],
"interface_mode": "mcp",
"availability": "available"
},
"wiki.update_member": {
"use_when": [
"修改某人在知识库的权限/调整成员角色"
],
"avoid_when": [
"仅需查询状态或预览结果、不应产生“修改成员在知识库中的角色。”所述变更时不要使用"
],
"examples": [
"dws wiki member update --workspace <WS_ID> --users uid1 --role EDITOR",
"dws wiki member update --workspace <WS_ID> --users uid1,uid2 --role READER"
],
"interface_mode": "mcp",
"availability": "available"
}
}
}