dingtalk-workspace-cli/internal/cli/schema_hints/selection/report.json

{
  "version": 1,
  "source": {
    "kind": "explicit",
    "name": "dws-agent-selection/report",
    "repository": "DingTalk-Real-AI/dingtalk-workspace-cli",
    "channel": "open-source",
    "reviewed": true
  },
  "tools": {
    "report.create_report": {
      "agent_summary": "按模版提交一份新日报",
      "use_when": [
        "已取得 templateId 与字段定义，需要按模版提交日报/周报（contents[].key 必须等于模板 field_name）时"
      ],
      "avoid_when": [
        "尚未读取模板字段时先用 dws report template list / template get",
        "只需查看已有日志正文时改用 dws report entry get"
      ],
      "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"
      ],
      "reviewed": true,
      "review_reason": "结合本机 dws schema 实时描述、Skill 与 Cobra 手写选型；pinned schema_mcp_metadata 仅对照。",
      "source_refs": [
        "CommandRegistry:canonical_path=report.create_report",
        "cobra-help:dws report entry submit",
        "Skill:skills/mono/references/products/report.md",
        "structured-hint:internal/cli/schema_hints/selection-review.json#report.create_report",
        "structured-hint:internal/cli/schema_hints/imported/wukong.json#report.create_report",
        "live-dws-schema:report.create_report"
      ]
    },
    "report.get_available_report_templates": {
      "agent_summary": "获取当前员工可使用的日志模版列表",
      "use_when": [
        "提交日志前需要列出可用模版名称与 templateId 时"
      ],
      "avoid_when": [
        "已知模版名称需要字段定义时改用 dws report template get"
      ],
      "examples": [
        "dws report template list",
        "dws report template list --format json"
      ],
      "reviewed": true,
      "review_reason": "结合本机 dws schema 实时描述、Skill 与 Cobra 手写选型；pinned schema_mcp_metadata 仅对照。",
      "source_refs": [
        "CommandRegistry:canonical_path=report.get_available_report_templates",
        "cobra-help:dws report template list",
        "Skill:skills/mono/references/products/report.md",
        "structured-hint:internal/cli/schema_hints/selection-review.json#report.get_available_report_templates",
        "structured-hint:internal/cli/schema_hints/imported/wukong.json#report.get_available_report_templates",
        "live-dws-schema:report.get_available_report_templates"
      ]
    },
    "report.get_received_report_list": {
      "agent_summary": "查询当前人收到的日志列表",
      "use_when": [
        "需要按时间范围查看别人发给我的日志列表并提取 reportId 时"
      ],
      "avoid_when": [
        "要看自己发出的日志时改用 dws report outbox list",
        "已知 reportId 要看正文时改用 dws report entry get"
      ],
      "examples": [
        "dws report inbox list --start \"2026-03-10T00:00:00+08:00\" --end \"2026-03-10T23:59:59+08:00\" --cursor 0 --size 20 --format json"
      ],
      "reviewed": true,
      "review_reason": "结合本机 dws schema 实时描述、Skill 与 Cobra 手写选型；pinned schema_mcp_metadata 仅对照。",
      "source_refs": [
        "CommandRegistry:canonical_path=report.get_received_report_list",
        "cobra-help:dws report inbox list",
        "Skill:skills/mono/references/products/report.md",
        "structured-hint:internal/cli/schema_hints/selection-review.json#report.get_received_report_list",
        "structured-hint:internal/cli/schema_hints/imported/wukong.json#report.get_received_report_list",
        "live-dws-schema:report.get_received_report_list"
      ]
    },
    "report.get_report_entry_details": {
      "agent_summary": "获取指定一篇日志的详情信息",
      "use_when": [
        "已知 reportId，需要读取日志正文、字段明细或钉钉跳转链接时"
      ],
      "avoid_when": [
        "要提交新日志时改用 dws report entry submit",
        "要看已读/评论统计时改用 dws report entry stats"
      ],
      "examples": [
        "dws report entry get --report-id <reportId> --format json",
        "dws report entry get --report-id <reportId>"
      ],
      "reviewed": true,
      "review_reason": "结合本机 dws schema 实时描述、Skill 与 Cobra 手写选型；pinned schema_mcp_metadata 仅对照。",
      "source_refs": [
        "CommandRegistry:canonical_path=report.get_report_entry_details",
        "cobra-help:dws report entry get",
        "Skill:skills/mono/references/products/report.md",
        "structured-hint:internal/cli/schema_hints/selection-review.json#report.get_report_entry_details",
        "structured-hint:internal/cli/schema_hints/imported/wukong.json#report.get_report_entry_details",
        "live-dws-schema:report.get_report_entry_details"
      ]
    },
    "report.get_report_statistics_by_id": {
      "agent_summary": "获取指定日志的统计数据",
      "use_when": [
        "已知 reportId，需要查看评论数、点赞数、已读数等统计时"
      ],
      "avoid_when": [
        "要读正文时改用 dws report entry get",
        "要提交新日志时改用 dws report entry submit"
      ],
      "examples": [
        "dws report entry stats --report-id <reportId>",
        "dws report entry stats --report-id <reportId> --format json"
      ],
      "reviewed": true,
      "review_reason": "结合本机 dws schema 实时描述、Skill 与 Cobra 手写选型；pinned schema_mcp_metadata 仅对照。",
      "source_refs": [
        "CommandRegistry:canonical_path=report.get_report_statistics_by_id",
        "cobra-help:dws report entry stats",
        "Skill:skills/mono/references/products/report.md",
        "structured-hint:internal/cli/schema_hints/selection-review.json#report.get_report_statistics_by_id",
        "structured-hint:internal/cli/schema_hints/imported/wukong.json#report.get_report_statistics_by_id",
        "live-dws-schema:report.get_report_statistics_by_id"
      ]
    },
    "report.get_send_report_list": {
      "agent_summary": "查询当前人创建的日志详情列表",
      "use_when": [
        "需要查看我发出/创建的日志列表（含内容摘要、创建时间、访问地址）时"
      ],
      "avoid_when": [
        "要看收到的日志时改用 dws report inbox list",
        "已知 reportId 要完整正文时改用 dws report entry get"
      ],
      "examples": [
        "dws report outbox list --cursor 0 --size 20 --format json",
        "dws report outbox list --cursor 0 --size 20"
      ],
      "reviewed": true,
      "review_reason": "结合本机 dws schema 实时描述、Skill 与 Cobra 手写选型；pinned schema_mcp_metadata 仅对照。",
      "source_refs": [
        "CommandRegistry:canonical_path=report.get_send_report_list",
        "cobra-help:dws report outbox list",
        "Skill:skills/mono/references/products/report.md",
        "structured-hint:internal/cli/schema_hints/selection-review.json#report.get_send_report_list",
        "structured-hint:internal/cli/schema_hints/imported/wukong.json#report.get_send_report_list",
        "live-dws-schema:report.get_send_report_list"
      ]
    },
    "report.get_template_details_by_name": {
      "agent_summary": "按名称获取日志模版字段定义",
      "use_when": [
        "已知模版名称，提交前需要读取字段名称、类型与排序时"
      ],
      "avoid_when": [
        "不知道有哪些模版时先用 dws report template list"
      ],
      "examples": [
        "dws report template get --name <templateName>",
        "dws report template get --name \"日报\" --format json"
      ],
      "reviewed": true,
      "review_reason": "结合本机 dws schema 实时描述、Skill 与 Cobra 手写选型；pinned schema_mcp_metadata 仅对照。",
      "source_refs": [
        "CommandRegistry:canonical_path=report.get_template_details_by_name",
        "cobra-help:dws report template get",
        "Skill:skills/mono/references/products/report.md",
        "structured-hint:internal/cli/schema_hints/selection-review.json#report.get_template_details_by_name",
        "structured-hint:internal/cli/schema_hints/imported/wukong.json#report.get_template_details_by_name",
        "live-dws-schema:report.get_template_details_by_name"
      ]
    }
  },
  "products": {
    "report": {
      "agent_summary": "查询日志模板、收发日志、日志正文与统计，并按模板提交日志",
      "use_when": [
        "查看或提交日报、周报等钉钉日志时"
      ],
      "avoid_when": [
        "不要用于待办任务、OA 审批或在线文档正文编辑"
      ],
      "reviewed": true,
      "review_reason": "依据真实 CommandRegistry 命令分区与对应产品 Skill 审阅产品级选择边界。",
      "source_refs": [
        "CommandRegistry:product=report",
        "Skill:skills/mono/references/products/report.md"
      ]
    }
  }
}