@wecom/wecom-openclaw-plugin 1.0.11 → 1.0.12-beta.1

package/dist/src/const.d.ts

@@ -46,8 +46,6 @@ export declare const MEDIA_DOCUMENT_PLACEHOLDER = "<media:document>";
 export declare const MCP_GET_CONFIG_CMD = "aibot_get_mcp_config";
 /** MCP 配置拉取超时时间（毫秒） */
 export declare const MCP_CONFIG_FETCH_TIMEOUT_MS = 15000;
-export declare const PLUGIN_JSON_FILENAME = "openclaw.plugin.json";
-export declare const PLUGIN_JSON_PATH: string;
 /** 默认媒体大小上限（MB） */
 export declare const DEFAULT_MEDIA_MAX_MB = 5;
 /** 文本分块大小上限 */

package/dist/src/interface.d.ts

@@ -31,19 +31,6 @@ export interface MessageState {
     /** deliver 回调是否被调用过（用于区分"核心无回复"和"核心回复了空内容"） */
     deliverCalled?: boolean;
 }
-/**
- * MCP 配置响应体
- */
-export interface McpConfigBody {
-    /** MCP Server 的 StreamableHttp URL */
-    url: string;
-    /** 连接类型，如 "streamable-http" */
-    type?: string;
-    /** 是否已授权 */
-    is_authed?: boolean;
-    /** mcp业务类型 */
-    biz_type?: string;
-}
 /**
  * WebSocket 请求消息基础格式
  */

package/dist/src/mcp/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * MCP 模块统一导出
+ */
+export { createWeComMcpTool } from "./tool.js";
+export { sendJsonRpc, clearCategoryCache, McpRpcError, McpHttpError, type McpToolInfo } from "./transport.js";
+export { cleanSchemaForGemini } from "./schema.js";

package/dist/src/mcp/schema.d.ts

@@ -0,0 +1,11 @@
+/**
+ * MCP Schema 清洗模块
+ *
+ * 负责内联 $ref/$defs 引用并移除 Gemini 不支持的 JSON Schema 关键词，
+ * 防止 Gemini 模型解析 function response 时报 400 错误。
+ */
+/**
+ * 清洗 JSON Schema，内联 $ref 引用并移除 Gemini 不支持的关键词，
+ * 防止 Gemini 模型解析 function response 时报 400 错误。
+ */
+export declare function cleanSchemaForGemini(schema: unknown): unknown;

package/dist/src/mcp/tool.d.ts

@@ -0,0 +1,51 @@
+/**
+ * wecom_mcp — 模拟 MCP 调用的 Agent Tool
+ *
+ * 通过 MCP Streamable HTTP 传输协议调用企业微信 MCP Server，
+ * 提供 list（列出所有工具）和 call（调用工具）两个操作。
+ *
+ * 在 skills 中的使用方式：
+ *   wecom_mcp list <category>
+ *   wecom_mcp call <category> <method> '<jsonArgs>'
+ *
+ * 示例：
+ *   wecom_mcp list contact
+ *   wecom_mcp call contact getContact '{}'
+ */
+/**
+ * 创建 wecom_mcp Agent Tool 定义
+ */
+export declare function createWeComMcpTool(): {
+    name: string;
+    label: string;
+    description: string;
+    parameters: {
+        type: "object";
+        properties: {
+            action: {
+                type: string;
+                enum: string[];
+                description: string;
+            };
+            category: {
+                type: string;
+                description: string;
+            };
+            method: {
+                type: string;
+                description: string;
+            };
+            args: {
+                type: string[];
+                description: string;
+            };
+        };
+        required: string[];
+    };
+    execute(_toolCallId: string, params: unknown): Promise<{
+        content: {
+            type: "text";
+            text: string;
+        }[];
+    }>;
+};

package/dist/src/mcp/transport.d.ts

