@lanmers/wecom-openclaw-plugin 1.0.12
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 +220 -0
- package/dist/index.cjs.js +3591 -0
- package/dist/index.cjs.js.map +1 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.esm.js +3565 -0
- package/dist/index.esm.js.map +1 -0
- package/dist/src/channel.d.ts +3 -0
- package/dist/src/const.d.ts +64 -0
- package/dist/src/dm-policy.d.ts +29 -0
- package/dist/src/group-policy.d.ts +29 -0
- package/dist/src/interface.d.ts +154 -0
- package/dist/src/mcp/index.d.ts +6 -0
- package/dist/src/mcp/schema.d.ts +11 -0
- package/dist/src/mcp/tool.d.ts +55 -0
- package/dist/src/mcp/transport.d.ts +61 -0
- package/dist/src/mcp-config.d.ts +29 -0
- package/dist/src/media-handler.d.ts +36 -0
- package/dist/src/media-uploader.d.ts +131 -0
- package/dist/src/message-parser.d.ts +72 -0
- package/dist/src/message-sender.d.ts +23 -0
- package/dist/src/monitor.d.ts +27 -0
- package/dist/src/onboarding.d.ts +5 -0
- package/dist/src/openclaw-compat.d.ts +48 -0
- package/dist/src/reqid-store.d.ts +31 -0
- package/dist/src/runtime.d.ts +3 -0
- package/dist/src/state-manager.d.ts +76 -0
- package/dist/src/timeout.d.ts +20 -0
- package/dist/src/utils.d.ts +96 -0
- package/dist/src/version.d.ts +2 -0
- package/openclaw.plugin.json +14 -0
- package/package.json +73 -0
- package/skills/wecom-contact-lookup/SKILL.md +162 -0
- package/skills/wecom-doc/SKILL.md +363 -0
- package/skills/wecom-doc/references/doc-api.md +224 -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
|
@@ -0,0 +1,363 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: wecom-doc
|
|
3
|
+
description: 文档与智能表格操作。当用户提到企业微信文档、创建文档、编辑文档、新建文档、写文档、智能表格时激活。支持文档创建/写入和智能表格的创建及子表/字段/记录写入。注意:所有文档创建和编辑请求都应使用此 skill,不要尝试用其他方式处理文档操作。
|
|
4
|
+
metadata:
|
|
5
|
+
{
|
|
6
|
+
"openclaw":
|
|
7
|
+
{
|
|
8
|
+
"emoji": "📄",
|
|
9
|
+
"always": true,
|
|
10
|
+
"requires":
|
|
11
|
+
{
|
|
12
|
+
"bins": ["mcporter"],
|
|
13
|
+
},
|
|
14
|
+
"install":
|
|
15
|
+
[
|
|
16
|
+
{
|
|
17
|
+
"id": "mcporter",
|
|
18
|
+
"kind": "node",
|
|
19
|
+
"package": "mcporter",
|
|
20
|
+
"bins": ["mcporter"],
|
|
21
|
+
"label": "Install mcporter (npm)",
|
|
22
|
+
},
|
|
23
|
+
],
|
|
24
|
+
},
|
|
25
|
+
}
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
# 企业微信文档与智能表格工具
|
|
29
|
+
|
|
30
|
+
通过 mcporter 调用 wecom-doc MCP server 操作企业微信文档和智能表格。
|
|
31
|
+
|
|
32
|
+
## 意图处理
|
|
33
|
+
|
|
34
|
+
当用户说"创建文档"、"新建文档"、"帮我写个文档"等**不指定平台**的请求时,默认使用企业微信文档,无需询问用户使用什么平台。
|
|
35
|
+
|
|
36
|
+
## 前置检查(每次会话首次操作前必须执行)
|
|
37
|
+
|
|
38
|
+
> **自动续接原则**:前置检查中的任何环节如果需要等待用户确认或操作(安装、配置、授权等),在该操作完成后必须**自动继续执行后续步骤**,最终完成用户的原始请求。不要在中间环节完成后停下来等用户重复发起请求。
|
|
39
|
+
|
|
40
|
+
### 1. 检查 mcporter 是否安装
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
which mcporter
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
如果 `mcporter` **不在 PATH 中**(命令返回空或 not found),**必须原样输出以下提示**(不要修改、不要摘要):
|
|
47
|
+
|
|
48
|
+
> 企业微信文档能力依赖 mcporter 工具,当前尚未安装。需要我帮你安装吗?
|
|
49
|
+
|
|
50
|
+
输出提示后**停止执行并等待用户回复**。
|
|
51
|
+
|
|
52
|
+
- 如果用户**确认安装**(回复"好"、"是"、"装吧"、"yes"、"ok" 等肯定语义),**立即执行**:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
npm install -g mcporter
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
安装完成后**不要停下来**,直接继续执行后续的「检查 MCP Server 是否配置」步骤,无缝衔接用户原始请求。
|
|
59
|
+
|
|
60
|
+
- 如果用户**拒绝安装**,回复:
|
|
61
|
+
|
|
62
|
+
> 好的,你也可以手动执行 `npm install -g mcporter` 安装后再找我。
|
|
63
|
+
|
|
64
|
+
### 2. 确保 MCP Server 已配置
|
|
65
|
+
|
|
66
|
+
确认 mcporter 存在后,先检查配置是否已存在,仅在未配置时才尝试自动配置。
|
|
67
|
+
|
|
68
|
+
**验证配置:**
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
mcporter list wecom-doc --output json
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
如果返回正常(包含 tool 列表),说明已配置,**跳过自动配置,直接进入步骤 3**。
|
|
75
|
+
|
|
76
|
+
如果返回 **server not found**、**unknown server** 或类似错误,执行下方自动配置。
|
|
77
|
+
|
|
78
|
+
**自动配置(仅在未配置时执行):**
|
|
79
|
+
|
|
80
|
+
读取 wecom 运行时配置文件,该文件由 wecom channel 长连接建立时写入:
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
cat ~/.openclaw/wecomConfig/config.json
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
检查 JSON 中是否存在 `mcpConfig.doc` 字段(含 `type` 和 `url`),如果存在则执行:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
mcporter config add wecom-doc \
|
|
90
|
+
--type "<mcpConfig.doc.type的值>" \
|
|
91
|
+
--url "<mcpConfig.doc.url的值>"
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
配置完成后**再次执行** `mcporter list wecom-doc --output json` 验证。如果仍然失败,按下方"MCP Server 未配置"章节处理。
|
|
95
|
+
|
|
96
|
+
> ⚠️ 配置文件不存在或缺少 `mcpConfig.doc` 字段,说明 wecom channel 长连接尚未建立,应引导用户检查 wecom channel 是否正常运行。自动配置失败不应阻断流程,继续引导用户手动配置。
|
|
97
|
+
|
|
98
|
+
### 3. 获取 Tool 列表
|
|
99
|
+
|
|
100
|
+
`mcporter list` 成功后,返回的每个 tool 包含 `name`、`description`、`inputSchema`。
|
|
101
|
+
|
|
102
|
+
**不要硬编码 tool name 和参数**,据此构造 `mcporter call wecom-doc.<tool> --args '{...}' --output json` 调用。
|
|
103
|
+
|
|
104
|
+
## docid 管理规则(重要)
|
|
105
|
+
|
|
106
|
+
**仅支持对通过本 skill 创建的文档或智能表格进行编辑。**
|
|
107
|
+
|
|
108
|
+
### docid 的获取方式
|
|
109
|
+
|
|
110
|
+
docid **只能**通过 `create_doc` 的返回结果获取。创建成功后需要**保存返回的 docid**,后续编辑操作依赖此 ID。
|
|
111
|
+
|
|
112
|
+
### 不支持从 URL 解析 docid
|
|
113
|
+
|
|
114
|
+
从文档 URL(如 `https://doc.weixin.qq.com/doc/...`)中**无法解析到可用的 docid**。如果用户提供了文档 URL 并要求编辑,**不要尝试从 URL 中提取 docid**。
|
|
115
|
+
|
|
116
|
+
### 编辑操作的 docid 校验
|
|
117
|
+
|
|
118
|
+
当用户请求编辑文档或智能表格时,如果当前会话中**没有**通过 `create_doc` 获取到的 docid,**必须原样输出以下提示**(不要修改、不要摘要):
|
|
119
|
+
|
|
120
|
+
> 仅支持对机器人创建的文档进行编辑
|
|
121
|
+
|
|
122
|
+
### docid 类型判断
|
|
123
|
+
|
|
124
|
+
| doc_id 前缀 | 类型 | doc_type |
|
|
125
|
+
|-------------|------|----------|
|
|
126
|
+
| `w3_` | 文档 | 3 |
|
|
127
|
+
| `s3_` | 智能表格 | 10 |
|
|
128
|
+
|
|
129
|
+
## 工作流
|
|
130
|
+
|
|
131
|
+
### 文档操作流
|
|
132
|
+
|
|
133
|
+
1. 如需新建文档 → `create_doc`(`doc_type: 3`)→ **保存返回的 `docid`**
|
|
134
|
+
2. 如需编辑内容 → 先确认当前会话中有通过 `create_doc` 获取的 `docid`,若无则提示"仅支持对机器人创建的文档进行编辑" → `edit_doc_content`(`content_type: 1` 使用 markdown,全量覆写)
|
|
135
|
+
|
|
136
|
+
> `edit_doc_content` 是**全量覆写**操作。如需追加内容,应先了解原有内容再拼接。
|
|
137
|
+
|
|
138
|
+
### 智能表格操作流
|
|
139
|
+
|
|
140
|
+
操作层级:**文档(docid)→ 子表(sheet_id)→ 字段(field_id)/ 记录(record_id)**
|
|
141
|
+
|
|
142
|
+
1. 如需新建智能表 → `create_doc`(`doc_type: 10`)→ **保存返回的 `docid`**
|
|
143
|
+
2. 如需编辑已有智能表 → 先确认当前会话中有通过 `create_doc` 获取的 `docid`,若无则提示"仅支持对机器人创建的文档进行编辑"
|
|
144
|
+
3. 查询已有子表 → `smartsheet_get_sheet` → 获取 `sheet_id`
|
|
145
|
+
4. 如需新建子表 → `smartsheet_add_sheet` → 获取新的 `sheet_id`
|
|
146
|
+
5. 查询已有字段 → `smartsheet_get_fields` → 获取 `field_id`、`field_title`、`field_type`
|
|
147
|
+
6. 如需添加字段 → `wedoc_smartsheet_add_fields`
|
|
148
|
+
7. 如需更新字段 → `wedoc_smartsheet_update_fields`(**不能改变字段类型**)
|
|
149
|
+
8. 添加数据记录 → `smartsheet_add_records`(values 的 key **必须**使用字段标题 field_title,不能用 field_id)
|
|
150
|
+
|
|
151
|
+
### 从零创建智能表完整流程
|
|
152
|
+
|
|
153
|
+
```
|
|
154
|
+
create_doc(doc_type=10) → docid
|
|
155
|
+
└→ smartsheet_add_sheet(docid) → sheet_id
|
|
156
|
+
└→ wedoc_smartsheet_add_fields(docid, sheet_id, fields) → field_ids
|
|
157
|
+
└→ smartsheet_add_records(docid, sheet_id, records)
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### 向已有智能表添加数据流程
|
|
161
|
+
|
|
162
|
+
```
|
|
163
|
+
smartsheet_get_sheet(docid) → sheet_id
|
|
164
|
+
└→ smartsheet_get_fields(docid, sheet_id) → field_ids + field_titles + field_types
|
|
165
|
+
└→ smartsheet_add_records(docid, sheet_id, records)
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
> **重要**:添加记录前**必须**先通过 `smartsheet_get_fields` 获取字段信息,确保 `values` 中的 key 和 value 格式正确。
|
|
169
|
+
|
|
170
|
+
## 业务知识(MCP Schema 中缺失的上下文)
|
|
171
|
+
|
|
172
|
+
以下信息是 MCP tool 的 inputSchema 中没有的,Agent 构造参数时必须参考。
|
|
173
|
+
|
|
174
|
+
### FieldType 枚举(16 种)
|
|
175
|
+
|
|
176
|
+
| 类型 | 说明 | 使用场景建议 |
|
|
177
|
+
|------|------|-------------|
|
|
178
|
+
| `FIELD_TYPE_TEXT` | 文本 | 通用文本内容;当用户只提供了成员**姓名**(而非 user_id)时,也应使用 TEXT 而非 USER |
|
|
179
|
+
| `FIELD_TYPE_NUMBER` | 数字 | 数值型数据(金额、数量、评分等) |
|
|
180
|
+
| `FIELD_TYPE_CHECKBOX` | 复选框 | 是/否、完成/未完成等布尔状态 |
|
|
181
|
+
| `FIELD_TYPE_DATE_TIME` | 日期时间 | 日期、截止时间、创建时间等 |
|
|
182
|
+
| `FIELD_TYPE_IMAGE` | 图片 | 需要展示图片的场景 |
|
|
183
|
+
| `FIELD_TYPE_USER` | 成员 | **仅**在明确知道成员 user_id 时使用;若用户只提供了姓名,应使用 TEXT 代替 |
|
|
184
|
+
| `FIELD_TYPE_URL` | 链接 | 网址、外部链接 |
|
|
185
|
+
| `FIELD_TYPE_SELECT` | 多选 | 标签、多分类等允许多选的场景 |
|
|
186
|
+
| `FIELD_TYPE_SINGLE_SELECT` | 单选 | 状态、优先级、严重程度、分类等有固定选项的字段 |
|
|
187
|
+
| `FIELD_TYPE_PROGRESS` | 进度 | 完成进度、完成百分比(值为 0-100 整数) |
|
|
188
|
+
| `FIELD_TYPE_PHONE_NUMBER` | 手机号 | 手机号码 |
|
|
189
|
+
| `FIELD_TYPE_EMAIL` | 邮箱 | 邮箱地址 |
|
|
190
|
+
| `FIELD_TYPE_LOCATION` | 位置 | 地理位置信息 |
|
|
191
|
+
| `FIELD_TYPE_CURRENCY` | 货币 | 金额(带货币符号) |
|
|
192
|
+
| `FIELD_TYPE_PERCENTAGE` | 百分比 | 百分比数值(值为 0~1) |
|
|
193
|
+
| `FIELD_TYPE_BARCODE` | 条码 | 条形码、ISBN 等 |
|
|
194
|
+
|
|
195
|
+
### FieldType ↔ CellValue 对照表
|
|
196
|
+
|
|
197
|
+
添加记录(`smartsheet_add_records`)时,`values` 中每个字段的 **key 必须使用字段标题(field_title),不能使用 field_id**。value 必须匹配其字段类型:
|
|
198
|
+
|
|
199
|
+
| 字段类型 | CellValue 格式 | 示例 |
|
|
200
|
+
|---------|---------------|------|
|
|
201
|
+
| `TEXT` | CellTextValue 数组 | `[{"type": "text", "text": "内容"}]` |
|
|
202
|
+
| `NUMBER` | number | `85` |
|
|
203
|
+
| `CHECKBOX` | boolean | `true` |
|
|
204
|
+
| `DATE_TIME` | 日期时间**字符串** | `"2023-01-01 12:00:00"`、`"2023-01-01 12:00"`、`"2023-01-01"` |
|
|
205
|
+
| `URL` | CellUrlValue 数组(限 1 个) | `[{"type": "url", "text": "百度", "link": "https://baidu.com"}]` |
|
|
206
|
+
| `USER` | CellUserValue 数组 | `[{"user_id": "zhangsan"}]` |
|
|
207
|
+
| `IMAGE` | CellImageValue 数组 | `[{"image_url": "https://..."}]`(`id`、`title` 可选) |
|
|
208
|
+
| `SELECT` | Option 数组(多选) | `[{"text": "选项A"}, {"text": "选项B"}]` |
|
|
209
|
+
| `SINGLE_SELECT` | Option 数组(限 1 个) | `[{"text": "选项A"}]` |
|
|
210
|
+
| `PROGRESS` | number(0~100 整数) | `85`(表示 85%) |
|
|
211
|
+
| `CURRENCY` | number | `99.5` |
|
|
212
|
+
| `PERCENTAGE` | number(0~1) | `0.85` |
|
|
213
|
+
| `PHONE_NUMBER` | string | `"13800138000"` |
|
|
214
|
+
| `EMAIL` | string | `"user@example.com"` |
|
|
215
|
+
| `BARCODE` | string | `"978-3-16-148410-0"` |
|
|
216
|
+
| `LOCATION` | CellLocationValue 数组(限 1 个) | `[{"source_type": 1, "id": "xxx", "latitude": "39.9", "longitude": "116.3", "title": "北京"}]` |
|
|
217
|
+
|
|
218
|
+
> **Option 格式说明**:`SINGLE_SELECT`/`SELECT` 的选项支持 `style` 字段(1~27 对应不同颜色),如 `[{"text": "紧急", "style": 1}]`。`style` 为可选字段,不传则使用默认颜色。
|
|
219
|
+
|
|
220
|
+
### 易错点
|
|
221
|
+
|
|
222
|
+
- `DATE_TIME` 的值是**日期时间字符串**,支持 `"YYYY-MM-DD HH:MM:SS"`(精确到秒)、`"YYYY-MM-DD HH:MM"`(精确到分)、`"YYYY-MM-DD"`(精确到天),系统自动按东八区转换为时间戳,无需手动计算
|
|
223
|
+
- `CellUrlValue` 的链接字段名是 **`link`**,不是 `url`
|
|
224
|
+
- `TEXT` 类型的值**必须**使用数组格式 `[{"type": "text", "text": "内容"}]`,外层方括号不可省略,不能传单个对象 `{"type":"text","text":"内容"}`
|
|
225
|
+
- `SINGLE_SELECT`/`SELECT` 类型的值**必须**使用数组格式 `[{"text": "选项内容"}]`,不能直接传字符串
|
|
226
|
+
- `PROGRESS` 的值范围是 **0~100 整数**(85 = 85%);`PERCENTAGE` 的值范围是 **0~1**(0.85 = 85%),两者不同注意区分
|
|
227
|
+
- `wedoc_smartsheet_update_fields` **不能更改字段类型**,只能改标题和属性
|
|
228
|
+
- `values` 的 key **必须**使用**字段标题**(field_title),**不能**使用 field_id
|
|
229
|
+
- 不可写入的字段类型:创建时间、最后编辑时间、创建人、最后编辑人
|
|
230
|
+
|
|
231
|
+
## 错误处理
|
|
232
|
+
|
|
233
|
+
### MCP 错误响应处理(重要)
|
|
234
|
+
|
|
235
|
+
当 `mcporter call` 返回结果中 `errcode` 不为 0 且 `help_message` 有值时,将 `help_message` 中面向用户的内容输出给用户。
|
|
236
|
+
|
|
237
|
+
**输出原则:**
|
|
238
|
+
|
|
239
|
+
- **完整性**:不截断、不摘要
|
|
240
|
+
- **原样性**:不改写、不重新排版
|
|
241
|
+
- **用户可读性**:只输出面向用户的内容,过滤掉给 Agent 的元指令(如"将以下内容告知用户"等引导语);直接以 markdown 形式输出,不要包裹在代码块中
|
|
242
|
+
|
|
243
|
+
### 错误码 850001:需要用户提供配置
|
|
244
|
+
|
|
245
|
+
当 `errcode` 为 `850001` 时:
|
|
246
|
+
|
|
247
|
+
1. 将 `help_message` 中面向用户的内容**原样输出**(遵循上方输出原则)
|
|
248
|
+
2. 输出后**等待用户回复**,后续流程与「MCP Server 未配置」的场景 A / B / C 一致。配置成功后**不要停下来**,立即回到「前置检查」的步骤 2 重新验证配置,验证通过后继续执行用户的原始请求。
|
|
249
|
+
|
|
250
|
+
### MCP Server 未配置
|
|
251
|
+
|
|
252
|
+
如果 `mcporter call wecom-doc.*` 或 `mcporter list wecom-doc` 返回 **server not found**、**unknown server** 或类似错误,说明 wecom-doc MCP server 尚未配置。
|
|
253
|
+
|
|
254
|
+
此时需要**检测运行环境**以提供针对性的提示。按以下步骤执行:
|
|
255
|
+
|
|
256
|
+
#### 步骤一:检测是否在 OpenClaw 运行时中
|
|
257
|
+
|
|
258
|
+
通过检测 `OPENCLAW_SHELL` 环境变量判断当前是否运行在 OpenClaw 中。该变量是 OpenClaw **运行时自动注入到子进程**中的标记,不会因为机器上安装了 openclaw 就存在——只有 skill 确实在 OpenClaw 中被调用时,exec 执行的命令才会携带此变量。
|
|
259
|
+
|
|
260
|
+
```bash
|
|
261
|
+
echo "OPENCLAW_SHELL=${OPENCLAW_SHELL:-}" && command -v openclaw 2>/dev/null && echo "OPENCLAW_CLI=FOUND" || echo "OPENCLAW_CLI=NOT_FOUND"
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
判断规则:
|
|
265
|
+
- **`OPENCLAW_SHELL` 为空**(输出 `OPENCLAW_SHELL=`)→ 当前不在 OpenClaw 运行时中,跳到**「通用提示」**。
|
|
266
|
+
- **`OPENCLAW_SHELL` 非空**(如 `exec`、`tui-local` 等)**且** `OPENCLAW_CLI=FOUND` → 确认在 OpenClaw 中且 CLI 可用,继续步骤二。
|
|
267
|
+
- **`OPENCLAW_SHELL` 非空但 `OPENCLAW_CLI=NOT_FOUND`** → 虽然在 OpenClaw 中但 CLI 不可用,跳到**「通用提示」**。
|
|
268
|
+
|
|
269
|
+
> 为什么不能仅用 `command -v openclaw`:同一台机器可能同时安装了 openclaw 和 claude 等其他 AI 工具。仅检测 CLI 是否存在无法区分"装了 openclaw"和"正在 openclaw 中运行"。`OPENCLAW_SHELL` 是进程级的运行时标记,从根本上解决此问题。
|
|
270
|
+
|
|
271
|
+
#### 步骤二:查询 wecom channel 的 botId 配置
|
|
272
|
+
|
|
273
|
+
```bash
|
|
274
|
+
openclaw config get channels.wecom.botId 2>&1
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
- 如果命令返回了**具体的 botId 值**(非空、非报错),保存该值,跳到**「OpenClaw 场景 + 有 botId 提示」**。
|
|
278
|
+
- 如果返回 `Config path not found`、报错或为空,跳到**「通用提示」**。
|
|
279
|
+
|
|
280
|
+
#### 异常容错
|
|
281
|
+
|
|
282
|
+
如果上述任何命令执行失败(如 exec 工具不可用、命令超时等),一律跳到**「通用提示」**。
|
|
283
|
+
|
|
284
|
+
---
|
|
285
|
+
|
|
286
|
+
#### OpenClaw 场景 + 有 botId 提示
|
|
287
|
+
|
|
288
|
+
当确认是 OpenClaw 环境且获取到了 botId 时,**必须原样输出以下提示**(不要修改、不要摘要),将 `XXXX` 替换为实际获取到的 botId 值:
|
|
289
|
+
|
|
290
|
+
> 若你是智能机器人创建者,可以[点击这里](https://work.weixin.qq.com/ai/aiHelper/authorizationPage?str_aibotid=XXXX&from=chat&forceInnerBrowser=1)授权当前机器人文档使用权限;
|
|
291
|
+
> 若你不是机器人创建者,可联系该机器人创建者,前往企业微信「工作台-智能机器人」找到对应机器人进行授权
|
|
292
|
+
> 若你已授权,可将对应机器人文档MCP的接入配置(StreamableHttp URL或者JSON Config)发送给我
|
|
293
|
+
|
|
294
|
+
输出提示后**等待用户回复**,后续流程与下方「通用提示」的后续流程一致(场景 A / B / C)。配置成功后**不要停下来**,立即回到「前置检查」的步骤 2 重新验证配置,验证通过后继续执行用户的原始请求。
|
|
295
|
+
|
|
296
|
+
---
|
|
297
|
+
|
|
298
|
+
#### 通用提示
|
|
299
|
+
|
|
300
|
+
当非 OpenClaw 环境、无法判断环境、或 OpenClaw 环境但未配置 wecom channel / botId 时,**必须原样输出以下提示文案**(不要修改、不要摘要):
|
|
301
|
+
|
|
302
|
+
> 机器人可通过MCP方式调用文档相关能力,当前暂未完成所需配置。请参考以下配置指引:
|
|
303
|
+
>
|
|
304
|
+
> 1. 请前往「企业微信-工作台-智能机器人应用」,以API模式创建机器人(如已创建,可忽略该步骤)
|
|
305
|
+
>
|
|
306
|
+
> 2. 授权该机器人「文档」使用权限。授权后,可自行选择StreamableHttp URL 或 JSON Config 进行配置。
|
|
307
|
+
|
|
308
|
+
输出提示后**等待用户回复**。用户可能:
|
|
309
|
+
|
|
310
|
+
**场景 A:用户提供了 StreamableHttp URL**
|
|
311
|
+
|
|
312
|
+
从用户消息中提取 URL,执行:
|
|
313
|
+
|
|
314
|
+
```bash
|
|
315
|
+
mcporter config add wecom-doc \
|
|
316
|
+
--type streamable-http \
|
|
317
|
+
--url "<用户提供的URL>"
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
配置完成后**不要停下来**,立即回到「前置检查」的步骤 2 重新验证配置,验证通过后继续执行用户的原始请求。
|
|
321
|
+
|
|
322
|
+
**场景 B:用户提供了 JSON 配置**
|
|
323
|
+
|
|
324
|
+
如果用户提供了类似以下格式的 JSON:
|
|
325
|
+
|
|
326
|
+
```json
|
|
327
|
+
{
|
|
328
|
+
"name": "wecom-doc",
|
|
329
|
+
"type": "streamable-http",
|
|
330
|
+
"url": "http://xxx"
|
|
331
|
+
}
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
从 JSON 中提取 `url` 字段,执行:
|
|
335
|
+
|
|
336
|
+
```bash
|
|
337
|
+
mcporter config add wecom-doc \
|
|
338
|
+
--type streamable-http \
|
|
339
|
+
--url "<从JSON提取的url>"
|
|
340
|
+
```
|
|
341
|
+
|
|
342
|
+
配置完成后**不要停下来**,立即回到「前置检查」的步骤 2 重新验证配置,验证通过后继续执行用户的原始请求。
|
|
343
|
+
|
|
344
|
+
**场景 C:用户自行完成了配置**
|
|
345
|
+
|
|
346
|
+
用户可能在管理后台或其他途径自行完成配置后告知已配置好,此时直接继续执行原来的操作。
|
|
347
|
+
|
|
348
|
+
> **配置检测**:当用户输入的内容包含 URL(如 `http://...`)或 JSON(含 `"type": "streamable-http"`),应判断用户意图是在提供 MCP server 配置信息,自动执行配置命令。
|
|
349
|
+
|
|
350
|
+
### Daemon 未启动
|
|
351
|
+
|
|
352
|
+
如果返回 **connection refused** 或 **daemon not running** 错误,提示用户:
|
|
353
|
+
|
|
354
|
+
```bash
|
|
355
|
+
mcporter daemon start
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
## 注意事项
|
|
360
|
+
|
|
361
|
+
- 所有调用通过 `mcporter call wecom-doc.<tool>` 执行,不要直接调用企业微信 API
|
|
362
|
+
- `create_doc` 返回的 `docid` 需要保存,后续操作依赖此 ID
|
|
363
|
+
- 添加记录前**必须**先 `smartsheet_get_fields` 获取字段元信息
|
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
# 企业微信文档 API 参考
|
|
2
|
+
|
|
3
|
+
## 文档类型
|
|
4
|
+
|
|
5
|
+
| doc_type | 类型 | doc_id 前缀 | URL 路径 |
|
|
6
|
+
|----------|------|------------|---------|
|
|
7
|
+
| 3 | 文档 | `w3_` | `/doc/` |
|
|
8
|
+
| 10 | 智能表格 | `s3_` | `/smartsheet/` |
|
|
9
|
+
|
|
10
|
+
## URL 格式
|
|
11
|
+
|
|
12
|
+
### 文档
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
https://doc.weixin.qq.com/doc/{doc_id}?scode=xxx
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
示例:
|
|
19
|
+
```
|
|
20
|
+
https://doc.weixin.qq.com/doc/w3_AMEA4QYkACkCNN7hNRzRzQkaElHbQ?scode=AJEAIQdfAAodYknI73AMEA4QYkACk
|
|
21
|
+
→ doc_id = w3_AMEA4QYkACkCNN7hNRzRzQkaElHbQ
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### 智能表格
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
https://doc.weixin.qq.com/smartsheet/{doc_id}
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
示例:
|
|
31
|
+
```
|
|
32
|
+
https://doc.weixin.qq.com/smartsheet/s3_ATAA_QaoAKQCNIQ6XYeEYQ3q5Rv05
|
|
33
|
+
→ doc_id = s3_ATAA_QaoAKQCNIQ6XYeEYQ3q5Rv05
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
> 始终忽略 `?` 之后的查询参数。
|
|
37
|
+
|
|
38
|
+
## 智能表格字段类型(FieldType)
|
|
39
|
+
|
|
40
|
+
完整 16 种类型:
|
|
41
|
+
|
|
42
|
+
| 枚举值 | 说明 |
|
|
43
|
+
|--------|------|
|
|
44
|
+
| `FIELD_TYPE_TEXT` | 文本 |
|
|
45
|
+
| `FIELD_TYPE_NUMBER` | 数字 |
|
|
46
|
+
| `FIELD_TYPE_CHECKBOX` | 复选框 |
|
|
47
|
+
| `FIELD_TYPE_DATE_TIME` | 日期时间 |
|
|
48
|
+
| `FIELD_TYPE_IMAGE` | 图片 |
|
|
49
|
+
| `FIELD_TYPE_USER` | 成员 |
|
|
50
|
+
| `FIELD_TYPE_URL` | 链接 |
|
|
51
|
+
| `FIELD_TYPE_SELECT` | 多选 |
|
|
52
|
+
| `FIELD_TYPE_SINGLE_SELECT` | 单选 |
|
|
53
|
+
| `FIELD_TYPE_PROGRESS` | 进度 |
|
|
54
|
+
| `FIELD_TYPE_PHONE_NUMBER` | 手机号 |
|
|
55
|
+
| `FIELD_TYPE_EMAIL` | 邮箱 |
|
|
56
|
+
| `FIELD_TYPE_LOCATION` | 位置 |
|
|
57
|
+
| `FIELD_TYPE_CURRENCY` | 货币 |
|
|
58
|
+
| `FIELD_TYPE_PERCENTAGE` | 百分比 |
|
|
59
|
+
| `FIELD_TYPE_BARCODE` | 条码 |
|
|
60
|
+
|
|
61
|
+
## CellValue 类型完整对照
|
|
62
|
+
|
|
63
|
+
### CellTextValue — 文本字段
|
|
64
|
+
|
|
65
|
+
```json
|
|
66
|
+
[
|
|
67
|
+
{"type": "text", "text": "普通文本"},
|
|
68
|
+
{"type": "url", "text": "链接文本", "link": "https://example.com"}
|
|
69
|
+
]
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
- `type`(必填):`"text"` 或 `"url"`
|
|
73
|
+
- `text`(必填):文本内容
|
|
74
|
+
- `link`(当 type 为 url 时):链接跳转 URL
|
|
75
|
+
|
|
76
|
+
适用:`FIELD_TYPE_TEXT`
|
|
77
|
+
|
|
78
|
+
### 数字类 — number
|
|
79
|
+
|
|
80
|
+
直接传 number 值。
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
85
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
适用:`FIELD_TYPE_NUMBER`、`FIELD_TYPE_PROGRESS`、`FIELD_TYPE_CURRENCY`、`FIELD_TYPE_PERCENTAGE`
|
|
87
|
+
|
|
88
|
+
### 布尔值 — boolean
|
|
89
|
+
|
|
90
|
+
```json
|
|
91
|
+
true
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
适用:`FIELD_TYPE_CHECKBOX`
|
|
95
|
+
|
|
96
|
+
### 字符串类 — string
|
|
97
|
+
|
|
98
|
+
直接传字符串。
|
|
99
|
+
|
|
100
|
+
适用场景:
|
|
101
|
+
- `FIELD_TYPE_DATE_TIME`:毫秒 unix 时间戳字符串,如 `"1672531200000"`
|
|
102
|
+
- `FIELD_TYPE_PHONE_NUMBER`:手机号字符串,如 `"13800138000"`
|
|
103
|
+
- `FIELD_TYPE_EMAIL`:邮箱字符串,如 `"user@example.com"`
|
|
104
|
+
- `FIELD_TYPE_BARCODE`:条码字符串,如 `"978-3-16-148410-0"`
|
|
105
|
+
|
|
106
|
+
### CellUrlValue — 链接字段
|
|
107
|
+
|
|
108
|
+
```json
|
|
109
|
+
[{"type": "url", "text": "显示文本", "link": "https://example.com"}]
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
- `type`(必填):固定 `"url"`
|
|
113
|
+
- `link`(必填):链接跳转 URL
|
|
114
|
+
- `text`(可选):链接显示文本
|
|
115
|
+
|
|
116
|
+
> 注意:字段名是 **`link`** 不是 `url`。数组为预留能力,目前只支持 1 个链接。
|
|
117
|
+
|
|
118
|
+
适用:`FIELD_TYPE_URL`
|
|
119
|
+
|
|
120
|
+
### CellUserValue — 成员字段
|
|
121
|
+
|
|
122
|
+
```json
|
|
123
|
+
[{"user_id": "zhangsan"}]
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
- `user_id`(必填):成员 ID
|
|
127
|
+
|
|
128
|
+
适用:`FIELD_TYPE_USER`
|
|
129
|
+
|
|
130
|
+
### CellImageValue — 图片字段
|
|
131
|
+
|
|
132
|
+
```json
|
|
133
|
+
[{
|
|
134
|
+
"id": "img1",
|
|
135
|
+
"title": "截图",
|
|
136
|
+
"image_url": "https://...",
|
|
137
|
+
"width": 800,
|
|
138
|
+
"height": 600
|
|
139
|
+
}]
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
- `id`:图片 ID(自定义)
|
|
143
|
+
- `title`:图片标题
|
|
144
|
+
- `image_url`:图片链接(通过上传图片接口获取)
|
|
145
|
+
- `width` / `height`:图片尺寸
|
|
146
|
+
|
|
147
|
+
适用:`FIELD_TYPE_IMAGE`
|
|
148
|
+
|
|
149
|
+
### CellAttachmentValue — 文件字段
|
|
150
|
+
|
|
151
|
+
```json
|
|
152
|
+
[{
|
|
153
|
+
"name": "文件名",
|
|
154
|
+
"size": 1024,
|
|
155
|
+
"file_ext": "DOC",
|
|
156
|
+
"file_id": "xxx",
|
|
157
|
+
"file_url": "https://...",
|
|
158
|
+
"file_type": "50"
|
|
159
|
+
}]
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
- `file_ext` 取值:`DOC`、`SHEET`、`SLIDE`、`MIND`、`FLOWCHART`、`SMARTSHEET`、`FORM`,或文件扩展名
|
|
163
|
+
- `file_type` 取值:`Folder`(文件夹)、`Wedrive`(微盘文件)、`30`(收集表)、`50`(文档)、`51`(表格)、`52`(幻灯片)、`54`(思维导图)、`55`(流程图)、`70`(智能表)
|
|
164
|
+
|
|
165
|
+
### Option — 选项(单选/多选字段)
|
|
166
|
+
|
|
167
|
+
```json
|
|
168
|
+
[{"text": "选项A", "style": 1}, {"text": "选项B", "style": 5}]
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
- `text`:选项内容。新增选项时填写,已存在时优先匹配
|
|
172
|
+
- `id`(可选):选项 ID,已存在的选项通过 ID 识别
|
|
173
|
+
- `style`(可选):选项颜色,1-27
|
|
174
|
+
|
|
175
|
+
适用:`FIELD_TYPE_SELECT`(多选,可传多个)、`FIELD_TYPE_SINGLE_SELECT`(单选,建议传 1 个)
|
|
176
|
+
|
|
177
|
+
### CellLocationValue — 位置字段
|
|
178
|
+
|
|
179
|
+
```json
|
|
180
|
+
[{
|
|
181
|
+
"source_type": 1,
|
|
182
|
+
"id": "地点ID",
|
|
183
|
+
"latitude": "39.9042",
|
|
184
|
+
"longitude": "116.4074",
|
|
185
|
+
"title": "北京天安门"
|
|
186
|
+
}]
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
- `source_type`(必填):固定 `1`(腾讯地图)
|
|
190
|
+
- `id`(必填):地点 ID
|
|
191
|
+
- `latitude`(必填):纬度(字符串)
|
|
192
|
+
- `longitude`(必填):经度(字符串)
|
|
193
|
+
- `title`(必填):地点名称
|
|
194
|
+
|
|
195
|
+
> 数组长度不大于 1。
|
|
196
|
+
|
|
197
|
+
适用:`FIELD_TYPE_LOCATION`
|
|
198
|
+
|
|
199
|
+
## 选项样式(Style)
|
|
200
|
+
|
|
201
|
+
取值 1-27 对应颜色:
|
|
202
|
+
|
|
203
|
+
| 值 | 颜色 | 值 | 颜色 | 值 | 颜色 |
|
|
204
|
+
|----|------|----|------|----|------|
|
|
205
|
+
| 1 | 浅红 | 10 | 浅蓝 | 19 | 浅橙 |
|
|
206
|
+
| 2 | 浅橙 | 11 | 浅蓝 | 20 | 橙 |
|
|
207
|
+
| 3 | 浅天蓝 | 12 | 蓝 | 21 | 浅黄 |
|
|
208
|
+
| 4 | 浅绿 | 13 | 浅天蓝 | 22 | 浅黄 |
|
|
209
|
+
| 5 | 浅紫 | 14 | 天蓝 | 23 | 黄 |
|
|
210
|
+
| 6 | 浅粉红 | 15 | 浅绿 | 24 | 浅紫 |
|
|
211
|
+
| 7 | 浅灰 | 16 | 绿 | 25 | 紫 |
|
|
212
|
+
| 8 | 白 | 17 | 浅红 | 26 | 浅粉红 |
|
|
213
|
+
| 9 | 灰 | 18 | 红 | 27 | 粉红 |
|
|
214
|
+
|
|
215
|
+
## 限制
|
|
216
|
+
|
|
217
|
+
| 维度 | 限制 |
|
|
218
|
+
|------|------|
|
|
219
|
+
| 文档名称 | 最多 255 字符 |
|
|
220
|
+
| 子表字段数 | 单表最多 150 个 |
|
|
221
|
+
| 记录数 | 单表最多 100,000 行 |
|
|
222
|
+
| 单元格数 | 单表最多 15,000,000 个 |
|
|
223
|
+
| 单次添加记录 | 建议 500 行内 |
|
|
224
|
+
| 不可写入字段 | 创建时间、最后编辑时间、创建人、最后编辑人 |
|
|
@@ -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 覆写
|