ylib-wecom-openclaw-plugin 2026.4.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (180) hide show
  1. package/README.md +596 -0
  2. package/dist/index.d.ts +10 -0
  3. package/dist/index.js +99 -0
  4. package/dist/src/accounts.d.ts +57 -0
  5. package/dist/src/accounts.js +247 -0
  6. package/dist/src/agent/api-client.d.ts +95 -0
  7. package/dist/src/agent/api-client.js +425 -0
  8. package/dist/src/agent/handler.d.ts +64 -0
  9. package/dist/src/agent/handler.js +731 -0
  10. package/dist/src/agent/index.d.ts +5 -0
  11. package/dist/src/agent/index.js +21 -0
  12. package/dist/src/agent/webhook.d.ts +25 -0
  13. package/dist/src/agent/webhook.js +294 -0
  14. package/dist/src/agent/xml.d.ts +21 -0
  15. package/dist/src/agent/xml.js +43 -0
  16. package/dist/src/channel.d.ts +5 -0
  17. package/dist/src/channel.js +815 -0
  18. package/dist/src/chat-queue.d.ts +31 -0
  19. package/dist/src/chat-queue.js +53 -0
  20. package/dist/src/config-schema.d.ts +587 -0
  21. package/dist/src/config-schema.js +146 -0
  22. package/dist/src/const.d.ts +128 -0
  23. package/dist/src/const.js +168 -0
  24. package/dist/src/dm-policy.d.ts +29 -0
  25. package/dist/src/dm-policy.js +146 -0
  26. package/dist/src/dynamic-agent.d.ts +37 -0
  27. package/dist/src/dynamic-agent.js +67 -0
  28. package/dist/src/dynamic-routing.d.ts +65 -0
  29. package/dist/src/dynamic-routing.js +62 -0
  30. package/dist/src/endpoint-dispatch.d.ts +54 -0
  31. package/dist/src/endpoint-dispatch.js +967 -0
  32. package/dist/src/endpoint-event-adapter.d.ts +15 -0
  33. package/dist/src/endpoint-event-adapter.js +427 -0
  34. package/dist/src/group-policy.d.ts +30 -0
  35. package/dist/src/group-policy.js +126 -0
  36. package/dist/src/http.d.ts +27 -0
  37. package/dist/src/http.js +168 -0
  38. package/dist/src/im-runtime-telemetry.d.ts +25 -0
  39. package/dist/src/im-runtime-telemetry.js +68 -0
  40. package/dist/src/interface.d.ts +192 -0
  41. package/dist/src/interface.js +5 -0
  42. package/dist/src/markdown-chunk.d.ts +1 -0
  43. package/dist/src/markdown-chunk.js +396 -0
  44. package/dist/src/mcp/index.d.ts +6 -0
  45. package/dist/src/mcp/index.js +28 -0
  46. package/dist/src/mcp/interceptors/biz-error.d.ts +11 -0
  47. package/dist/src/mcp/interceptors/biz-error.js +73 -0
  48. package/dist/src/mcp/interceptors/doc-auth-error.d.ts +10 -0
  49. package/dist/src/mcp/interceptors/doc-auth-error.js +235 -0
  50. package/dist/src/mcp/interceptors/index.d.ts +35 -0
  51. package/dist/src/mcp/interceptors/index.js +143 -0
  52. package/dist/src/mcp/interceptors/msg-media.d.ts +11 -0
  53. package/dist/src/mcp/interceptors/msg-media.js +201 -0
  54. package/dist/src/mcp/interceptors/smartpage-create.d.ts +30 -0
  55. package/dist/src/mcp/interceptors/smartpage-create.js +252 -0
  56. package/dist/src/mcp/interceptors/smartpage-export.d.ts +17 -0
  57. package/dist/src/mcp/interceptors/smartpage-export.js +135 -0
  58. package/dist/src/mcp/interceptors/smartsheet-upload.d.ts +22 -0
  59. package/dist/src/mcp/interceptors/smartsheet-upload.js +388 -0
  60. package/dist/src/mcp/interceptors/types.d.ts +64 -0
  61. package/dist/src/mcp/interceptors/types.js +8 -0
  62. package/dist/src/mcp/schema.d.ts +11 -0
  63. package/dist/src/mcp/schema.js +115 -0
  64. package/dist/src/mcp/tool.d.ts +63 -0
  65. package/dist/src/mcp/tool.js +318 -0
  66. package/dist/src/mcp/transport.d.ts +94 -0
  67. package/dist/src/mcp/transport.js +702 -0
  68. package/dist/src/media-handler.d.ts +55 -0
  69. package/dist/src/media-handler.js +306 -0
  70. package/dist/src/media-uploader.d.ts +142 -0
  71. package/dist/src/media-uploader.js +446 -0
  72. package/dist/src/message-parser.d.ts +104 -0
  73. package/dist/src/message-parser.js +232 -0
  74. package/dist/src/message-sender.d.ts +54 -0
  75. package/dist/src/message-sender.js +210 -0
  76. package/dist/src/monitor.d.ts +69 -0
  77. package/dist/src/monitor.js +1846 -0
  78. package/dist/src/onboarding.d.ts +8 -0
  79. package/dist/src/onboarding.js +248 -0
  80. package/dist/src/openclaw-compat.d.ts +148 -0
  81. package/dist/src/openclaw-compat.js +839 -0
  82. package/dist/src/proactive-markdown-send.d.ts +14 -0
  83. package/dist/src/proactive-markdown-send.js +205 -0
  84. package/dist/src/reqid-store.d.ts +23 -0
  85. package/dist/src/reqid-store.js +136 -0
  86. package/dist/src/runtime.d.ts +2 -0
  87. package/dist/src/runtime.js +7 -0
  88. package/dist/src/shared/command-auth.d.ts +23 -0
  89. package/dist/src/shared/command-auth.js +112 -0
  90. package/dist/src/shared/xml-parser.d.ts +46 -0
  91. package/dist/src/shared/xml-parser.js +228 -0
  92. package/dist/src/state-dir-resolve.d.ts +2 -0
  93. package/dist/src/state-dir-resolve.js +33 -0
  94. package/dist/src/state-manager.d.ts +115 -0
  95. package/dist/src/state-manager.js +413 -0
  96. package/dist/src/target.d.ts +35 -0
  97. package/dist/src/target.js +71 -0
  98. package/dist/src/template-card-manager.d.ts +55 -0
  99. package/dist/src/template-card-manager.js +316 -0
  100. package/dist/src/template-card-parser.d.ts +37 -0
  101. package/dist/src/template-card-parser.js +672 -0
  102. package/dist/src/timeout.d.ts +20 -0
  103. package/dist/src/timeout.js +57 -0
  104. package/dist/src/types/account.d.ts +29 -0
  105. package/dist/src/types/account.js +5 -0
  106. package/dist/src/types/config.d.ts +98 -0
  107. package/dist/src/types/config.js +8 -0
  108. package/dist/src/types/constants.d.ts +42 -0
  109. package/dist/src/types/constants.js +45 -0
  110. package/dist/src/types/index.d.ts +7 -0
  111. package/dist/src/types/index.js +17 -0
  112. package/dist/src/types/message.d.ts +238 -0
  113. package/dist/src/types/message.js +6 -0
  114. package/dist/src/utils.d.ts +148 -0
  115. package/dist/src/utils.js +92 -0
  116. package/dist/src/version.d.ts +2 -0
  117. package/dist/src/version.js +28 -0
  118. package/dist/src/webhook/command-auth.d.ts +47 -0
  119. package/dist/src/webhook/command-auth.js +137 -0
  120. package/dist/src/webhook/gateway.d.ts +36 -0
  121. package/dist/src/webhook/gateway.js +297 -0
  122. package/dist/src/webhook/handler.d.ts +19 -0
  123. package/dist/src/webhook/handler.js +481 -0
  124. package/dist/src/webhook/helpers.d.ts +157 -0
  125. package/dist/src/webhook/helpers.js +936 -0
  126. package/dist/src/webhook/http.d.ts +27 -0
  127. package/dist/src/webhook/http.js +168 -0
  128. package/dist/src/webhook/index.d.ts +11 -0
  129. package/dist/src/webhook/index.js +43 -0
  130. package/dist/src/webhook/media.d.ts +30 -0
  131. package/dist/src/webhook/media.js +152 -0
  132. package/dist/src/webhook/monitor.d.ts +59 -0
  133. package/dist/src/webhook/monitor.js +1672 -0
  134. package/dist/src/webhook/state.d.ts +220 -0
  135. package/dist/src/webhook/state.js +568 -0
  136. package/dist/src/webhook/target.d.ts +41 -0
  137. package/dist/src/webhook/target.js +165 -0
  138. package/dist/src/webhook/types.d.ts +348 -0
  139. package/dist/src/webhook/types.js +36 -0
  140. package/dist/src/webhook/video-frame.d.ts +13 -0
  141. package/dist/src/webhook/video-frame.js +108 -0
  142. package/openclaw.plugin.json +19 -0
  143. package/package.json +96 -0
  144. package/schema.json +534 -0
  145. package/scripts/generate-schema.mjs +33 -0
  146. package/skills/wecom-contact/SKILL.md +162 -0
  147. package/skills/wecom-doc/SKILL.md +162 -0
  148. package/skills/wecom-doc/references/create-doc.md +56 -0
  149. package/skills/wecom-doc/references/edit-doc-content.md +68 -0
  150. package/skills/wecom-doc/references/get-doc-content.md +88 -0
  151. package/skills/wecom-doc/references/smartpage-create.md +125 -0
  152. package/skills/wecom-doc/references/smartpage-export.md +160 -0
  153. package/skills/wecom-meeting/SKILL.md +441 -0
  154. package/skills/wecom-meeting/references/example-full.md +30 -0
  155. package/skills/wecom-meeting/references/example-reminder.md +46 -0
  156. package/skills/wecom-meeting/references/example-security.md +22 -0
  157. package/skills/wecom-meeting/references/response-get-meeting-info.md +148 -0
  158. package/skills/wecom-msg/SKILL.md +157 -0
  159. package/skills/wecom-msg/references/api-get-messages.md +93 -0
  160. package/skills/wecom-msg/references/api-get-msg-chat-list.md +58 -0
  161. package/skills/wecom-msg/references/api-get-msg-media.md +44 -0
  162. package/skills/wecom-msg/references/api-send-message.md +39 -0
  163. package/skills/wecom-preflight/SKILL.md +141 -0
  164. package/skills/wecom-schedule/SKILL.md +161 -0
  165. package/skills/wecom-schedule/references/api-check-availability.md +56 -0
  166. package/skills/wecom-schedule/references/api-create-schedule.md +38 -0
  167. package/skills/wecom-schedule/references/api-get-schedule-detail.md +81 -0
  168. package/skills/wecom-schedule/references/api-update-schedule.md +32 -0
  169. package/skills/wecom-schedule/references/ref-reminders.md +24 -0
  170. package/skills/wecom-send-media/SKILL.md +68 -0
  171. package/skills/wecom-send-template-card/SKILL.md +157 -0
  172. package/skills/wecom-send-template-card/references/api-template-card-types.md +358 -0
  173. package/skills/wecom-smartsheet/SKILL.md +164 -0
  174. package/skills/wecom-smartsheet/references/smartsheet-cell-value-formats.md +163 -0
  175. package/skills/wecom-smartsheet/references/smartsheet-field-types.md +44 -0
  176. package/skills/wecom-smartsheet/references/smartsheet-get-records.md +96 -0
  177. package/skills/wecom-smartsheet/references/webhook-examples.md +185 -0
  178. package/skills/wecom-smartsheet/references/webhook-fallback.md +184 -0
  179. package/skills/wecom-todo/SKILL.md +392 -0
  180. package/skills/wecom-todo/examples/workflows.md +163 -0