@@ -0,0 +1,59 @@
+/**
+ * MCP Streamable HTTP 传输层模块
+ *
+ * 负责:
+ * - MCP JSON-RPC over HTTP 通信（发送请求、解析响应）
+ * - Streamable HTTP session 生命周期管理（initialize 握手 → Mcp-Session-Id 维护 → 失效重建）
+ * - 自动检测无状态 Server：如果 initialize 响应未返回 Mcp-Session-Id，
+ *   则标记为无状态模式，后续请求跳过握手和 session 管理
+ * - SSE 流式响应解析
+ * - MCP 配置运行时缓存（通过 WSClient 拉取 URL 并缓存在内存中）
+ */
+/**
+ * MCP JSON-RPC 错误
+ *
+ * 携带服务端返回的 JSON-RPC error.code，
+ * 用于上层按错误码进行差异化处理（如特定错误码触发缓存清理）。
+ */
+export declare class McpRpcError extends Error {
+    readonly code: number;
+    readonly data?: unknown | undefined;
+    constructor(code: number, message: string, data?: unknown | undefined);
+}
+/**
+ * MCP HTTP 错误
+ *
+ * 携带 HTTP 状态码，用于精确判断 session 失效（404）等场景，
+ * 避免通过字符串匹配 "404" 导致的误判。
+ */
+export declare class McpHttpError extends Error {
+    readonly statusCode: number;
+    constructor(statusCode: number, message: string);
+}
+/**
+ * 清理指定品类的所有 MCP 缓存（配置、会话、无状态标记）
+ *
+ * 当 MCP Server 返回特定错误码时调用，确保下次请求重新拉取配置并重建会话。
+ *
+ * @param category - MCP 品类名称
+ */
+export declare function clearCategoryCache(category: string): void;
+/** tools/list 返回的工具描述 */
+export interface McpToolInfo {
+    name: string;
+    description?: string;
+    inputSchema?: Record<string, unknown>;
+}
+/**
+ * 发送 JSON-RPC 请求到 MCP Server（Streamable HTTP 协议）
+ *
+ * 自动管理 session 生命周期：
+ * - 无状态 Server：跳过 session 管理，直接发送请求
+ * - 有状态 Server：首次调用先执行 initialize 握手，session 失效（404）时自动重建并重试
+ *
+ * @param category - MCP 品类名称
+ * @param method - JSON-RPC 方法名
+ * @param params - JSON-RPC 参数
+ * @returns JSON-RPC result
+ */
+export declare function sendJsonRpc(category: string, method: string, params?: Record<string, unknown>): Promise<unknown>;

package/dist/src/version.d.ts

@@ -0,0 +1,2 @@
+/** 插件版本号，来源于 package.json */
+export declare const PLUGIN_VERSION: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wecom/wecom-openclaw-plugin",
-  "version": "1.0.11",
+  "version": "1.0.12-beta.1",
   "type": "module",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
@@ -56,7 +56,7 @@
     }
   },
   "dependencies": {
-    "@wecom/aibot-node-sdk": "^1.0.2",
-    "file-type": "^21.3.0"
+    "file-type": "^21.3.0",
+    "@wecom/aibot-node-sdk": "^1.0.2"
   }
 }

package/skills/wecom-contact-lookup/SKILL.md

