dingtalk-workspace-cli/internal/cli/schema_hints/catalog-completeness.json

{
  "version": 1,
  "source": {
    "kind": "explicit",
    "name": "dws-command-surface-review",
    "repository": "DingTalk-Real-AI/dingtalk-workspace-cli",
    "channel": "open-source"
  },
  "products": {
    "aisearch": {
      "agent_summary": "企业内智能搜人，支持按姓名、部门、职位、技能、职责、手机号或工号定位人员"
    },
    "dev": {
      "agent_summary": "管理钉钉开放平台应用、权限、版本、机器人、事件订阅与连接器",
      "use_when": [
        "开发或维护钉钉开放平台应用",
        "配置应用机器人、权限、成员、事件或发布版本"
      ],
      "avoid_when": [
        "只需要查询开放平台文档时优先使用 devdoc"
      ]
    },
    "devdoc": {
      "agent_summary": "搜索钉钉开放平台开发文档并辅助排查 API 调用错误",
      "use_when": [
        "搜索钉钉开放平台开发、API 或 OAuth2 接入文档",
        "排查开放平台 API 调用错误、错误码、requestId 或 traceId"
      ],
      "avoid_when": [
        "搜索用户自己的钉钉文档时使用 drive search 或 wiki node search"
      ]
    },
    "pat": {
      "agent_summary": "管理 DWS 操作所需的行为授权和浏览器授权策略",
      "use_when": [
        "命令提示缺少行为授权",
        "批量申请产品授权或配置授权浏览器策略"
      ],
      "avoid_when": [
        "普通 OAuth 登录使用 auth，而不是 pat"
      ]
    },
    "sheet": {
      "agent_summary": "管理钉钉在线电子表格、工作表、单元格、筛选视图和导出任务",
      "use_when": [
        "创建或管理钉钉在线电子表格和工作表",
        "读取、写入或格式化单元格区域",
        "管理筛选视图、图表、分组或导出任务"
      ],
      "avoid_when": [
        "需要多维表或 AI 表格能力时使用 aitable",
        "无法判断 alidocs 链接节点类型时先查询节点元数据"
      ]
    },
    "wiki": {
      "agent_summary": "管理钉钉知识库空间、节点、内容检索和知识库成员权限"
    }
  },
  "tools": {
    "aitable create": {
      "agent_summary": "创建 AI 表格（dws aitable base create 的别名）",
      "use_when": [
        "创建 AI 表格（dws aitable base create 的别名）"
      ],
      "reviewed": true
    },
    "chat message download-media": {
      "agent_summary": "下载聊天消息中的图片/视频/语音等资源到本地文件",
      "use_when": [
        "下载聊天消息中的图片/视频/语音等资源到本地文件"
      ],
      "reviewed": true
    },
    "chat message recall-by-bot": {
      "agent_summary": "机器人撤回消息（--group 群聊 / 不传为单聊）",
      "use_when": [
        "机器人撤回消息（--group 群聊 / 不传为单聊）"
      ],
      "reviewed": true,
      "effect": "destructive"
    },
    "chat message send-by-bot": {
      "agent_summary": "机器人发送消息（--group 群聊 / --users 单聊）",
      "use_when": [
        "机器人发送消息（--group 群聊 / --users 单聊）"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "chat message send": {
      "agent_summary": "以当前用户身份向群聊或单聊发送文本、Markdown、图片或本地文件",
      "use_when": [
        "发送普通群消息或单聊消息",
        "使用当前用户身份发送图片或本地文件"
      ],
      "avoid_when": [
        "引用回复已有消息时使用 chat message reply",
        "使用机器人身份发送时选择 send-by-bot 或 send-by-webhook"
      ],
      "tips": [
        "发送前确认目标和内容；文件消息使用 --msg-type file --file-path",
        "需要 24 小时内防重复投递时提供稳定的 --uuid"
      ],
      "reviewed": true,
      "effect": "write",
      "risk": "medium",
      "confirmation": "not_required",
      "idempotency": "unknown",
      "examples": [
        "dws chat message send --group <openConversationId> --text \"项目已发布\"",
        "dws chat message send --open-dingtalk-id <openDingTalkId> --msg-type file --file-path ./report.pdf"
      ]
    },
    "chat message reply": {
      "agent_summary": "以当前用户身份引用一条已有消息并回复",
      "use_when": [
        "需要保留被回复消息的引用关系"
      ],
      "avoid_when": [
        "不需要引用上下文的普通发送使用 chat message send"
      ],
      "prerequisites": [
        "已取得会话 ID、原消息 ID 和原消息发送者 openDingTalkId"
      ],
      "tips": [
        "发送前确认引用消息、接收会话和回复内容"
      ],
      "reviewed": true,
      "effect": "write",
      "risk": "medium",
      "confirmation": "not_required",
      "idempotency": "unknown",
      "examples": [
        "dws chat message reply --conversation-id <openConversationId> --ref-msg-id <openMessageId> --ref-sender <openDingTalkId> --text \"收到，马上处理\""
      ]
    },
    "dev app member add": {
      "agent_summary": "添加开放平台应用成员",
      "use_when": [
        "添加开放平台应用成员"
      ],
      "reviewed": true
    },
    "dev app permission add": {
      "agent_summary": "申请开放平台应用权限点",
      "use_when": [
        "申请开放平台应用权限点"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "dev connect status": {
      "agent_summary": "查看后台连接器守护进程状态（pid、运行时长、日志路径）",
      "use_when": [
        "查看后台连接器守护进程状态（pid、运行时长、日志路径）"
      ],
      "reviewed": true,
      "effect": "read"
    },
    "dev connect stop": {
      "agent_summary": "优雅停止后台连接器守护进程（释放单实例锁与 Stream 连接）",
      "use_when": [
        "优雅停止后台连接器守护进程（释放单实例锁与 Stream 连接）"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "dev app create": {
      "agent_summary": "创建开放平台企业内部应用",
      "use_when": [
        "创建开放平台企业内部应用"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "dev app version create": {
      "agent_summary": "基于当前配置创建应用新版本",
      "use_when": [
        "基于当前配置创建应用新版本"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "dev app delete": {
      "agent_summary": "删除开放平台企业内部应用（不可逆，需 --confirm-name 二次确认）",
      "use_when": [
        "删除开放平台企业内部应用（不可逆，需 --confirm-name 二次确认）"
      ],
      "reviewed": true,
      "effect": "destructive"
    },
    "dev app enable": {
      "agent_summary": "启用开放平台企业内部应用",
      "use_when": [
        "启用开放平台企业内部应用"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "dev app robot enable": {
      "agent_summary": "启用现有应用机器人能力（纯启用，无需配置字段）",
      "use_when": [
        "启用现有应用机器人能力（纯启用，无需配置字段）"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "dev app get": {
      "agent_summary": "查询开放平台企业内部应用详情",
      "use_when": [
        "查询开放平台企业内部应用详情"
      ],
      "reviewed": true,
      "effect": "read"
    },
    "dev app credentials get": {
      "agent_summary": "读取开放平台应用凭证",
      "use_when": [
        "读取开放平台应用凭证"
      ],
      "reviewed": true,
      "effect": "read"
    },
    "dev app version get": {
      "agent_summary": "查询指定版本详情",
      "use_when": [
        "查询指定版本详情"
      ],
      "reviewed": true
    },
    "dev app version status": {
      "agent_summary": "查询版本发布/审批状态",
      "use_when": [
        "查询版本发布/审批状态"
      ],
      "reviewed": true,
      "effect": "read"
    },
    "dev app robot get": {
      "agent_summary": "查询现有应用的机器人配置",
      "use_when": [
        "查询现有应用的机器人配置"
      ],
      "reviewed": true,
      "effect": "read"
    },
    "dev app webapp get": {
      "agent_summary": "查询网页应用配置",
      "use_when": [
        "查询网页应用配置"
      ],
      "reviewed": true
    },
    "dev app list": {
      "agent_summary": "查询开放平台企业内部应用列表",
      "use_when": [
        "查询开放平台企业内部应用列表"
      ],
      "reviewed": true,
      "effect": "read"
    },
    "dev app event list": {
      "agent_summary": "查询应用已订阅的事件列表",
      "use_when": [
        "查询应用已订阅的事件列表"
      ],
      "reviewed": true,
      "effect": "read"
    },
    "dev app member list": {
      "agent_summary": "查询开放平台应用成员",
      "use_when": [
        "查询开放平台应用成员"
      ],
      "reviewed": true
    },
    "dev app permission list": {
      "agent_summary": "查询开放平台应用权限列表",
      "use_when": [
        "查询开放平台应用权限列表"
      ],
      "reviewed": true,
      "effect": "read"
    },
    "dev app version list": {
      "agent_summary": "分页查询应用版本列表",
      "use_when": [
        "分页查询应用版本列表"
      ],
      "reviewed": true
    },
    "dev app version publish": {
      "agent_summary": "发布指定版本（含高敏权限需 --confirmed-sensitive）",
      "use_when": [
        "发布指定版本（含高敏权限需 --confirmed-sensitive）"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "dev app robot result": {
      "agent_summary": "查询机器人异步创建任务结果",
      "use_when": [
        "查询机器人异步创建任务结果"
      ],
      "reviewed": true,
      "effect": "read"
    },
    "dev doc search": {
      "agent_summary": "搜索开放平台文档",
      "use_when": [
        "搜索开放平台文档"
      ],
      "reviewed": true
    },
    "dev app robot config": {
      "agent_summary": "创建或更新现有应用的机器人配置（upsert）",
      "use_when": [
        "创建或更新现有应用的机器人配置（upsert）"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "dev app webapp config": {
      "agent_summary": "配置网页应用能力",
      "use_when": [
        "配置网页应用能力"
      ],
      "reviewed": true
    },
    "dev app robot submit": {
      "agent_summary": "异步提交钉钉智能体机器人创建任务（支持失败重试）",
      "use_when": [
        "异步提交钉钉智能体机器人创建任务（支持失败重试）"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "dev app event subscribe": {
      "agent_summary": "订阅应用事件回调",
      "use_when": [
        "订阅应用事件回调"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "dev app event unsubscribe": {
      "agent_summary": "取消订阅应用事件",
      "use_when": [
        "取消订阅应用事件"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "dev app update": {
      "agent_summary": "修改开放平台企业内部应用基础信息",
      "use_when": [
        "修改开放平台企业内部应用基础信息"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "dev app security config": {
      "agent_summary": "更新开放平台应用安全配置",
      "use_when": [
        "更新开放平台应用安全配置"
      ],
      "reviewed": true
    },
    "doc media insert": {
      "agent_summary": "上传本地文件并作为附件插入文档（3 步合一：prepare + PUT + insert）",
      "use_when": [
        "上传本地文件并作为附件插入文档（3 步合一：prepare + PUT + insert）"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "doc upload": {
      "agent_summary": "上传文件到钉钉文档或知识库",
      "use_when": [
        "上传文件到钉钉文档或知识库"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "drive upload": {
      "agent_summary": "上传本地文件到钉盘",
      "use_when": [
        "上传本地文件到钉盘"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "minutes record pause": {
      "agent_summary": "暂停听记录音",
      "use_when": [
        "暂停听记录音"
      ],
      "reviewed": true
    },
    "minutes record resume": {
      "agent_summary": "恢复听记录音",
      "use_when": [
        "恢复听记录音"
      ],
      "reviewed": true
    },
    "minutes record start": {
      "agent_summary": "发起听记 (开始录音)",
      "use_when": [
        "发起听记 (开始录音)"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "minutes record stop": {
      "agent_summary": "结束听记录音",
      "use_when": [
        "结束听记录音"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "pat browser-policy": {
      "agent_summary": "配置 PAT 授权时是否打开浏览器",
      "use_when": [
        "配置 PAT 授权时是否打开浏览器"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "sheet filter-view get-criteria": {
      "agent_summary": "查看筛选视图单列条件",
      "use_when": [
        "获取单列筛选条件"
      ],
      "reviewed": true,
      "effect": "read"
    },
    "sheet filter-view info": {
      "agent_summary": "查看单个筛选视图详情",
      "use_when": [
        "获取单个筛选视图详情"
      ],
      "reviewed": true,
      "effect": "read"
    },
    "sheet filter-view list-criteria": {
      "agent_summary": "列出筛选视图所有列条件",
      "use_when": [
        "列出筛选视图所有列条件"
      ],
      "reviewed": true,
      "effect": "read"
    },
    "sheet filter-view update-criteria": {
      "agent_summary": "更新筛选视图单列条件",
      "use_when": [
        "更新筛选视图列条件"
      ],
      "reviewed": true,
      "effect": "write"
    },
    "sheet media-upload": {
      "agent_summary": "上传附件到表格",
      "use_when": [
        "上传附件到表格"
      ],
      "reviewed": true
    }
  }
}