@mocrane/wecom 2026.3.14 → 2026.3.20
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 +17 -13
- package/index.ts +37 -0
- package/package.json +4 -3
- package/skills/wecom-contact-lookup/SKILL.md +162 -0
- package/skills/wecom-doc-manager/SKILL.md +64 -0
- package/skills/wecom-doc-manager/references/api-create-doc.md +56 -0
- package/skills/wecom-doc-manager/references/api-edit-doc-content.md +68 -0
- package/skills/wecom-doc-manager/references/api-export-document.md +88 -0
- package/skills/wecom-edit-todo/SKILL.md +249 -0
- package/skills/wecom-get-todo-detail/SKILL.md +143 -0
- package/skills/wecom-get-todo-list/SKILL.md +127 -0
- package/skills/wecom-meeting-create/SKILL.md +158 -0
- package/skills/wecom-meeting-create/references/example-full.md +30 -0
- package/skills/wecom-meeting-create/references/example-reminder.md +46 -0
- package/skills/wecom-meeting-create/references/example-security.md +22 -0
- package/skills/wecom-meeting-manage/SKILL.md +136 -0
- package/skills/wecom-meeting-query/SKILL.md +330 -0
- package/skills/wecom-preflight/SKILL.md +141 -0
- package/skills/wecom-schedule/SKILL.md +159 -0
- package/skills/wecom-schedule/references/api-check-availability.md +56 -0
- package/skills/wecom-schedule/references/api-create-schedule.md +38 -0
- package/skills/wecom-schedule/references/api-get-schedule-detail.md +81 -0
- package/skills/wecom-schedule/references/api-update-schedule.md +30 -0
- package/skills/wecom-schedule/references/ref-reminders.md +24 -0
- package/skills/wecom-smartsheet-data/SKILL.md +71 -0
- package/skills/wecom-smartsheet-data/references/api-get-records.md +61 -0
- package/skills/wecom-smartsheet-data/references/cell-value-formats.md +120 -0
- package/skills/wecom-smartsheet-schema/SKILL.md +92 -0
- package/skills/wecom-smartsheet-schema/references/field-types.md +43 -0
- package/src/agent/handler.ts +105 -14
- package/src/mcp/index.ts +7 -0
- package/src/mcp/schema.ts +108 -0
- package/src/mcp/tool.ts +226 -0
- package/src/mcp/transport.ts +561 -0
- package/src/media/const.ts +24 -0
- package/src/media/index.ts +15 -0
- package/src/media/uploader.ts +240 -0
- package/src/monitor.ts +293 -12
- package/src/outbound.ts +116 -46
- package/src/types/index.ts +1 -0
- package/src/types/message.ts +10 -1
- package/src/ws-adapter.ts +4 -0
package/README.md
CHANGED
|
@@ -1,17 +1,10 @@
|
|
|
1
1
|
# OpenClaw 企业微信(WeCom)Channel 插件
|
|
2
2
|
|
|
3
|
-
> [!WARNING]
|
|
4
|
-
> **OpenClaw 3.1+ 升级必读**:升级到 OpenClaw `3.1` 及以上版本的用户务必同步升级本插件,并将企业微信回调 URL 更新为 OpenClaw 推荐路径:`/plugins/wecom/bot/{accountId}` 与 `/plugins/wecom/agent/{accountId}`(旧 `/wecom/*` 仍兼容但不再维护)。
|
|
5
|
-
|
|
6
3
|
<p align="center">
|
|
7
|
-
<img src="https://img.shields.io/badge/
|
|
4
|
+
<a href="https://github.com/TencentCloud-Lighthouse/openclaw-wecom"><img src="https://img.shields.io/badge/GitHub-TencentCloud--Lighthouse%2Fwecom-blue?style=for-the-badge&logo=github" alt="GitHub Repo" /></a>
|
|
8
5
|
<img src="https://img.shields.io/badge/License-ISC-blue?style=for-the-badge" alt="License" />
|
|
9
6
|
</p>
|
|
10
7
|
|
|
11
|
-
> [!WARNING]
|
|
12
|
-
> **原创声明**:本项目涉及的“多账号隔离与矩阵路由架构”、“Bot+Agent双模融合架构”、“长任务超时接力逻辑”及“全自动媒体流转接”等核心设计均为作者 **YanHaidao** 独立思考与实践的原创成果。
|
|
13
|
-
> 欢迎技术交流与合规引用,但**严禁任何不经授权的“功能像素级抄袭”或删除原作者署名的代码搬运行为**。
|
|
14
|
-
|
|
15
8
|
<p align="center">
|
|
16
9
|
<strong>🚀 企业级双模式 AI 助手接入方案</strong>
|
|
17
10
|
</p>
|
|
@@ -477,10 +470,6 @@ Agent 输出 `{"template_card": ...}` 时自动渲染为交互卡片:
|
|
|
477
470
|
|
|
478
471
|
## 七、📮 联系我
|
|
479
472
|
|
|
480
|
-
微信交流群(扫码入群):
|
|
481
|
-
|
|
482
|
-