@@ -0,0 +1,160 @@
+---
+name: wecom-contact-lookup
+description: 通讯录成员查询技能，基于 MCP tool 协议封装的 `get_userlist` 接口，获取当前用户可见范围内的通讯录成员，支持按姓名/别名本地筛选匹配。返回 userid、姓名和别名。⚠️ 仅返回当前用户有权限查看的成员，非全量成员。
+---
+
+# 通讯录成员查询技能
+
+> `wecom_mcp` 是一个 MCP tool，所有操作通过调用该 tool 完成。
+
+通过 MCP tool 协议封装的 `get_userlist` 接口，获取当前用户可见范围内的通讯录成员，并在本地按姓名/别名进行筛选匹配。
+
+## 操作
+
+### 1. 获取全量通讯录成员
+
+获取当前用户可见范围内的所有企业成员信息：
+
+**调用示例：**
+
+使用 `wecom_mcp` tool 调用 `wecom_mcp call contact get_userlist '{}'`
+
+**返回格式：**
+
+```json
+{
+    "errcode": 0,
+    "errmsg": "ok",
+    "userlist": [
+        {
+            "userid": "zhangsan",
+            "name": "张三",
+            "alias": "Sam"
+        },
+        {
+            "userid": "lisi",
+            "name": "李四",
+            "alias": ""
+        }
+    ]
+}
+```
+
+**返回字段说明：**
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| `errcode` | integer | 返回码，`0` 表示成功 |
+| `errmsg` | string | 错误信息 |
+| `userlist` | array | 用户列表 |
+| `userlist[].userid` | string | 用户唯一 ID |
+| `userlist[].name` | string | 用户姓名 |
+| `userlist[].alias` | string | 用户别名，可能为空 |
+
+---
+
+### 2. 按姓名/别名搜索人员
+
+`get_userlist` 返回全量成员后，在本地对结果进行筛选匹配：
+
+- **精确匹配**：`name` 或 `alias` 与关键词完全一致，直接使用
+- **模糊匹配**：`name` 或 `alias` 包含关键词，返回所有匹配结果
+- **无结果**：告知用户未找到对应人员
+
+**搜索示例：**
+
+用户问："帮我找一下张三是谁？"
+
+1. 调用 `get_userlist` 获取全量成员
+2. 在 `userlist` 中筛选 `name` 或 `alias` 包含"张三"的成员
+3. 返回匹配结果
+
+---
+
+## 注意事项
+
+- `get_userlist` 返回的是当前用户**可见范围内**的成员，需经过可见性规则过滤，不一定是全公司所有人员；返回字段仅包含 `userid`、`name`（姓名）和 `alias`（别名）
+- ⚠️ **超过 10 人时接口将报错**：若 `userlist` 返回成员数量超过 10 人，视为异常，应立即停止处理并向用户说明：
+
+  > 当前通讯录可见成员数量为 N 人，超过了本技能支持的上限（10 人）。
+  > 本技能仅适用于可见范围较小的场景，无法在大范围通讯录中使用。
+  > 建议缩小可见范围后重试，或通过其他方式查询目标人员。
+
+- `userid` 是用户的唯一标识，在需要传递用户 ID 给其他接口时使用此字段
+- `alias` 字段可能为空字符串，搜索时需做空值判断
+- 若搜索结果有多个同名人员，需将所有候选人展示给用户选择，不得自行决定
+- 若 `errcode` 不为 `0`，说明接口调用失败，需告知用户错误信息（`errmsg`）
+
+---
+
+## 典型工作流
+
+### 工作流 1：查询人员信息
+
+用户问："帮我查一下 Sam 是谁？"
+
+1. 使用 `wecom_mcp` tool 调用 `wecom_mcp call contact get_userlist '{}'` 获取全量成员列表
+
+2. 在结果中筛选 `alias` 为 `Sam` 或 `name` 包含 `Sam` 的成员
+3. 若找到唯一匹配，直接展示结果：
+
+```
+📇 找到成员：
+- 姓名：张三
+- 别名：Sam
+- 用户ID：zhangsan
+```
+
+4. 若找到多个匹配，展示候选列表请用户确认：
+
+```
+🔍 找到多个匹配成员，请确认您要查询的是哪位：
+
+1. 张三（别名：Sam，ID：zhangsan）
+2. 张三丰（别名：Sam2，ID：zhangsan2）
+
+请问您要查询的是哪一位？
+```
+
+---
+
+### 工作流 2：为其他功能提供 userid 转换
+
+用户问："帮我发消息给张三"
+
+1. 使用 `wecom_mcp` tool 调用 `wecom_mcp call contact get_userlist '{}'` 获取全量成员
+
+2. 筛选 `name` 为"张三"的成员，确认 `userid`
+3. 将 `userid` 传递给消息发送接口
+
+---
+
+### 工作流 3：批量查询多个人员
+
+用户问："帮我查一下张三和李四分别是谁？"
+
+1. 使用 `wecom_mcp` tool 调用 `wecom_mcp call contact get_userlist '{}'` 获取全量成员列表
+
+2. 分别筛选"张三"和"李四"的匹配结果
+3. 汇总后一并展示
+
+> 注意：只需调用一次 `get_userlist`，在本地对结果进行多次筛选，避免重复调用接口。
+
+---
+
+## 快速参考
+
+### 接口说明
+
+| 接口 | 用途 | 输入 | 返回 |
+|------|------|------|------|
+| `get_userlist` | 获取可见范围内全量通讯录成员 | 无 | 用户列表（userid、name、alias） |
+
+### 本地筛选策略
+
+| 场景 | 策略 |
+|------|------|
+| 精确匹配（name 或 alias 完全一致） | 直接使用，无需用户确认 |
+| 模糊匹配（name 或 alias 包含关键词），唯一结果 | 直接使用，向用户展示结果 |
+| 模糊匹配，多个结果 | 展示候选列表，请用户选择 |
+| 无匹配结果 | 告知用户未找到对应人员 |