@@ -0,0 +1,184 @@
1
+ # 智能表格 Webhook 兜底写入
2
+
3
+ > 本文档是 `smartsheet_add_records` / `smartsheet_update_records` 的 **fallback 参考**。
4
+ > 当通过 `wecom_mcp` tool 调用因企业规模限制(可见范围 > 10 人)报错、无法写入智能表格时,切换到本方案,通过企业微信智能表格的 Webhook 接口直接写入数据。
5
+ >
6
+ > ⚠️ **格式隔离**:以下字段值格式仅适用于 Webhook 接口,与 `wecom_mcp` tool 侧 `smartsheet_add_records` / `smartsheet_update_records` 的参数结构**不同**(例如文本、URL、图片、日期的写法均有差异),请勿与 [cell-value-formats.md](cell-value-formats.md) 的格式混用。
7
+
8
+ ---
9
+
10
+ ## 一、Fallback 触发流程
11
+
12
+ ### 何时切换到 Webhook
13
+
14
+ 先走 `wecom_mcp` tool 正常链路(`smartsheet_add_records` / `smartsheet_update_records`)。仅在出现以下情况时才切换到 Webhook:
15
+
16
+ - **优先判据**:返回 `errcode: 851003`,或 `errmsg` 包含 `no authority` —— 这通常意味着企业可见范围 > 10 人,写入接口被限制
17
+ - 或 `errmsg` / 提示信息明显指向**企业规模 / 可见范围超限**(例如“超出可见范围”、“成员数超限”等相关描述)
18
+ - 其他错误(参数错误、字段 ID 错误、文档不存在等)**不应**切换到 Webhook,应按原错误排查
19
+
20
+ ### 切换时向用户索取的两样东西
21
+
22
+ 切换触发后,**每次对话内临时获取,用完即弃,不保存到本地任何位置**:
23
+
24
+ 1. **Webhook 完整 URL**
25
+ - 在智能表格右上角菜单 → 「接收外部数据」→ 选择目标工作表 → 开启 → 复制
26
+ - 格式形如 `https://qyapi.weixin.qq.com/cgi-bin/wedoc/smartsheet/webhook?key=XXXXXX`
27
+ - 该 URL 相当于该表的写入密钥,用户随时可以在智能表格里关闭「接收外部数据」使其失效
28
+ 2. **schema 示例 JSON**
29
+ - 同一「接收外部数据」页面即可复制
30
+ - 包含字段 ID → 字段名的映射(`schema`)和各字段的写入格式示例(`add_records`)
31
+
32
+ 示例:
33
+
34
+ ```json
35
+ {
36
+ "schema": {
37
+ "fABCD1": "任务名称",
38
+ "fABCD2": "状态",
39
+ "fABCD3": "负责人",
40
+ "fABCD4": "截止日期"
41
+ },
42
+ "add_records": [
43
+ {
44
+ "values": {
45
+ "fABCD1": "示例任务",
46
+ "fABCD2": [{"text": "未开始"}],
47
+ "fABCD3": [{"user_id": ""}],
48
+ "fABCD4": "1742400000000"
49
+ }
50
+ }
51
+ ]
52
+ }
53
+ ```
54
+
55
+ ### 向用户告知的话术参考
56
+
57
+ - “通过 `wecom_mcp` 写入接口返回了 `851003 no authority`(通常是企业可见范围 > 10 人的限制)。请把目标表的 Webhook 地址和「接收外部数据」页面的示例 JSON 发我,我帮你通过 Webhook 写入。该信息仅本轮使用,不会保存到本地。”
58
+
59
+ ---
60
+
61
+ ## 二、构建请求
62
+
63
+ ### 字段匹配
64
+
65
+ 用户描述通常是自然语言(“标题”“状态”“处理人”),需从用户提供的 `schema` 中找对应字段 ID:
66
+
67
+ - 模糊匹配:`标题` → 标题 / 名称 / 主题;`状态` → 状态 / 阶段;`处理人` → 负责人 / 责任人
68
+ - 不确定时先问用户确认,避免写错字段
69
+
70
+ 各字段类型的值写法见下方 [字段类型格式规范](#三字段类型格式规范);真实场景示例见 [webhook-examples.md](webhook-examples.md)。
71
+
72
+ ### 日期处理
73
+
74
+ 用户说“今天”“明天”“3 月 15 日”“2025-03-01 09:00”等自然语言日期时,**在 payload 构造阶段**根据当前日期推算为**毫秒时间戳字符串**(如 `"1742400000000"`)。Webhook 侧**不接受**可读日期字符串。
75
+
76
+ ### 请求结构
77
+
78
+ Webhook 是标准 HTTP 接口,不经过 `wecom_mcp`,请按执行环境选择合适的工具发送(`curl`、`node` 内置 `fetch`、`python` 的 `requests` / `urllib` 等均可,优先用当前环境最便捷的方式):
79
+
80
+ | 项 | 值 |
81
+ |---|---|
82
+ | Method | `POST` |
83
+ | URL | 用户提供的 Webhook 完整 URL(含 `?key=XXX`) |
84
+ | Header | `Content-Type: application/json` |
85
+ | Body | JSON 对象,包含 `add_records` 和/或 `update_records` 字段 |
86
+
87
+ ### Body 结构
88
+
89
+ - 仅新增:
90
+
91
+ ```json
92
+ {
93
+ "add_records": [
94
+ { "values": { "fABCD1": "...", "fABCD2": [{"text": "..."}] } }
95
+ ]
96
+ }
97
+ ```
98
+
99
+ - 仅更新(需提供 `record_id`,且**只能更新通过 Webhook 写入的记录**,人工创建的记录无法更新):
100
+
101
+ ```json
102
+ {
103
+ "update_records": [
104
+ { "record_id": "REC_xxx", "values": { "fABCD2": [{"text": "已完成"}] } }
105
+ ]
106
+ }
107
+ ```
108
+
109
+ - 同一请求同时新增和更新:
110
+
111
+ ```json
112
+ {
113
+ "add_records": [ { "values": { ... } } ],
114
+ "update_records": [ { "record_id": "REC_xxx", "values": { ... } } ]
115
+ }
116
+ ```
117
+
118
+ ### 成功后
119
+
120
+ 简洁告知结果,例如:
121
+
122
+ > “已通过 Webhook 写入,record_id: `REC_xxx`”
123
+
124
+ 返回非 0 `errcode` 时参考下方 [常见错误码](#六常见错误码)。
125
+
126
+ ---
127
+
128
+ ## 三、字段类型格式规范
129
+
130
+ ### 各类型写法
131
+
132
+ | 字段类型 | value 示例 | 说明 |
133
+ |---------|-----------|------|
134
+ | 文本 | `"产品登录页白屏"` 或 `[{"type":"text","text":"产品登录页白屏"}]` | 简单字符串更简洁 |
135
+ | 数字 / 货币 | `58000` | double,不要加引号 |
136
+ | 进度 / 百分数 | `30` | 传整数值,`30` = 30%;**不要传小数** `0.3`(那样会显示 0.3%) |
137
+ | 复选框 | `true` / `false` | bool |
138
+ | 日期 | `"1740806400000"` | 毫秒时间戳,字符串形式 |
139
+ | 成员 | `[{"user_id":"lisi"}]` 或 `["张三"]` 或 `[]` | userid 通常就是企业微信登录账号;不指定时传 `[]` |
140
+ | 单选 | `[{"text":"已完成"}]` | 数组,选项文本必须与表格预设完全一致 |
141
+ | 多选 | `[{"text":"前端"},{"text":"后端"}]` | 数组,每个选项一个对象 |
142
+ | 链接 | `[{"text":"需求文档","link":"https://doc.example.com"}]` | 数组 |
143
+ | 地理位置 | `[{"latitude":"31.23040","longitude":"121.47370","source_type":1,"title":"上海市徐汇区"}]` | 数组,最多 1 条 |
144
+ | 图片 | `[{"title":"screenshot.png","image_base64":"iVBORw0KGgo..."}]` | 纯 base64,**不要带 `data:image/...;base64,` 前缀**,否则报 errcode 2023033 |
145
+ | 电话 / 邮箱 / 条码 | `"13800138000"` | 字符串 |
146
+
147
+ ---
148
+
149
+ ## 四、不支持的字段
150
+
151
+ 以下字段由系统自动维护或结构特殊,Webhook 写入时**跳过即可,不要报错**:
152
+
153
+ 公式、自动编号、查找引用、关联字段、创建人、最后编辑人、创建时间、最后编辑时间、群聊、文件附件。
154
+
155
+ ---
156
+
157
+ ## 五、频率限制
158
+
159
+ - 单工作表:≤ 3000 条/分钟
160
+ - 单文档:≤ 10000 条/分钟
161
+
162
+ 数据量大时建议分批,每批不超过 500 条。
163
+
164
+ ---
165
+
166
+ ## 六、常见错误码
167
+
168
+ | errcode | 原因 | 解决方法 |
169
+ |---------|------|---------|
170
+ | 2023033 | 图片 base64 携带了 `data:image/...;base64,` 前缀 | 去掉前缀,只传纯 base64 字符串 |
171
+ | 40014 | Webhook key 无效或已过期 | 请用户重新在智能表格「接收外部数据」获取 Webhook 地址 |
172
+ | 45033 | 超出频率限制 | 降低发送速率或分批发送 |
173
+ | -100035 | testapi 域名不稳定(超时) | 改用正式域名 `qyapi.weixin.qq.com` |
174
+ | 2023001 | 字段 ID 不存在 | 核对用户提供的 `schema`,确认字段 ID 拼写正确 |
175
+ | 2023010 | 单选/多选的选项值不在预设列表 | 确认选项文本与表格设置完全一致(区分大小写) |
176
+ | 2023012 | record_id 不存在(更新时) | 只能更新通过 Webhook 写入的记录,人工创建的记录无法更新 |
177
+
178
+ ---
179
+
180
+ ## 七、参考文件
181
+
182
+ - 真实场景示例 → [webhook-examples.md](webhook-examples.md)
183
+
184
+ 按需查阅,不用每次全读。
@@ -0,0 +1,392 @@
1
+ ---
2
+ name: wecom-todo
3
+ description: 企业微信待办事项管理技能,支持查询待办列表、获取待办详情、创建待办、更新待办、删除待办及变更用户处理进度状态。在用户说"看看我的待办列表"、"我有哪些待办"、"帮我创建一个待办"、"把这个任务分派给张三"、"标记待办完成"、"删掉那个待办"、"帮我建个提醒"、"更新一下待办内容"、"把提醒时间改到下周"、"接受这个待办"、"拒绝这个待办"、"这个待办的详情"、"待办分派给谁了"等需要对待办进行读写操作的场景时使用。
4
+ ---
5
+
6
+ # 企业微信待办事项管理技能
7
+
8
+ > `wecom_mcp` 是一个 MCP tool,所有操作通过调用该 tool 完成。
9
+
10
+ > ⚠️ **前置条件**:首次调用 `wecom_mcp` 前,必须按 `wecom-preflight` 技能执行前置条件检查,确保工具已加入白名单。
11
+
12
+ ## 概述
13
+
14
+ wecom-todo 提供企业微信待办事项的完整管理能力,包含以下功能:
15
+
16
+ 1. **查询待办列表** - 按创建时间和提醒时间过滤,支持分页,返回待办概要信息
17
+ 2. **获取待办详情** - 根据待办 ID 列表批量获取完整信息(含内容和分派人)
18
+ 3. **创建待办** - 创建新的待办事项,可指定内容、分派人和提醒时间
19
+ 4. **更新待办** - 修改已有待办的内容、分派人、状态或提醒时间
20
+ 5. **删除待办** - 删除指定的待办事项
21
+ 6. **变更用户待办状态** - 更改当前用户在某个待办中的状态(拒绝/接受/已完成)
22
+
23
+ ## 命令调用方式
24
+
25
+ 使用 `wecom_mcp` tool 调用 `wecom_mcp call todo <tool_name> '<json格式的入参>'`
26
+
27
+ ## 行为策略
28
+
29
+ **查完列表必须查详情**: `get_todo_list` 只返回待办 ID 和状态等概要信息,不包含待办的实际内容和分派人。对用户来说,没有内容的待办列表毫无用处——他们想知道的是"要做什么",而不是一串 ID。因此,每次调用 `get_todo_list` 拿到结果后,都要紧接着用返回的 todo_id 列表调用 `get_todo_detail` 获取完整详情(内容、分派人等),然后再向用户展示。这不是可选步骤,而是完成用户请求的必要环节。
30
+
31
+ **人员 ID 转姓名(关键步骤)**: `get_todo_detail` 返回结果中的 `follower_id` 和 `creator_id` 都是系统内部 ID,直接展示给用户毫无意义——用户不认识这些 ID,只认识姓名。因此在向用户展示待办详情之前,必须先调用 `wecom-contact` 技能获取通讯录,将所有 `follower_id` 和 `creator_id` 匹配为真实姓名。具体做法:
32
+
33
+ 使用 `wecom_mcp` tool 调用 `wecom_mcp call contact get_userlist '{}'` 获取通讯录,在返回的 userlist 中,用 userid 字段匹配 follower_id / creator_id,取对应的 name。
34
+
35
+ 如果通讯录中找不到某个 ID,展示时标注"未知用户(ID: xxx)"即可。
36
+
37
+ **分页未拉完时必须提醒用户**: `get_todo_list` 接口是分页的,不要求一次性拉完所有数据。但如果响应中 `has_more` 为 `true`,说明后面还有待办没有返回——这时你在展示当前结果的同时,必须明确告诉用户"还有更多待办未显示,是否需要继续查看?"。用户可能不知道后面还有数据,如果你不说,他们会以为看到的就是全部,这会导致遗漏重要待办。这是一个容易被忽略但后果严重的点,请务必执行。
38
+
39
+ **重试策略**: 遭遇"返回 HTTP 错误"或"HTTP 请求失败"时,主动重试,最多重试三次。
40
+
41
+ ---
42
+
43
+ ## 命令详细说明
44
+
45
+ ### 1. 查询待办列表 (get_todo_list)
46
+
47
+ 查询当前用户的待办列表,支持按时间过滤和分页。返回的是待办概要信息(不含内容和分派人)。
48
+
49
+ #### 调用方式
50
+
51
+ 使用 `wecom_mcp` tool 调用 `wecom_mcp call todo get_todo_list '<json格式的入参>'`
52
+
53
+ #### 入参说明
54
+
55
+ | 参数 | 类型 | 必填 | 说明 |
56
+ |------|------|------|------|
57
+ | `create_begin_time` | string | ❌ | 创建开始时间,格式:`YYYY-MM-DD HH:mm:ss` |
58
+ | `create_end_time` | string | ❌ | 创建结束时间,格式:`YYYY-MM-DD HH:mm:ss` |
59
+ | `remind_begin_time` | string | ❌ | 提醒开始时间,格式:`YYYY-MM-DD HH:mm:ss` |
60
+ | `remind_end_time` | string | ❌ | 提醒结束时间,格式:`YYYY-MM-DD HH:mm:ss` |
61
+ | `limit` | number | ❌ | 最大返回数量,默认 10,最大 20 |
62
+ | `cursor` | string | ❌ | 分页游标,首次请求不传,后续传入上次响应的 `next_cursor` |
63
+
64
+ #### 返回格式
65
+
66
+ ```json
67
+ {
68
+ "errcode": 0,
69
+ "errmsg": "ok",
70
+ "index_list": [
71
+ {
72
+ "todo_id": "TODO_ID",
73
+ "todo_status": 1,
74
+ "user_status": 1,
75
+ "creator_id": "CREATOR_ID",
76
+ "remind_time": "2025-06-01 09:00:00",
77
+ "create_time": "2025-01-15 10:30:00",
78
+ "update_time": "2025-01-16 14:20:00"
79
+ }
80
+ ],
81
+ "next_cursor": "NEXT_CURSOR",
82
+ "has_more": false
83
+ }
84
+ ```
85
+
86
+ #### 返回字段说明
87
+
88
+ | 字段 | 类型 | 说明 |
89
+ |------|------|------|
90
+ | `index_list` | array | 待办列表 |
91
+ | `index_list[].todo_id` | string | 待办唯一 ID |
92
+ | `index_list[].todo_status` | number | 待办状态:`0`-已完成,`1`-进行中,`2`-已删除 |
93
+ | `index_list[].user_status` | number | 用户状态:`0`-拒绝,`1`-接受,`2`-已完成 |
94
+ | `index_list[].creator_id` | string | 创建人 ID |
95
+ | `index_list[].remind_time` | string | 提醒时间 |
96
+ | `index_list[].create_time` | string | 创建时间 |
97
+ | `index_list[].update_time` | string | 更新时间 |
98
+ | `next_cursor` | string | 下一页游标 |
99
+ | `has_more` | boolean | 是否还有更多记录 |
100
+
101
+ > 列表返回的是待办概要信息(不含内容和分派人)。拿到列表后,必须调用 `get_todo_detail` 获取完整详情再展示给用户。
102
+
103
+ ---
104
+
105
+ ### 2. 获取待办详情 (get_todo_detail)
106
+
107
+ 根据待办 ID 列表批量查询完整详情,包含待办内容和分派人信息。
108
+
109
+ #### 调用方式
110
+
111
+ 使用 `wecom_mcp` tool 调用 `wecom_mcp call todo get_todo_detail '<json格式的入参>'`
112
+
113
+ #### 入参说明
114
+
115
+ | 参数 | 类型 | 必填 | 说明 |
116
+ |------|------|------|------|
117
+ | `todo_id_list` | array | ✅ | 待办 ID 列表,最多 20 个 |
118
+
119
+ #### 调用示例
120
+
121
+ 使用 `wecom_mcp` tool 调用 `wecom_mcp call todo get_todo_detail '{"todo_id_list": ["TODO_ID_1", "TODO_ID_2"]}'`
122
+
123
+ #### 返回格式
124
+
125
+ ```json
126
+ {
127
+ "errcode": 0,
128
+ "errmsg": "ok",
129
+ "data_list": [
130
+ {
131
+ "todo_id": "TODO_ID",
132
+ "todo_status": 1,
133
+ "content": "完成Q2规划文档",
134
+ "follower_list": {
135
+ "followers": [
136
+ {
137
+ "follower_id": "FOLLOWER_ID",
138
+ "follower_status": 1,
139
+ "update_time": "2025-01-16 14:20:00"
140
+ }
141
+ ]
142
+ },
143
+ "creator_id": "CREATOR_ID",
144
+ "user_status": 1,
145
+ "remind_time": "2025-06-01 09:00:00",
146
+ "create_time": "2025-01-15 10:30:00",
147
+ "update_time": "2025-01-16 14:20:00"
148
+ }
149
+ ]
150
+ }
151
+ ```
152
+
153
+ #### 返回字段说明
154
+
155
+ | 字段 | 类型 | 说明 |
156
+ |------|------|------|
157
+ | `data_list` | array | 待办详情列表,最多 20 条 |
158
+ | `data_list[].todo_id` | string | 待办 ID |
159
+ | `data_list[].todo_status` | number | 待办状态:`0`-已完成,`1`-进行中,`2`-已删除 |
160
+ | `data_list[].content` | string | 待办内容 |
161
+ | `data_list[].follower_list.followers` | array | 分派人列表 |
162
+ | `data_list[].follower_list.followers[].follower_id` | string | 分派人 ID(即 userid)— **展示前需通过 wecom-contact 转为姓名** |
163
+ | `data_list[].follower_list.followers[].follower_status` | number | 分派人状态:`0`-拒绝,`1`-接受,`2`-已完成 |
164
+ | `data_list[].follower_list.followers[].update_time` | string | 分派人状态更新时间 |
165
+ | `data_list[].creator_id` | string | 创建人 ID — **展示前需通过 wecom-contact 转为姓名** |
166
+ | `data_list[].user_status` | number | 当前用户状态 |
167
+ | `data_list[].remind_time` | string | 提醒时间 |
168
+ | `data_list[].create_time` | string | 创建时间 |
169
+ | `data_list[].update_time` | string | 更新时间 |
170
+
171
+ ---
172
+
173
+ ### 3. 创建待办 (create_todo)
174
+
175
+ 创建一个新的待办事项,可指定内容、分派人和提醒时间。
176
+
177
+ #### 调用方式
178
+
179
+ 使用 `wecom_mcp` tool 调用 `wecom_mcp call todo create_todo '<json格式的入参>'`
180
+
181
+ #### 入参说明
182
+
183
+ | 参数 | 类型 | 必填 | 说明 |
184
+ |------|------|------|------|
185
+ | `content` | string | ✅ | 待办内容 |
186
+ | `follower_list` | object | ❌ | 分派人列表,格式见注意事项第 6 条 |
187
+ | `remind_time` | string | ❌ | 提醒时间,格式:`YYYY-MM-DD HH:mm:ss` |
188
+
189
+ #### 调用示例
190
+
191
+ 使用 `wecom_mcp` tool 调用 `wecom_mcp call todo create_todo '{"content": "<待办的内容>", "remind_time": "2025-06-01 09:00:00"}'`
192
+
193
+ #### 返回格式
194
+
195
+ ```json
196
+ {
197
+ "errcode": 0,
198
+ "errmsg": "ok",
199
+ "todo_id": "TODO_ID"
200
+ }
201
+ ```
202
+
203
+ #### 返回字段说明
204
+
205
+ | 字段 | 类型 | 说明 |
206
+ |------|------|------|
207
+ | `todo_id` | string | 新创建的待办唯一 ID |
208
+
209
+ ---
210
+
211
+ ### 4. 更新待办 (update_todo)
212
+
213
+ 修改已有待办事项的内容、分派人、状态或提醒时间。
214
+
215
+ #### 调用方式
216
+
217
+ 使用 `wecom_mcp` tool 调用 `wecom_mcp call todo update_todo '<json格式的入参>'`
218
+
219
+ #### 入参说明
220
+
221
+ | 参数 | 类型 | 必填 | 说明 |
222
+ |------|------|------|------|
223
+ | `todo_id` | string | ✅ | 待办 ID |
224
+ | `content` | string | ❌ | 新的待办内容 |
225
+ | `follower_list` | object | ❌ | 新的分派人列表(全量替换,非追加),格式见注意事项第 6 条。若要新增分派人,需先查出现有分派人,合并后一起提交 |
226
+ | `todo_status` | number | ❌ | 新的待办状态:`0`-已完成,`1`-进行中,`2`-已删除。删除请使用 `delete_todo` |
227
+ | `remind_time` | string | ❌ | 新的提醒时间 |
228
+
229
+ #### 调用示例
230
+
231
+ 使用 `wecom_mcp` tool 调用 `wecom_mcp call todo update_todo '{"todo_id": "TODO_ID", "content": "<待办的内容>", "remind_time": "2025-07-01 09:00:00"}'`
232
+
233
+ #### 返回格式
234
+
235
+ ```json
236
+ {
237
+ "errcode": 0,
238
+ "errmsg": "ok"
239
+ }
240
+ ```
241
+
242
+ ---
243
+
244
+ ### 5. 删除待办 (delete_todo)
245
+
246
+ 删除指定的待办事项。
247
+
248
+ #### 调用方式
249
+
250
+ 使用 `wecom_mcp` tool 调用 `wecom_mcp call todo delete_todo '<json格式的入参>'`
251
+
252
+ #### 入参说明
253
+
254
+ 需要遵循 “注意事项”中的格式要求:
255
+
256
+ | 参数 | 类型 | 必填 | 说明 |
257
+ |------|------|------|------|
258
+ | `todo_id` | string | ✅ | 待办 ID |
259
+
260
+ #### 调用示例
261
+
262
+ 使用 `wecom_mcp` tool 调用 `wecom_mcp call todo delete_todo '{"todo_id": "TODO_ID"}'`
263
+
264
+ #### 返回格式
265
+
266
+ ```json
267
+ {
268
+ "errcode": 0,
269
+ "errmsg": "ok"
270
+ }
271
+ ```
272
+
273
+ > 删除前必须向用户确认,确认措辞示例:"确认删除待办'代码评审'吗?删除后不可恢复。"
274
+ > 注意:`delete_todo` 与 `update_todo` 设置 `todo_status=2` 效果相同,优先使用 `delete_todo`。
275
+
276
+ ---
277
+
278
+ ### 6. 变更用户待办状态 (change_todo_user_status)
279
+
280
+ 更改当前用户在某个待办中的状态(拒绝/接受/已完成)。
281
+
282
+ #### 调用方式
283
+
284
+ 使用 `wecom_mcp` tool 调用 `wecom_mcp call todo change_todo_user_status '<json格式的入参>'`
285
+
286
+ #### 入参说明
287
+
288
+ 需要遵循 “注意事项”中的格式要求:
289
+
290
+ | 参数 | 类型 | 必填 | 说明 |
291
+ |------|------|------|------|
292
+ | `todo_id` | string | ✅ | 待办 ID |
293
+ | `user_status` | number | ✅ | 用户状态:`0`-拒绝,`1`-接受,`2`-已完成 |
294
+
295
+ #### 调用示例
296
+
297
+ 使用 `wecom_mcp` tool 调用 `wecom_mcp call todo change_todo_user_status '{"todo_id": "TODO_ID", "user_status": 2}'`
298
+
299
+ #### 返回格式
300
+
301
+ ```json
302
+ {
303
+ "errcode": 0,
304
+ "errmsg": "ok"
305
+ }
306
+ ```
307
+
308
+ #### 返回字段说明
309
+
310
+ | 字段 | 类型 | 说明 |
311
+ |------|------|------|
312
+ | `errcode` | number | 返回码,`0` 表示成功 |
313
+ | `errmsg` | string | 错误信息,成功时为 `"ok"` |
314
+
315
+ ---
316
+
317
+ ## 典型工作流
318
+
319
+ > 完整的工作流步骤、命令示例和展示格式详见 [examples/workflows.md](examples/workflows.md)
320
+
321
+ | 工作流 | 适用场景 | 关键要点 |
322
+ | ------ | -------- | -------- |
323
+ | 工作流 1:查看待办列表 | "看看我最近的待办" | 标准三步:get_todo_list → get_todo_detail → contact 转姓名;检查 has_more 分页 |
324
+ | 工作流 2:按时间范围查询 | "这个月创建的待办有哪些?" | 传入 create_begin_time / create_end_time 过滤,后续同工作流 1 |
325
+ | 工作流 3:创建待办并分派 | "帮我创建一个待办,让张三完成需求文档" | 先通过 wecom-contact 查 userid,再 create_todo 带 follower_list |
326
+ | 工作流 4:标记待办完成 | "把这个待办标记为完成" | 区分场景 A(改 todo_status=0)和场景 B(改 user_status=2) |
327
+ | 工作流 5:更新待办 | "把提醒时间改到下周五" | 先查列表+详情定位目标,再 update_todo |
328
+ | 工作流 6:删除待办 | "删掉那个待办" | 删除前必须向用户确认,不可撤销 |
329
+ | 工作流 7:分页获取 | 待办数量超过单页上限 | 通过 cursor 循环拉取,未拉完必须提醒用户 |
330
+
331
+
332
+ ---
333
+
334
+ ## 注意事项
335
+
336
+ 1. **todo_id 来源规则**
337
+ - `todo_id` 必须来自 `get_todo_list` 返回的结果,禁止自行推测或构造
338
+ - 用户通常提供待办内容描述而非 ID,应先通过 `get_todo_list` 查列表再匹配
339
+ - 若匹配到多个相似待办,展示候选列表让用户确认
340
+
341
+ 2. **follower_id 来源规则**
342
+ - `follower_id` 即 `userid`,必须通过 `wecom-contact` 技能的 `get_userlist` 接口获取
343
+ - 禁止根据用户姓名自行猜测 userid
344
+ - 若搜索结果有多个同名人员,展示候选列表让用户选择
345
+
346
+ 3. **人员 ID 必须转姓名**
347
+ - 返回结果中的 `follower_id` 和 `creator_id` 是系统内部标识,用户无法识别
348
+ - 展示待办详情前,先使用 `wecom_mcp` tool 调用 `wecom_mcp call contact get_userlist '{}'` 获取通讯录
349
+ - 用通讯录的 `userid` 匹配 `follower_id` / `creator_id`,用 `name` 替换展示
350
+ - 如果通讯录中找不到某个 ID,展示时标注"未知用户(ID:xxx)"
351
+
352
+ 4. **时间格式**
353
+ - 所有时间参数使用 `YYYY-MM-DD HH:mm:ss` 格式
354
+ - 用户说"明天"、"下周一"等相对时间时,根据当前日期推算具体日期
355
+
356
+ 5. **状态值含义**
357
+ - 待办状态(`todo_status`):`0`-已完成,`1`-进行中,`2`-已删除
358
+ - 用户状态(`user_status`):`0`-拒绝,`1`-接受,`2`-已完成
359
+ - 分派人状态(`follower_status`):`0`-拒绝,`1`-接受,`2`-已完成
360
+
361
+ 6. **follower_list 的格式**(作为输入参数的时候)
362
+
363
+ ```json
364
+ "follower_list": { // 分派人列表
365
+ "followers": [ // 注意里面还有一层是 "followers",它的value才是真正的列表数组
366
+ {
367
+ "follower_id": "FOLLOWER_ID", // 分派人id
368
+ "follower_status": 1 // 分派人状态:0-拒绝, 1-接受, 2-已完成
369
+ }
370
+ ]
371
+ }
372
+ ```
373
+ > `follower_id` 即 userid,需要通过 `wecom-contact` 查询获取,禁止自行猜测或构造。
374
+
375
+ 7. **破坏性操作确认**
376
+ - 删除待办(`delete_todo`)前必须向用户确认
377
+ - 变更状态为"拒绝"(`user_status=0`)前建议向用户确认
378
+
379
+ 8. **必须查详情**
380
+ - `get_todo_list` 返回的是概要信息(不含内容和分派人),拿到列表后必须紧接着调用 `get_todo_detail` 获取完整内容再展示给用户,不要只展示列表概要
381
+
382
+ 9. **分页未拉完必须提醒**
383
+ - 如果返回的 `has_more` 为 `true`,在向用户展示结果时必须明确说明"还有更多待办未显示"并询问用户是否需要继续查看
384
+
385
+ 10. **单次详情上限**
386
+ - `todo_id_list` 最多传 20 个 ID,超过需要分批请求
387
+
388
+ 11. **错误处理**
389
+ - 若 `errcode` 不为 `0`,说明接口调用失败,告知用户 `errmsg` 中的错误信息
390
+
391
+ 12. **通讯录查询**
392
+ - 涉及分派人时,需先通过 `wecom-contact` 技能的 `get_userlist` 接口获取全量通讯录成员,再按姓名/别名本地筛选匹配出对应的 `userid`。该接口无入参,返回当前用户可见范围内的成员列表(含 `userid`, `name`, `alias`)