|
|
483
|
-
|
|
484
473
|
维护者:mocrane
|
|
485
474
|
|
|
486
475
|
---
|
|
@@ -500,7 +489,22 @@ Agent 输出 `{"template_card": ...}` 时自动渲染为交互卡片:
|
|
|
500
489
|
<a id="sec-10"></a>
|
|
501
490
|
## 八、📝 更新日志
|
|
502
491
|
|
|
503
|
-
### 2026.3.
|
|
492
|
+
### 2026.3.19
|
|
493
|
+
|
|
494
|
+
- 【多媒体发送】📎 **机器人富媒体发送**:Bot 支持向用户发送文件、图片、视频,补齐发送侧多模态能力。
|
|
495
|
+
- 【MCP 集成】🧩 **企业级 MCP 工具接入**:群聊与私聊中支持调用日程、待办、通讯录 MCP,实现对话式办公协作。
|
|
496
|
+
|
|
497
|
+
### 2026.3.15
|
|
498
|
+
|
|
499
|
+
- 【文档能力】📄 **企微文档操作支持**:新增企业微信文档读写操作能力,可在对话中直接操作企微文档。
|
|
500
|
+
- 【交互体验】⌨️ **打字机效果**:支持逐字流式输出的打字机效果,提升对话交互体验。
|
|
501
|
+
|
|
502
|
+
### 2026.3.8
|
|
503
|
+
|
|
504
|
+
- 【长连接】🔗 **Bot 长连接模式**:企微机器人支持长连接(WebSocket)模式,降低延迟、提升连接稳定性。
|
|
505
|
+
- 【主动触达】📤 **长连接模式主动发送**:长连接模式下 Bot 支持主动向用户发送消息,突破传统被动回复限制。
|
|
506
|
+
|
|
507
|
+
### 2026.3.3
|
|
504
508
|
|
|
505
509
|
- 【SDK适配】♻️ **插件 HTTP 注册升级**:入口改为 `registerHttpRoute`(`/plugins/wecom` + `match=prefix` + `auth=plugin`),适配 OpenClaw 新版插件接口。
|
|
506
510
|
- 【兼容修复】🔁 **旧入口保持可达**:同步注册 `/wecom` 前缀路由,保障历史 Bot/Agent 回调地址继续可用。
|
package/index.ts
CHANGED
|
@@ -4,6 +4,7 @@ import { emptyPluginConfigSchema } from "openclaw/plugin-sdk";
|
|
|
4
4
|
import { handleWecomWebhookRequest } from "./src/monitor.js";
|
|
5
5
|
import { setWecomRuntime } from "./src/runtime.js";
|
|
6
6
|
import { wecomPlugin } from "./src/channel.js";
|
|
7
|
+
import { createWeComMcpTool } from "./src/mcp/index.js";
|
|
7
8
|
|
|
8
9
|
const plugin = {
|
|
9
10
|
id: "wecom",
|
|
@@ -17,6 +18,8 @@ const plugin = {
|
|
|
17
18
|
* 1. 注入 Runtime 环境 (api.runtime)。
|
|
18
19
|
* 2. 注册 WeCom 渠道插件 (ChannelPlugin)。
|
|
19
20
|
* 3. 注册 Webhook HTTP 路由(推荐 /plugins/wecom/*,兼容 /wecom*)。
|
|
21
|
+
* 4. 注册 wecom_mcp 工具 (MCP Streamable HTTP 调用)。
|
|
22
|
+
* 5. 注入 MEDIA 指令提示词(仅 wecom 通道),指导 LLM 使用 MEDIA: 语法发送文件。
|
|
20
23
|
*/
|
|
21
24
|
register(api: OpenClawPluginApi) {
|
|
22
25
|
setWecomRuntime(api.runtime);
|
|
@@ -30,6 +33,40 @@ const plugin = {
|
|
|
30
33
|
match: "prefix",
|
|
31
34
|
});
|
|
32
35
|
}
|
|
36
|
+
|
|
37
|
+
// 注册 wecom_mcp:通过 HTTP 直接调用企业微信 MCP Server
|
|
38
|
+
api.registerTool(createWeComMcpTool(), { name: "wecom_mcp" });
|
|
39
|
+
|
|
40
|
+
// 注入媒体发送指令和文件大小限制提示词(与官方 @wecom/wecom-openclaw-plugin 保持一致)。
|
|
41
|
+
// 仅 wecom 通道注入,避免影响其他通道。
|
|
42
|
+
// deliver 回调中保留兜底正则解析,作为双重保障。
|
|
43
|
+
api.on("before_prompt_build", (_event, ctx) => {
|
|
44
|
+
if (ctx.channelId !== "wecom") return;
|
|
45
|
+
return {
|
|
46
|
+
prependContext: [
|
|
47
|
+
"【发送文件/图片/视频/语音】",
|
|
48
|
+
"当你需要向用户发送文件、图片、视频或语音时,必须在回复中单独一行使用 MEDIA: 指令,后面跟文件的本地路径。",
|
|
49
|
+
"格式:MEDIA: /文件的绝对路径",
|
|
50
|
+
"文件优先存放到 ~/.openclaw 目录下,确保路径可访问。",
|
|
51
|
+
"示例:",
|
|
52
|
+
" MEDIA: ~/.openclaw/output.png",
|
|
53
|
+
" MEDIA: ~/.openclaw/report.pdf",
|
|
54
|
+
"系统会自动识别文件类型并发送给用户。",
|
|
55
|
+
"",
|
|
56
|
+
"注意事项:",
|
|
57
|
+
"- MEDIA: 必须在行首,后面紧跟文件路径(不是 URL)",
|
|
58
|
+
"- 如果路径中包含空格,可以用反引号包裹:MEDIA: `/path/to/my file.png`",
|
|
59
|
+
"- 每个文件单独一行 MEDIA: 指令",
|
|
60
|
+
"- 可以在 MEDIA: 指令前后附带文字说明",
|
|
61
|
+
"",
|
|
62
|
+
"【文件大小限制】",
|
|
63
|
+
"- 图片不超过 10MB,视频不超过 10MB,语音不超过 2MB(仅支持 AMR 格式),文件不超过 20MB",
|
|
64
|
+
"- 语音消息仅支持 AMR 格式(.amr),如需发送语音请确保文件为 AMR 格式",
|
|
65
|
+
"- 超过大小限制的图片/视频/语音会被自动转为文件格式发送",
|
|
66
|
+
"- 如果文件超过 20MB,将无法发送,请提前告知用户并尝试缩减文件大小",
|
|
67
|
+
].join("\n"),
|
|
68
|
+
};
|
|
69
|
+
});
|
|
33
70
|
},
|
|
34
71
|
};
|
|
35
72
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mocrane/wecom",
|
|
3
|
-
"version": "2026.3.
|
|
3
|
+
"version": "2026.3.20",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "OpenClaw WeCom (WeChat Work) intelligent bot channel plugin",
|
|
6
6
|
"main": "index.ts",
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
}
|
|
44
44
|
},
|
|
45
45
|
"dependencies": {
|
|
46
|
-
"@wecom/aibot-node-sdk": "^1.0.
|
|
46
|
+
"@wecom/aibot-node-sdk": "^1.0.2",
|
|
47
47
|
"fast-xml-parser": "5.3.4",
|
|
48
48
|
"file-type": "^18.7.0",
|
|
49
49
|
"undici": "^7.20.0",
|
|
@@ -54,7 +54,8 @@
|
|
|
54
54
|
},
|
|
55
55
|
"devDependencies": {
|
|
56
56
|
"@types/node": "^25.2.0",
|
|
57
|
-
"typescript": "^5.9.3"
|
|
57
|
+
"typescript": "^5.9.3",
|
|
58
|
+
"vitest": "^4.1.0"
|
|
58
59
|
},
|
|
59
60
|
"clawdbot": {
|
|
60
61
|
"extensions": [
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: wecom-contact-lookup
|
|
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
|
+
| 无匹配结果 | 告知用户未找到对应人员 |
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: wecom-doc-manager
|
|
3
|
+
description: 企业微信文档管理技能。提供文档的创建、读取和编辑能力,支持通过 docid 或文档 URL 操作企业微信文档(doc_type=3)和智能表格(doc_type=10)。适用场景:(1) 以 Markdown 格式导出获取文档完整内容(异步轮询) (2) 新建文档或智能表格 (3) 用 Markdown 格式覆写文档内容。当用户需要查看文档内容、创建新文档、编辑文档正文时触发此 Skill。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 企业微信文档管理
|
|
7
|
+
|
|
8
|
+
> `wecom_mcp` 是一个 MCP tool,所有操作通过调用该 tool 完成。
|
|
9
|
+
|
|
10
|
+
> ⚠️ **前置条件**:首次调用 `wecom_mcp` 前,必须按 `wecom-preflight` 技能执行前置条件检查,确保工具已加入白名单。
|
|
11
|
+
|
|
12
|
+
管理企业微信文档的创建、读取和编辑。所有接口支持通过 `docid` 或 `url` 二选一定位文档。
|
|
13
|
+
|
|
14
|
+
## 调用方式
|
|
15
|
+
|
|
16
|
+
通过 `wecom_mcp` tool 调用,品类为 `doc`:
|
|
17
|
+
|
|
18
|
+
使用 `wecom_mcp` tool 调用 `wecom_mcp call doc <tool_name> '<json_params>'` 调用指定技能
|
|
19
|
+
|
|
20
|
+
## 返回格式说明
|
|
21
|
+
|
|
22
|
+
所有接口返回 JSON 对象,包含以下公共字段:
|
|
23
|
+
|
|
24
|
+
| 字段 | 类型 | 说明 |
|
|
25
|
+
|------|------|------|
|
|
26
|
+
| `errcode` | integer | 返回码,`0` 表示成功,非 `0` 表示失败 |
|
|
27
|
+
| `errmsg` | string | 错误信息,成功时为 `"ok"` |
|
|
28
|
+
|
|
29
|
+
当 `errcode` 不为 `0` 时,说明接口调用失败,可重试 1 次;若仍失败,将 `errcode` 和 `errmsg` 展示给用户。
|
|
30
|
+
|
|
31
|
+
### get_doc_content
|
|
32
|
+
|
|
33
|
+
获取文档完整内容数据,只能以 Markdown 格式返回。采用**异步轮询机制**:首次调用无需传 `task_id`,接口返回 `task_id`;若 `task_done` 为 false,需携带该 `task_id` 再次调用,直到 `task_done` 为 true 时返回完整内容。
|
|
34
|
+
|
|
35
|
+
- 首次调用(不传 task_id):使用 `wecom_mcp` tool 调用 `wecom_mcp call doc get_doc_content '{"docid": "DOCID", "type": 2}'`
|
|
36
|
+
- 轮询(携带上次返回的 task_id):使用 `wecom_mcp` tool 调用 `wecom_mcp call doc get_doc_content '{"docid": "DOCID", "type": 2, "task_id": "xxx"}'`
|
|
37
|
+
- 或通过 URL:使用 `wecom_mcp` tool 调用 `wecom_mcp call doc get_doc_content '{"url": "https://doc.weixin.qq.com/doc/xxx", "type": 2}'`
|
|
38
|
+
|
|
39
|
+
参见 [API 详情](references/api-export-document.md)。
|
|
40
|
+
|
|
41
|
+
### create_doc
|
|
42
|
+
|
|
43
|
+
新建文档(doc_type=3)或智能表格(doc_type=10)。创建成功返回 url 和 docid。
|
|
44
|
+
|
|
45
|
+
- 使用 `wecom_mcp` tool 调用 `wecom_mcp call doc create_doc '{"doc_type": 3, "doc_name": "项目周报"}'`
|
|
46
|
+
- 使用 `wecom_mcp` tool 调用 `wecom_mcp call doc create_doc '{"doc_type": 10, "doc_name": "任务跟踪表"}'`
|
|
47
|
+
|
|
48
|
+
**注意**:docid 仅在创建时返回,需妥善保存。创建智能表格时默认包含一个子表,可通过 `smartsheet_get_sheet` 查询其 sheet_id。
|
|
49
|
+
|
|
50
|
+
参见 [API 详情](references/api-create-doc.md)。
|
|
51
|
+
|
|
52
|
+
### edit_doc_content
|
|
53
|
+
|
|
54
|
+
用 Markdown 内容覆写文档正文。`content_type` 固定为 `1`(Markdown)。
|
|
55
|
+
|
|
56
|
+
使用 `wecom_mcp` tool 调用 `wecom_mcp call doc edit_doc_content '{"docid": "DOCID", "content": "# 标题\n\n正文内容", "content_type": 1}'`
|
|
57
|
+
|
|
58
|
+
参见 [API 详情](references/api-edit-doc-content.md)。
|
|
59
|
+
|
|
60
|
+
## 典型工作流
|
|
61
|
+
|
|
62
|
+
1. **读取文档** → 使用 `wecom_mcp` tool 调用 `wecom_mcp call doc get_doc_content '{"docid": "DOCID", "type": 2}'`,若 `task_done` 为 false 则携带 `task_id` 继续轮询
|
|
63
|
+
2. **创建新文档** → 使用 `wecom_mcp` tool 调用 `wecom_mcp call doc create_doc '{"doc_type": 3, "doc_name": "文档名"}'`,保存返回的 docid
|
|
64
|
+
3. **编辑文档** → 先 get_doc_content 了解当前内容,再 edit_doc_content 覆写
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# create_doc API
|
|
2
|
+
|
|
3
|
+
新建文档、表格或智能表格。创建成功后返回文档访问链接和 docid。
|
|
4
|
+
|
|
5
|
+
## 技能定义
|
|
6
|
+
|
|
7
|
+
```json
|
|
8
|
+
{
|
|
9
|
+
"name": "create_doc",
|
|
10
|
+
"description": "新建文档、表格或智能表格。支持在指定空间和目录下创建,可设置文档管理员。创建成功后返回文档访问链接和 docid(docid 仅在创建时返回,需妥善保存)。注意:创建智能表格(doc_type=10)时,文档会默认包含一个子表,可通过 smartsheet_get_sheet 查询其 sheet_id,无需额外调用 smartsheet_add_sheet。",
|
|
11
|
+
"inputSchema": {
|
|
12
|
+
"properties": {
|
|
13
|
+
"doc_type": {
|
|
14
|
+
"description": "文档类型:3-文档,10-智能表格",
|
|
15
|
+
"enum": [3, 10],
|
|
16
|
+
"title": "Doc Type",
|
|
17
|
+
"type": "integer"
|
|
18
|
+
},
|
|
19
|
+
"doc_name": {
|
|
20
|
+
"description": "文档名字,最多 255 个字符,超过会被截断",
|
|
21
|
+
"title": "Doc Name",
|
|
22
|
+
"type": "string"
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
"required": ["doc_type", "doc_name"],
|
|
26
|
+
"title": "create_docArguments",
|
|
27
|
+
"type": "object"
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## 请求示例
|
|
33
|
+
|
|
34
|
+
```json
|
|
35
|
+
{
|
|
36
|
+
"doc_type": 3,
|
|
37
|
+
"doc_name": "项目周报"
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## 响应示例
|
|
42
|
+
|
|
43
|
+
```json
|
|
44
|
+
{
|
|
45
|
+
"errcode": 0,
|
|
46
|
+
"errmsg": "ok",
|
|
47
|
+
"url": "https://doc.weixin.qq.com/doc/xxx",
|
|
48
|
+
"docid": "DOCID"
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## 注意事项
|
|
53
|
+
|
|
54
|
+
- `doc_type=3` 创建普通文档
|
|
55
|
+
- `doc_type=10` 创建智能表格,默认包含一个子表
|
|
56
|
+
- docid 仅在创建时返回,后续无法再获取,务必保存
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# edit_doc_content API
|
|
2
|
+
|
|
3
|
+
编辑(覆写)文档内容。
|
|
4
|
+
|
|
5
|
+
## 技能定义
|
|
6
|
+
|
|
7
|
+
```json
|
|
8
|
+
{
|
|
9
|
+
"name": "edit_doc_content",
|
|
10
|
+
"description": "编辑文档内容",
|
|
11
|
+
"inputSchema": {
|
|
12
|
+
"properties": {
|
|
13
|
+
"docid": {
|
|
14
|
+
"description": "文档 id,与 url 二选一传入",
|
|
15
|
+
"title": "Docid",
|
|
16
|
+
"type": "string"
|
|
17
|
+
},
|
|
18
|
+
"url": {
|
|
19
|
+
"description": "文档的访问链接,与 docid 二选一传入",
|
|
20
|
+
"title": "URL",
|
|
21
|
+
"type": "string"
|
|
22
|
+
},
|
|
23
|
+
"content": {
|
|
24
|
+
"description": "覆写的文档内容",
|
|
25
|
+
"title": "Content",
|
|
26
|
+
"type": "string"
|
|
27
|
+
},
|
|
28
|
+
"content_type": {
|
|
29
|
+
"description": "内容类型格式。1:markdown",
|
|
30
|
+
"enum": [1],
|
|
31
|
+
"title": "Content Type",
|
|
32
|
+
"type": "integer"
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
"oneOf": [
|
|
36
|
+
{ "required": ["docid", "content", "content_type"] },
|
|
37
|
+
{ "required": ["url", "content", "content_type"] }
|
|
38
|
+
],
|
|
39
|
+
"title": "edit_doc_contentArguments",
|
|
40
|
+
"type": "object"
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## 请求示例
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"docid": "DOCID",
|
|
50
|
+
"content": "# 标题\n\n正文内容",
|
|
51
|
+
"content_type": 1
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## 响应示例
|
|
56
|
+
|
|
57
|
+
```json
|
|
58
|
+
{
|
|
59
|
+
"errcode": 0,
|
|
60
|
+
"errmsg": "ok"
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## 注意事项
|
|
65
|
+
|
|
66
|
+
- `content_type` 当前仅支持 `1`(Markdown 格式)
|
|
67
|
+
- 此操作为**覆写**,会替换文档全部内容
|
|
68
|
+
- 建议先调用 `get_document` 了解当前内容再编辑
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# get_doc_content API
|
|
2
|
+
|
|
3
|
+
获取企业微信文档的完整内容数据,以 Markdown 格式返回。该接口采用异步轮询机制:首次调用无需传 task_id,接口会返回 task_id;若 task_done 为 false,需携带该 task_id 再次调用,直到 task_done 为 true 时返回完整内容。
|
|
4
|
+
|
|
5
|
+
## 技能定义
|
|
6
|
+
|
|
7
|
+
```json
|
|
8
|
+
{
|
|
9
|
+
"name": "get_doc_content",
|
|
10
|
+
"description": "获取企业微信文档的完整内容数据,以 Markdown 格式返回。该接口采用异步轮询机制:首次调用无需传 task_id,接口会返回 task_id;若 task_done 为 false,需携带该 task_id 再次调用,直到 task_done 为 true 时返回完整内容。",
|
|
11
|
+
"inputSchema": {
|
|
12
|
+
"properties": {
|
|
13
|
+
"docid": {
|
|
14
|
+
"description": "文档的 docid,与 url 二选一传入",
|
|
15
|
+
"title": "Doc ID",
|
|
16
|
+
"type": "string"
|
|
17
|
+
},
|
|
18
|
+
"url": {
|
|
19
|
+
"description": "文档的访问链接,与 docid 二选一传入",
|
|
20
|
+
"title": "URL",
|
|
21
|
+
"type": "string"
|
|
22
|
+
},
|
|
23
|
+
"type": {
|
|
24
|
+
"description": "内容返回格式。2: Markdown 格式",
|
|
25
|
+
"enum": [2],
|
|
26
|
+
"title": "Type",
|
|
27
|
+
"type": "integer"
|
|
28
|
+
},
|
|
29
|
+
"task_id": {
|
|
30
|
+
"description": "任务 ID,用于异步轮询。初次调用时不填,后续轮询时填写上次返回的 task_id",
|
|
31
|
+
"title": "Task ID",
|
|
32
|
+
"type": "string"
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
"oneOf": [
|
|
36
|
+
{ "required": ["docid", "type"] },
|
|
37
|
+
{ "required": ["url", "type"] }
|
|
38
|
+
],
|
|
39
|
+
"title": "get_doc_contentArguments",
|
|
40
|
+
"type": "object"
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## 参数说明
|
|
46
|
+
|
|
47
|
+
| 参数 | 类型 | 必填 | 说明 |
|
|
48
|
+
|---|---|---|---|
|
|
49
|
+
| docid | string | 与 url 二选一 | 文档的 docid |
|
|
50
|
+
| url | string | 与 docid 二选一 | 文档的访问链接 |
|
|
51
|
+
| type | integer | 是 | 内容返回格式,固定传 `2`(Markdown 格式) |
|
|
52
|
+
| task_id | string | 否 | 任务 ID,初次调用不填,后续轮询时填写上次返回的 task_id |
|
|
53
|
+
|
|
54
|
+
## 异步轮询机制
|
|
55
|
+
|
|
56
|
+
1. **首次调用**:传入 `docid`/`url` 和 `type: 2`,不传 `task_id`
|
|
57
|
+
2. **检查响应**:若 `task_done` 为 `false`,记录返回的 `task_id`
|
|
58
|
+
3. **轮询调用**:携带 `task_id` 再次调用,直到 `task_done` 为 `true`
|
|
59
|
+
4. **获取内容**:当 `task_done` 为 `true` 时,`content` 字段包含完整的 Markdown 内容
|
|
60
|
+
|
|
61
|
+
## 请求示例
|
|
62
|
+
|
|
63
|
+
```json
|
|
64
|
+
// 首次调用
|
|
65
|
+
{
|
|
66
|
+
"docid": "DOCID",
|
|
67
|
+
"type": 2
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
// 轮询调用
|
|
71
|
+
{
|
|
72
|
+
"docid": "DOCID",
|
|
73
|
+
"type": 2,
|
|
74
|
+
"task_id": "xxx"
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## 响应示例
|
|
79
|
+
|
|
80
|
+
```json
|
|
81
|
+
{
|
|
82
|
+
"errcode": 0,
|
|
83
|
+
"errmsg": "ok",
|
|
84
|
+
"content": "# 文档标题\n\n文档正文内容...",
|
|
85
|
+
"task_id": "xxxxx",
|
|
86
|
+
"task_done": true
|
|
87
|
+
}
|
|
88
|
+
```
|