package/skills/wecom-doc-manager/SKILL.md

@@ -0,0 +1,53 @@
+---
+name: wecom-doc-manager
+description: 企业微信文档管理技能。提供文档的创建、读取和编辑能力，支持通过 docid 或文档 URL 操作企业微信文档（doc_type=3）和智能表格（doc_type=10）。适用场景：(1) 以 Markdown 格式导出获取文档完整内容（异步轮询） (2) 新建文档或智能表格 (3) 用 Markdown 格式覆写文档内容。当用户需要查看文档内容、创建新文档、编辑文档正文时触发此 Skill。
+---
+
+# 企业微信文档管理
+
+> `wecom_mcp` 是一个 MCP tool，所有操作通过调用该 tool 完成。
+
+管理企业微信文档的创建、读取和编辑。所有接口支持通过 `docid` 或 `url` 二选一定位文档。
+
+## CLI 调用方式
+
+通过 `wecom_mcp` tool 调用，品类为 `doc`：
+
+使用 `wecom_mcp` tool 调用 `wecom_mcp call doc <tool_name> '<json_params>'` 调用指定技能
+
+## 可用技能
+
+### get_doc_content
+
+获取文档完整内容数据，以 Markdown 格式返回。采用**异步轮询机制**：首次调用无需传 `task_id`，接口返回 `task_id`；若 `task_done` 为 false，需携带该 `task_id` 再次调用，直到 `task_done` 为 true 时返回完整内容。
+
+- 首次调用（不传 task_id）：使用 `wecom_mcp` tool 调用 `wecom_mcp call doc get_doc_content '{"docid": "DOCID", "type": 2}'`
+- 轮询（携带上次返回的 task_id）：使用 `wecom_mcp` tool 调用 `wecom_mcp call doc get_doc_content '{"docid": "DOCID", "type": 2, "task_id": "xxx"}'`
+- 或通过 URL：使用 `wecom_mcp` tool 调用 `wecom_mcp call doc get_doc_content '{"url": "https://doc.weixin.qq.com/doc/xxx", "type": 2}'`
+
+参见 [API 详情](references/api-export-document.md)。
+
+### create_doc
+
+新建文档（doc_type=3）或智能表格（doc_type=10）。创建成功返回 url 和 docid。
+
+- 使用 `wecom_mcp` tool 调用 `wecom_mcp call doc create_doc '{"doc_type": 3, "doc_name": "项目周报"}'`
+- 使用 `wecom_mcp` tool 调用 `wecom_mcp call doc create_doc '{"doc_type": 10, "doc_name": "任务跟踪表"}'`
+
+**注意**：docid 仅在创建时返回，需妥善保存。创建智能表格时默认包含一个子表，可通过 `smartsheet_get_sheet` 查询其 sheet_id。
+
+参见 [API 详情](references/api-create-doc.md)。
+
+### edit_doc_content
+
+用 Markdown 内容覆写文档正文。`content_type` 固定为 `1`（Markdown）。
+
+使用 `wecom_mcp` tool 调用 `wecom_mcp call doc edit_doc_content '{"docid": "DOCID", "content": "# 标题\n\n正文内容", "content_type": 1}'`
+
+参见 [API 详情](references/api-edit-doc-content.md)。
+
+## 典型工作流
+
+1. **读取文档** → 使用 `wecom_mcp` tool 调用 `wecom_mcp call doc get_doc_content '{"docid": "DOCID", "type": 2}'`，若 `task_done` 为 false 则携带 `task_id` 继续轮询
+2. **创建新文档** → 使用 `wecom_mcp` tool 调用 `wecom_mcp call doc create_doc '{"doc_type": 3, "doc_name": "文档名"}'`，保存返回的 docid
+3. **编辑文档** → 先 get_doc_content 了解当前内容，再 edit_doc_content 覆写

