@wecom/wecom-openclaw-plugin 2026.7.2-beta.1 → 2026.8.17-beta.1
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.
- package/README.md +33 -4
- package/dist/index.js +14 -21
- package/dist/src/cli/argv.d.ts +36 -0
- package/dist/src/cli/argv.js +155 -0
- package/dist/src/cli/const.d.ts +94 -0
- package/dist/src/cli/const.js +107 -0
- package/dist/src/cli/credentials.d.ts +54 -0
- package/dist/src/cli/credentials.js +342 -0
- package/dist/src/cli/index.d.ts +5 -0
- package/dist/src/cli/index.js +5 -0
- package/dist/src/cli/legacy-tool-warning.d.ts +12 -0
- package/dist/src/cli/legacy-tool-warning.js +20 -0
- package/dist/src/cli/locate.d.ts +32 -0
- package/dist/src/cli/locate.js +196 -0
- package/dist/src/cli/process-launcher.d.ts +1 -0
- package/dist/src/cli/process-launcher.js +1 -0
- package/dist/src/cli/process-output.d.ts +14 -0
- package/dist/src/cli/process-output.js +43 -0
- package/dist/src/cli/tool.d.ts +46 -0
- package/dist/src/cli/tool.js +363 -0
- package/dist/src/const.d.ts +0 -8
- package/dist/src/const.js +0 -14
- package/dist/src/monitor.js +1 -12
- package/dist/src/state-manager.d.ts +0 -19
- package/dist/src/state-manager.js +1 -34
- package/dist/src/utils.d.ts +27 -0
- package/openclaw.plugin.json +1 -1
- package/package.json +3 -3
- package/skills/wecom-send-media/SKILL.md +2 -0
- package/skills/wecom-send-template-card/SKILL.md +1 -1
- package/skills/wecomcli-calendar/SKILL.md +302 -0
- package/skills/wecomcli-calendar/references/calendar-agenda.md +228 -0
- package/skills/wecomcli-calendar/references/calendar-cancel.md +110 -0
- package/skills/wecomcli-calendar/references/calendar-create.md +240 -0
- package/skills/wecomcli-calendar/references/calendar-freebusy.md +209 -0
- package/skills/wecomcli-calendar/references/calendar-meeting-room.md +172 -0
- package/skills/wecomcli-calendar/references/calendar-search.md +208 -0
- package/skills/wecomcli-calendar/references/calendar-update.md +274 -0
- package/skills/wecomcli-contact/SKILL.md +59 -0
- package/skills/wecomcli-disk/SKILL.md +401 -0
- package/skills/wecomcli-doc/SKILL.md +140 -0
- package/skills/wecomcli-doc/references/doc-contents-append.md +22 -0
- package/skills/wecomcli-doc/references/doc-contents-overwrite.md +29 -0
- package/skills/wecomcli-doc/references/doc-create.md +161 -0
- package/skills/wecomcli-doc/scripts/build_docx.py +1375 -0
- package/skills/wecomcli-doc-manage/SKILL.md +135 -0
- package/skills/wecomcli-doc-manage/references/doc-members-update.md +26 -0
- package/skills/wecomcli-doc-manage/references/doc-names-update.md +22 -0
- package/skills/wecomcli-doc-manage/references/doc-rules-update.md +24 -0
- package/skills/wecomcli-email/SKILL.md +216 -0
- package/skills/wecomcli-email/references/forward-mail.md +131 -0
- package/skills/wecomcli-email/references/get-mail.md +168 -0
- package/skills/wecomcli-email/references/reply-mail.md +140 -0
- package/skills/wecomcli-email/references/search-mail.md +113 -0
- package/skills/wecomcli-email/references/security.md +53 -0
- package/skills/wecomcli-email/references/send-mail.md +186 -0
- package/skills/wecomcli-email/references/send-schedule.md +83 -0
- package/skills/wecomcli-media/SKILL.md +100 -0
- package/skills/wecomcli-meeting/SKILL.md +374 -0
- package/skills/wecomcli-meeting/references/meeting-cancel.md +115 -0
- package/skills/wecomcli-meeting/references/meeting-create.md +169 -0
- package/skills/wecomcli-meeting/references/meeting-list.md +228 -0
- package/skills/wecomcli-meeting/references/meeting-original-get.md +100 -0
- package/skills/wecomcli-meeting/references/meeting-search.md +175 -0
- package/skills/wecomcli-meeting/references/meeting-update.md +219 -0
- package/skills/wecomcli-message/SKILL.md +213 -0
- package/skills/wecomcli-preflight/SKILL.md +147 -0
- package/skills/wecomcli-sheet/SKILL.md +177 -0
- package/skills/wecomcli-sheet/references/sheet-contents-update.md +49 -0
- package/skills/wecomcli-sheet/references/sheet-ranges-get.md +47 -0
- package/skills/wecomcli-sheet/references/sheet-rows-append.md +47 -0
- package/skills/wecomcli-sheet/references/sheet-subsheets-add.md +28 -0
- package/skills/wecomcli-sheet/references/sheet-subsheets-delete.md +22 -0
- package/skills/wecomcli-smartpage/SKILL.md +172 -0
- package/skills/wecomcli-smartpage/references/data-driven-pages.md +50 -0
- package/skills/wecomcli-smartpage/references/formula/arraylist.md +369 -0
- package/skills/wecomcli-smartpage/references/formula/datetime.md +283 -0
- package/skills/wecomcli-smartpage/references/formula/logic.md +247 -0
- package/skills/wecomcli-smartpage/references/formula/math.md +362 -0
- package/skills/wecomcli-smartpage/references/formula/operators.md +246 -0
- package/skills/wecomcli-smartpage/references/formula/pageblock.md +76 -0
- package/skills/wecomcli-smartpage/references/formula/templates.md +410 -0
- package/skills/wecomcli-smartpage/references/formula/text.md +377 -0
- package/skills/wecomcli-smartpage/references/formula/user.md +22 -0
- package/skills/wecomcli-smartpage/references/formula-reference.md +192 -0
- package/skills/wecomcli-smartpage/references/mdx-syntax.md +739 -0
- package/skills/wecomcli-smartpage/references/smartpage-edit.md +519 -0
- package/skills/wecomcli-smartsheet/SKILL.md +153 -0
- package/skills/wecomcli-smartsheet/assets/templates/README.md +53 -0
- package/skills/wecomcli-smartsheet/assets/templates/ai_efficiency.md +709 -0
- package/skills/wecomcli-smartsheet/assets/templates/connect_to_app.md +380 -0
- package/skills/wecomcli-smartsheet/assets/templates/financial_accounting.md +369 -0
- package/skills/wecomcli-smartsheet/assets/templates/hr_and_administration.md +475 -0
- package/skills/wecomcli-smartsheet/assets/templates/ledger_records.md +156 -0
- package/skills/wecomcli-smartsheet/assets/templates/manufacturing.md +395 -0
- package/skills/wecomcli-smartsheet/assets/templates/marketing.md +186 -0
- package/skills/wecomcli-smartsheet/assets/templates/office_essentials.md +299 -0
- package/skills/wecomcli-smartsheet/assets/templates/personal_efficiency.md +70 -0
- package/skills/wecomcli-smartsheet/assets/templates/procurement_logistics.md +325 -0
- package/skills/wecomcli-smartsheet/assets/templates/project_management.md +564 -0
- package/skills/wecomcli-smartsheet/assets/templates/rd_process_customer.md +222 -0
- package/skills/wecomcli-smartsheet/assets/templates/rd_process_ops.md +105 -0
- package/skills/wecomcli-smartsheet/assets/templates/rd_process_project.md +109 -0
- package/skills/wecomcli-smartsheet/assets/templates/rd_process_research.md +92 -0
- package/skills/wecomcli-smartsheet/assets/templates/sales_and_operations.md +446 -0
- package/skills/wecomcli-smartsheet/assets/templates/store_management.md +431 -0
- package/skills/wecomcli-smartsheet/assets/templates/team_tasks.md +274 -0
- package/skills/wecomcli-smartsheet/assets/templates/wechat_customer.md +384 -0
- package/skills/wecomcli-smartsheet/assets/templates/work_report.md +100 -0
- package/skills/wecomcli-smartsheet/references/common.md +145 -0
- package/skills/wecomcli-smartsheet/references/smart-sheet-chart-types.md +95 -0
- package/skills/wecomcli-smartsheet/references/smart-sheet-edit.md +611 -0
- package/skills/wecomcli-smartsheet/references/smart-sheet-field-types.md +438 -0
- package/skills/wecomcli-smartsheet/references/smart-sheet-formula.md +845 -0
- package/skills/wecomcli-smartsheet/references/smart-sheet-read.md +411 -0
- package/skills/wecomcli-smartsheet/references/smart-sheet-record-values.md +203 -0
- package/skills/wecomcli-smartsheet/references/smart-sheet-view-types.md +356 -0
- package/skills/{wecom-smartsheet/references/webhook-examples.md → wecomcli-smartsheet/references/smart-sheet-webhook-examples.md} +23 -32
- package/skills/wecomcli-smartsheet/references/smart-sheet-webhook.md +169 -0
- package/skills/wecomcli-todo/SKILL.md +75 -0
- package/skills/wecomcli-todo/references/todo-create.md +139 -0
- package/skills/wecomcli-todo/references/todo-delete.md +65 -0
- package/skills/wecomcli-todo/references/todo-finish.md +74 -0
- package/skills/wecomcli-todo/references/todo-get.md +68 -0
- package/skills/wecomcli-todo/references/todo-list.md +135 -0
- package/skills/wecomcli-todo/references/todo-update.md +114 -0
- package/dist/src/mcp/index.d.ts +0 -6
- package/dist/src/mcp/index.js +0 -10
- package/dist/src/mcp/interceptors/biz-error.d.ts +0 -11
- package/dist/src/mcp/interceptors/biz-error.js +0 -69
- package/dist/src/mcp/interceptors/doc-auth-error.d.ts +0 -10
- package/dist/src/mcp/interceptors/doc-auth-error.js +0 -171
- package/dist/src/mcp/interceptors/index.d.ts +0 -35
- package/dist/src/mcp/interceptors/index.js +0 -72
- package/dist/src/mcp/interceptors/msg-media.d.ts +0 -11
- package/dist/src/mcp/interceptors/msg-media.js +0 -133
- package/dist/src/mcp/interceptors/smartpage-create.d.ts +0 -30
- package/dist/src/mcp/interceptors/smartpage-create.js +0 -132
- package/dist/src/mcp/interceptors/smartpage-export.d.ts +0 -17
- package/dist/src/mcp/interceptors/smartpage-export.js +0 -87
- package/dist/src/mcp/interceptors/smartsheet-upload.d.ts +0 -22
- package/dist/src/mcp/interceptors/smartsheet-upload.js +0 -263
- package/dist/src/mcp/interceptors/types.d.ts +0 -64
- package/dist/src/mcp/interceptors/types.js +0 -7
- package/dist/src/mcp/schema.d.ts +0 -11
- package/dist/src/mcp/schema.js +0 -99
- package/dist/src/mcp/tool.d.ts +0 -63
- package/dist/src/mcp/tool.js +0 -224
- package/dist/src/mcp/transport.d.ts +0 -94
- package/dist/src/mcp/transport.js +0 -549
- package/skills/wecom-contact/SKILL.md +0 -162
- package/skills/wecom-doc/SKILL.md +0 -127
- package/skills/wecom-meeting/SKILL.md +0 -441
- package/skills/wecom-meeting/references/example-full.md +0 -30
- package/skills/wecom-meeting/references/example-reminder.md +0 -46
- package/skills/wecom-meeting/references/example-security.md +0 -22
- package/skills/wecom-meeting/references/response-get-meeting-info.md +0 -148
- package/skills/wecom-msg/SKILL.md +0 -157
- package/skills/wecom-msg/references/api-get-messages.md +0 -93
- package/skills/wecom-msg/references/api-get-msg-chat-list.md +0 -58
- package/skills/wecom-msg/references/api-get-msg-media.md +0 -44
- package/skills/wecom-msg/references/api-send-message.md +0 -39
- package/skills/wecom-preflight/SKILL.md +0 -141
- package/skills/wecom-schedule/SKILL.md +0 -161
- package/skills/wecom-schedule/references/api-check-availability.md +0 -56
- package/skills/wecom-schedule/references/api-create-schedule.md +0 -38
- package/skills/wecom-schedule/references/api-get-schedule-detail.md +0 -81
- package/skills/wecom-schedule/references/api-update-schedule.md +0 -32
- package/skills/wecom-schedule/references/ref-reminders.md +0 -24
- package/skills/wecom-sheet/SKILL.md +0 -131
- package/skills/wecom-sheet/references/sheet-add-sub.md +0 -54
- package/skills/wecom-sheet/references/sheet-append-data.md +0 -64
- package/skills/wecom-sheet/references/sheet-delete-sub.md +0 -38
- package/skills/wecom-sheet/references/sheet-update-range-data.md +0 -95
- package/skills/wecom-smartpage/SKILL.md +0 -119
- package/skills/wecom-smartpage/references/smartpage-create.md +0 -130
- package/skills/wecom-smartpage/references/smartpage-export.md +0 -168
- package/skills/wecom-smartsheet/SKILL.md +0 -241
- package/skills/wecom-smartsheet/references/smartsheet-cell-value-formats.md +0 -163
- package/skills/wecom-smartsheet/references/smartsheet-field-types.md +0 -44
- package/skills/wecom-smartsheet/references/smartsheet-get-records.md +0 -187
- package/skills/wecom-smartsheet/references/webhook-fallback.md +0 -183
- package/skills/wecom-todo/SKILL.md +0 -272
|
@@ -1,162 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: wecom-contact
|
|
3
|
-
description: 通讯录成员查询技能,基于 MCP tool 协议封装的 `get_userlist` 接口,获取当前用户可见范围内的通讯录成员,支持按姓名/别名本地筛选匹配。返回 userid、姓名和别名。⚠️ 仅返回当前用户有权限查看的成员,非全量成员。
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# 通讯录成员查询技能
|
|
7
|
-
|
|
8
|
-
> `wecom_mcp` 是一个 MCP tool,所有操作通过调用该 tool 完成。
|
|
9
|
-
|
|
10
|
-
> ⚠️ **前置条件**:首次调用 `wecom_mcp` 前,必须按 `wecom-preflight` 技能执行前置条件检查,确保工具已加入白名单。
|
|
11
|
-
|
|
12
|
-
通过 MCP tool 协议封装的 `get_userlist` 接口,获取当前用户可见范围内的通讯录成员,并在本地按姓名/别名进行筛选匹配。
|
|
13
|
-
|
|
14
|
-
## 操作
|
|
15
|
-
|
|
16
|
-
### 1. 获取全量通讯录成员
|
|
17
|
-
|
|
18
|
-
获取当前用户可见范围内的所有企业成员信息:
|
|
19
|
-
|
|
20
|
-
**调用示例:**
|
|
21
|
-
|
|
22
|
-
使用 `wecom_mcp` tool 调用 `wecom_mcp call contact get_userlist '{}'`
|
|
23
|
-
|
|
24
|
-
**返回格式:**
|
|
25
|
-
|
|
26
|
-
```json
|
|
27
|
-
{
|
|
28
|
-
"errcode": 0,
|
|
29
|
-
"errmsg": "ok",
|
|
30
|
-
"userlist": [
|
|
31
|
-
{
|
|
32
|
-
"userid": "zhangsan",
|
|
33
|
-
"name": "张三",
|
|
34
|
-
"alias": "Sam"
|
|
35
|
-
},
|
|
36
|
-
{
|
|
37
|
-
"userid": "lisi",
|
|
38
|
-
"name": "李四",
|
|
39
|
-
"alias": ""
|
|
40
|
-
}
|
|
41
|
-
]
|
|
42
|
-
}
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
**返回字段说明:**
|
|
46
|
-
|
|
47
|
-
| 字段 | 类型 | 说明 |
|
|
48
|
-
|------|------|------|
|
|
49
|
-
| `errcode` | integer | 返回码,`0` 表示成功 |
|
|
50
|
-
| `errmsg` | string | 错误信息 |
|
|
51
|
-
| `userlist` | array | 用户列表 |
|
|
52
|
-
| `userlist[].userid` | string | 用户唯一 ID |
|
|
53
|
-
| `userlist[].name` | string | 用户姓名 |
|
|
54
|
-
| `userlist[].alias` | string | 用户别名,可能为空 |
|
|
55
|
-
|
|
56
|
-
---
|
|
57
|
-
|
|
58
|
-
### 2. 按姓名/别名搜索人员
|
|
59
|
-
|
|
60
|
-
`get_userlist` 返回全量成员后,在本地对结果进行筛选匹配:
|
|
61
|
-
|
|
62
|
-
- **精确匹配**:`name` 或 `alias` 与关键词完全一致,直接使用
|
|
63
|
-
- **模糊匹配**:`name` 或 `alias` 包含关键词,返回所有匹配结果
|
|
64
|
-
- **无结果**:告知用户未找到对应人员
|
|
65
|
-
|
|
66
|
-
**搜索示例:**
|
|
67
|
-
|
|
68
|
-
用户问:"帮我找一下张三是谁?"
|
|
69
|
-
|
|
70
|
-
1. 调用 `get_userlist` 获取全量成员
|
|
71
|
-
2. 在 `userlist` 中筛选 `name` 或 `alias` 包含"张三"的成员
|
|
72
|
-
3. 返回匹配结果
|
|
73
|
-
|
|
74
|
-
---
|
|
75
|
-
|
|
76
|
-
## 注意事项
|
|
77
|
-
|
|
78
|
-
- `get_userlist` 返回的是当前用户**可见范围内**的成员,需经过可见性规则过滤,不一定是全公司所有人员;返回字段仅包含 `userid`、`name`(姓名)和 `alias`(别名)
|
|
79
|
-
- ⚠️ **超过 10 人时接口将报错**:若 `userlist` 返回成员数量超过 10 人,视为异常,应立即停止处理并向用户说明:
|
|
80
|
-
|
|
81
|
-
> 当前通讯录可见成员数量超过了本技能支持的上限(10 人)。
|
|
82
|
-
> 本技能仅适用于可见范围较小的场景,无法在大范围通讯录中使用。
|
|
83
|
-
> 建议缩小可见范围后重试,或通过其他方式查询目标人员。
|
|
84
|
-
|
|
85
|
-
- `userid` 是用户的唯一标识,在需要传递用户 ID 给其他接口时使用此字段
|
|
86
|
-
- `alias` 字段可能为空字符串,搜索时需做空值判断
|
|
87
|
-
- 若搜索结果有多个同名人员,需将所有候选人展示给用户选择,不得自行决定
|
|
88
|
-
- 若 `errcode` 不为 `0`,说明接口调用失败,需告知用户错误信息(`errmsg`)
|
|
89
|
-
|
|
90
|
-
---
|
|
91
|
-
|
|
92
|
-
## 典型工作流
|
|
93
|
-
|
|
94
|
-
### 工作流 1:查询人员信息
|
|
95
|
-
|
|
96
|
-
用户问:"帮我查一下 Sam 是谁?"
|
|
97
|
-
|
|
98
|
-
1. 使用 `wecom_mcp` tool 调用 `wecom_mcp call contact get_userlist '{}'` 获取全量成员列表
|
|
99
|
-
|
|
100
|
-
2. 在结果中筛选 `alias` 为 `Sam` 或 `name` 包含 `Sam` 的成员
|
|
101
|
-
3. 若找到唯一匹配,直接展示结果:
|
|
102
|
-
|
|
103
|
-
```
|
|
104
|
-
📇 找到成员:
|
|
105
|
-
- 姓名:张三
|
|
106
|
-
- 别名:Sam
|
|
107
|
-
- 用户ID:zhangsan
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
4. 若找到多个匹配,展示候选列表请用户确认:
|
|
111
|
-
|
|
112
|
-
```
|
|
113
|
-
🔍 找到多个匹配成员,请确认您要查询的是哪位:
|
|
114
|
-
|
|
115
|
-
1. 张三(别名:Sam,ID:zhangsan)
|
|
116
|
-
2. 张三丰(别名:Sam2,ID:zhangsan2)
|
|
117
|
-
|
|
118
|
-
请问您要查询的是哪一位?
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
---
|
|
122
|
-
|
|
123
|
-
### 工作流 2:为其他功能提供 userid 转换
|
|
124
|
-
|
|
125
|
-
用户问:"帮我发消息给张三"
|
|
126
|
-
|
|
127
|
-
1. 使用 `wecom_mcp` tool 调用 `wecom_mcp call contact get_userlist '{}'` 获取全量成员
|
|
128
|
-
|
|
129
|
-
2. 筛选 `name` 为"张三"的成员,确认 `userid`
|
|
130
|
-
3. 将 `userid` 传递给消息发送接口
|
|
131
|
-
|
|
132
|
-
---
|
|
133
|
-
|
|
134
|
-
### 工作流 3:批量查询多个人员
|
|
135
|
-
|
|
136
|
-
用户问:"帮我查一下张三和李四分别是谁?"
|
|
137
|
-
|
|
138
|
-
1. 使用 `wecom_mcp` tool 调用 `wecom_mcp call contact get_userlist '{}'` 获取全量成员列表
|
|
139
|
-
|
|
140
|
-
2. 分别筛选"张三"和"李四"的匹配结果
|
|
141
|
-
3. 汇总后一并展示
|
|
142
|
-
|
|
143
|
-
> 注意:只需调用一次 `get_userlist`,在本地对结果进行多次筛选,避免重复调用接口。
|
|
144
|
-
|
|
145
|
-
---
|
|
146
|
-
|
|
147
|
-
## 快速参考
|
|
148
|
-
|
|
149
|
-
### 接口说明
|
|
150
|
-
|
|
151
|
-
| 接口 | 用途 | 输入 | 返回 |
|
|
152
|
-
|------|------|------|------|
|
|
153
|
-
| `get_userlist` | 获取可见范围内全量通讯录成员 | 无 | 用户列表(userid、name、alias) |
|
|
154
|
-
|
|
155
|
-
### 本地筛选策略
|
|
156
|
-
|
|
157
|
-
| 场景 | 策略 |
|
|
158
|
-
|------|------|
|
|
159
|
-
| 精确匹配(name 或 alias 完全一致) | 直接使用,无需用户确认 |
|
|
160
|
-
| 模糊匹配(name 或 alias 包含关键词),唯一结果 | 直接使用,向用户展示结果 |
|
|
161
|
-
| 模糊匹配,多个结果 | 展示候选列表,请用户选择 |
|
|
162
|
-
| 无匹配结果 | 告知用户未找到对应人员 |
|
|
@@ -1,127 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: wecom-doc
|
|
3
|
-
description: 企业微信文档(doc)管理技能。提供普通文档的新建、内容读取(Markdown)、内容覆写能力。适用场景:(1) 从零新建空白文档 (2) 以 Markdown 格式读取文档完整内容 (3) 用 Markdown 覆写文档正文。支持通过 docid 或文档 URL 定位文档。当用户提到「企业微信文档」「企微文档」「创建文档」「写个文档」,或链接形如 `https://doc.weixin.qq.com/doc/xxx` 时触发该技能。注意:在线表格(`/sheet/*`)请用 `wecom-sheet`;智能表格(`/smartsheet/*`)请用 `wecom-smartsheet`;智能文档/智能主页(`/smartpage/*`)请用 `wecom-smartpage`。
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# 企业微信文档管理
|
|
7
|
-
|
|
8
|
-
> `wecom_mcp` 是一个 MCP tool,所有操作通过调用该 tool 完成。
|
|
9
|
-
|
|
10
|
-
> ⚠️ **前置条件**:首次调用 `wecom_mcp` 前,必须按 `wecom-preflight` 技能执行前置条件检查,确保工具已加入白名单。
|
|
11
|
-
|
|
12
|
-
资源型技能,负责普通 doc 文档的新建、内容读取与覆写。文档接口支持通过 `docid` 或 `url` 二选一定位文档。
|
|
13
|
-
|
|
14
|
-
## URL 品类识别与接口路由
|
|
15
|
-
|
|
16
|
-
企业微信文档有多种品类,**URL 格式不同,所用的接口/技能也不同**。请通过 URL 严格区分:
|
|
17
|
-
|
|
18
|
-
| URL 模式 | 品类 | 处理方式 |
|
|
19
|
-
|---|---|---|
|
|
20
|
-
| `https://doc.weixin.qq.com/doc/*` | **文档** | **本 skill** |
|
|
21
|
-
| `https://doc.weixin.qq.com/sheet/*` | **在线表格** | 参阅 `wecom-sheet` skill |
|
|
22
|
-
| `https://doc.weixin.qq.com/smartsheet/*` | **智能表格** | 参阅 `wecom-smartsheet` skill |
|
|
23
|
-
| `https://doc.weixin.qq.com/smartpage/*` | **智能文档**(原名智能主页) | 参阅 `wecom-smartpage` skill |
|
|
24
|
-
|
|
25
|
-
## 调用方式
|
|
26
|
-
|
|
27
|
-
通过 `wecom_mcp` tool 调用,品类名为 `doc`:
|
|
28
|
-
|
|
29
|
-
使用 `wecom_mcp` tool 调用 `wecom_mcp call doc <tool_name> '<json_params>'` 调用指定技能
|
|
30
|
-
|
|
31
|
-
## 返回格式说明
|
|
32
|
-
|
|
33
|
-
所有接口返回 JSON 对象,包含以下公共字段:
|
|
34
|
-
|
|
35
|
-
| 字段 | 类型 | 说明 |
|
|
36
|
-
|------|------|------|
|
|
37
|
-
| `errcode` | integer | 返回码,`0` 表示成功,非 `0` 表示失败 |
|
|
38
|
-
| `errmsg` | string | 错误信息,成功时为 `"ok"` |
|
|
39
|
-
|
|
40
|
-
当 `errcode` 不为 `0` 时,说明接口调用失败,可重试 1 次;若仍失败,将 `errcode` 和 `errmsg` 展示给用户。
|
|
41
|
-
|
|
42
|
-
### 特殊错误码
|
|
43
|
-
|
|
44
|
-
| errcode | errmsg | 含义 | 处理方式 |
|
|
45
|
-
|---------|--------|------|----------|
|
|
46
|
-
| `851002` | `incompatible doc type` | 文档品类与所调用的接口不匹配 | 根据文档 URL 重新确认品类(参见上方「URL 品类识别与接口路由」表),然后跳转到该品类对应的 skill |
|
|
47
|
-
|
|
48
|
-
## 接口详述
|
|
49
|
-
|
|
50
|
-
### create_doc — 新建文档
|
|
51
|
-
|
|
52
|
-
新建一篇空白企微文档(`doc_type` 固定为 3)。创建成功后返回 `docid` 和 `url`。
|
|
53
|
-
|
|
54
|
-
使用 `wecom_mcp` tool 调用 `wecom_mcp call doc create_doc '{"doc_type": 3, "doc_name": "项目周报"}'`
|
|
55
|
-
|
|
56
|
-
**参数**
|
|
57
|
-
|
|
58
|
-
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|
|
59
|
-
|---|---|---|---|---|
|
|
60
|
-
| `doc_type` | int | 是 | — | 固定传 `3`(文档) |
|
|
61
|
-
| `doc_name` | string | 是 | — | 文档标题,最多 255 个字符,超过会被截断 |
|
|
62
|
-
|
|
63
|
-
**返回**
|
|
64
|
-
|
|
65
|
-
| 字段 | 类型 | 说明 |
|
|
66
|
-
|---|---|---|
|
|
67
|
-
| `docid` | string | 新建文档的 docid,需妥善保存 |
|
|
68
|
-
| `url` | string | 新建文档的访问链接 |
|
|
69
|
-
|
|
70
|
-
**注意事项**
|
|
71
|
-
|
|
72
|
-
- 本接口仅创建**空白**文档,不携带初始内容;如需写入正文,请在创建后调用 `edit_doc_content`。
|
|
73
|
-
|
|
74
|
-
### get_doc_content — 读取完整内容
|
|
75
|
-
|
|
76
|
-
获取文档的完整内容数据,统一以 Markdown 格式返回。采用**异步轮询机制**:首次调用无需传 `task_id`,接口返回 `task_id`;若 `task_done` 为 `false`,需携带该 `task_id` 再次调用,直到 `task_done` 为 `true` 时返回完整内容。
|
|
77
|
-
|
|
78
|
-
- 首次调用(不传 task_id):使用 `wecom_mcp` tool 调用 `wecom_mcp call doc get_doc_content '{"docid": "DOCID", "type": 2}'`
|
|
79
|
-
- 轮询(携带上次返回的 task_id):使用 `wecom_mcp` tool 调用 `wecom_mcp call doc get_doc_content '{"docid": "DOCID", "type": 2, "task_id": "xxx"}'`
|
|
80
|
-
- 通过 URL 读取:使用 `wecom_mcp` tool 调用 `wecom_mcp call doc get_doc_content '{"url": "https://doc.weixin.qq.com/doc/xxx", "type": 2}'`
|
|
81
|
-
|
|
82
|
-
**参数**
|
|
83
|
-
|
|
84
|
-
| 字段 | 类型 | 必填 | 默认值 | 语义 |
|
|
85
|
-
|---|---|---|---|---|
|
|
86
|
-
| `docid` | string | 与 `url` 二选一 | — | 文档的 docid |
|
|
87
|
-
| `url` | string | 与 `docid` 二选一 | — | 文档的访问链接 |
|
|
88
|
-
| `type` | int | 是 | — | 内容返回格式,固定传 `2`(Markdown) |
|
|
89
|
-
| `task_id` | string | 否 | — | 任务 ID,首次不传,轮询时填上次返回的 `task_id` |
|
|
90
|
-
|
|
91
|
-
**返回**
|
|
92
|
-
|
|
93
|
-
| 字段 | 类型 | 说明 |
|
|
94
|
-
|---|---|---|
|
|
95
|
-
| `content` | string | `task_done` 为 `true` 时返回的完整 Markdown 内容 |
|
|
96
|
-
| `task_id` | string | 任务 ID,未完成时用于下次轮询 |
|
|
97
|
-
| `task_done` | bool | 任务是否完成,`false` 时需携带 `task_id` 继续轮询 |
|
|
98
|
-
|
|
99
|
-
**使用规则**
|
|
100
|
-
|
|
101
|
-
- 首次调用不传 `task_id`;若 `task_done` 为 `false`,记录 `task_id` 后携带其再次调用,直到 `task_done` 为 `true` 取 `content`。
|
|
102
|
-
|
|
103
|
-
### edit_doc_content — 覆写文档内容
|
|
104
|
-
|
|
105
|
-
用 Markdown 内容覆写文档正文。此操作为**覆写**,会替换文档全部内容。`content_type` 固定为 `1`(Markdown)。
|
|
106
|
-
|
|
107
|
-
使用 `wecom_mcp` tool 调用 `wecom_mcp call doc edit_doc_content '{"docid": "DOCID", "content": "# 标题\n\n正文内容", "content_type": 1}'`
|
|
108
|
-
|
|
109
|
-
**参数**
|
|
110
|
-
|
|
111
|
-
| 字段 | 类型 | 必填 | 默认值 | 语义 |
|
|
112
|
-
|---|---|---|---|---|
|
|
113
|
-
| `docid` | string | 与 `url` 二选一 | — | 文档的 docid |
|
|
114
|
-
| `url` | string | 与 `docid` 二选一 | — | 文档的访问链接 |
|
|
115
|
-
| `content` | string | 是 | — | 覆写的文档内容(Markdown) |
|
|
116
|
-
| `content_type` | int | 是 | — | 内容类型,固定传 `1`(Markdown) |
|
|
117
|
-
|
|
118
|
-
**使用规则**
|
|
119
|
-
|
|
120
|
-
- 此操作为覆写,会替换文档全部内容;建议先用 `get_doc_content` 了解当前内容再编辑。
|
|
121
|
-
- 成功判定:以返回的 `errcode == 0` 为准;非 0 时按「返回格式说明」处理(可重试 1 次)。
|
|
122
|
-
|
|
123
|
-
## 跨技能依赖
|
|
124
|
-
|
|
125
|
-
| 依赖技能 | 典型协作场景 | 数据流向 |
|
|
126
|
-
|---|---|---|
|
|
127
|
-
| `wecom-msg` | 用户要求把文档链接发给某人/某群 | 本 skill 新建后返回 `url` → `wecom-msg` 发送链接 |
|