package/skills/wecom-doc-manager/references/api-create-doc.md

@@ -0,0 +1,56 @@
+# create_doc API
+
+新建文档、表格或智能表格。创建成功后返回文档访问链接和 docid。
+
+## 技能定义
+
+```json
+{
+    "name": "create_doc",
+    "description": "新建文档、表格或智能表格。支持在指定空间和目录下创建，可设置文档管理员。创建成功后返回文档访问链接和 docid（docid 仅在创建时返回，需妥善保存）。注意：创建智能表格（doc_type=10）时，文档会默认包含一个子表，可通过 smartsheet_get_sheet 查询其 sheet_id，无需额外调用 smartsheet_add_sheet。",
+    "inputSchema": {
+        "properties": {
+            "doc_type": {
+                "description": "文档类型：3-文档，10-智能表格",
+                "enum": [3, 10],
+                "title": "Doc Type",
+                "type": "integer"
+            },
+            "doc_name": {
+                "description": "文档名字，最多 255 个字符，超过会被截断",
+                "title": "Doc Name",
+                "type": "string"
+            }
+        },
+        "required": ["doc_type", "doc_name"],
+        "title": "create_docArguments",
+        "type": "object"
+    }
+}
+```
+
+## 请求示例
+
+```json
+{
+    "doc_type": 3,
+    "doc_name": "项目周报"
+}
+```
+
+## 响应示例
+
+```json
+{
+    "errcode": 0,
+    "errmsg": "ok",
+    "url": "https://doc.weixin.qq.com/doc/xxx",
+    "docid": "DOCID"
+}
+```
+
+## 注意事项
+
+- `doc_type=3` 创建普通文档
+- `doc_type=10` 创建智能表格，默认包含一个子表
+- docid 仅在创建时返回，后续无法再获取，务必保存

package/skills/wecom-doc-manager/references/api-edit-doc-content.md

@@ -0,0 +1,68 @@
+# edit_doc_content API
+
+编辑（覆写）文档内容。
+
+## 技能定义
+
+```json
+{
+    "name": "edit_doc_content",
+    "description": "编辑文档内容",
+    "inputSchema": {
+        "properties": {
+            "docid": {
+                "description": "文档 id，与 url 二选一传入",
+                "title": "Docid",
+                "type": "string"
+            },
+            "url": {
+                "description": "文档的访问链接，与 docid 二选一传入",
+                "title": "URL",
+                "type": "string"
+            },
+            "content": {
+                "description": "覆写的文档内容",
+                "title": "Content",
+                "type": "string"
+            },
+            "content_type": {
+                "description": "内容类型格式。1:markdown",
+                "enum": [1],
+                "title": "Content Type",
+                "type": "integer"
+            }
+        },
+        "oneOf": [
+            { "required": ["docid", "content", "content_type"] },
+            { "required": ["url", "content", "content_type"] }
+        ],
+        "title": "edit_doc_contentArguments",
+        "type": "object"
+    }
+}
+```
+
+## 请求示例
+
+```json
+{
+    "docid": "DOCID",
+    "content": "# 标题\n\n正文内容",
+    "content_type": 1
+}
+```
+
+## 响应示例
+
+```json
+{
+    "errcode": 0,
+    "errmsg": "ok"
+}
+```
+
+## 注意事项
+
+- `content_type` 当前仅支持 `1`（Markdown 格式）
+- 此操作为**覆写**，会替换文档全部内容
+- 建议先调用 `get_document` 了解当前内容再编辑

package/skills/wecom-doc-manager/references/api-export-document.md

@@ -0,0 +1,88 @@
+# get_doc_content API
+
+获取企业微信文档的完整内容数据，以 Markdown 格式返回。该接口采用异步轮询机制：首次调用无需传 task_id，接口会返回 task_id；若 task_done 为 false，需携带该 task_id 再次调用，直到 task_done 为 true 时返回完整内容。
+
+## 技能定义
+
+```json
+{
+    "name": "get_doc_content",
+    "description": "获取企业微信文档的完整内容数据，以 Markdown 格式返回。该接口采用异步轮询机制：首次调用无需传 task_id，接口会返回 task_id；若 task_done 为 false，需携带该 task_id 再次调用，直到 task_done 为 true 时返回完整内容。",
+    "inputSchema": {
+        "properties": {
+            "docid": {
+                "description": "文档的 docid，与 url 二选一传入",
+                "title": "Doc ID",
+                "type": "string"
+            },
+            "url": {
+                "description": "文档的访问链接，与 docid 二选一传入",
+                "title": "URL",
+                "type": "string"
+            },
+            "type": {
+                "description": "内容返回格式。2: Markdown 格式",
+                "enum": [2],
+                "title": "Type",
+                "type": "integer"
+            },
+            "task_id": {
+                "description": "任务 ID，用于异步轮询。初次调用时不填，后续轮询时填写上次返回的 task_id",
+                "title": "Task ID",
+                "type": "string"
+            }
+        },
+        "oneOf": [
+            { "required": ["docid", "type"] },
+            { "required": ["url", "type"] }
+        ],
+        "title": "get_doc_contentArguments",
+        "type": "object"
+    }
+}
+```
+
+## 参数说明
+
+| 参数 | 类型 | 必填 | 说明 |
+|---|---|---|---|
+| docid | string | 与 url 二选一 | 文档的 docid |
+| url | string | 与 docid 二选一 | 文档的访问链接 |
+| type | integer | 是 | 内容返回格式，固定传 `2`（Markdown 格式） |
+| task_id | string | 否 | 任务 ID，初次调用不填，后续轮询时填写上次返回的 task_id |
+
+## 异步轮询机制
+
+1. **首次调用**：传入 `docid`/`url` 和 `type: 2`，不传 `task_id`
+2. **检查响应**：若 `task_done` 为 `false`，记录返回的 `task_id`
+3. **轮询调用**：携带 `task_id` 再次调用，直到 `task_done` 为 `true`
+4. **获取内容**：当 `task_done` 为 `true` 时，`content` 字段包含完整的 Markdown 内容
+
+## 请求示例
+
+```json
+// 首次调用
+{
+    "docid": "DOCID",
+    "type": 2
+}
+
+// 轮询调用
+{
+    "docid": "DOCID",
+    "type": 2,
+    "task_id": "xxx"
+}
+```
+
+## 响应示例
+
+```json
+{
+    "errcode": 0,
+    "errmsg": "ok",
+    "content": "# 文档标题\n\n文档正文内容...",
+    "task_id": "xxxxx",
+    "task_done": true
+}
+```