feat: update docs

2026-07-20 05:27:59 +08:00 · 2026-02-28 10:53:16 +08:00
parent 269fa7d2d5
commit 8705bf0a70
16 changed files with 485 additions and 145 deletions
--- a/docs/channels/dingtalk.mdx
+++ b/docs/channels/dingtalk.mdx
@@ -7,15 +7,29 @@ description: 将 CowAgent 接入钉钉应用

 ## 一、创建应用

-1. 进入 [钉钉开发者后台](https://open-dev.dingtalk.com/fe/app#/corp/app)，点击 **创建应用**，填写应用信息
-2. 点击添加应用能力，选择 **机器人** 能力并添加
-3. 配置机器人信息后点击 **发布**
+1. 进入 [钉钉开发者后台](https://open-dev.dingtalk.com/fe/app#/corp/app)，登录后点击 **创建应用**，填写应用相关信息：
+
+<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-create-app.png" width="800"/>
+
+2. 点击添加应用能力，选择 **机器人** 能力，点击 **添加**：
+
+<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-add-bot.png" width="800"/>
+
+3. 配置机器人信息后点击 **发布**。发布后，点击 "**点击调试**"，会自动创建测试群聊，可在客户端查看：
+
+<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-config-bot.png" width="600"/>
+
+4. 点击 **版本管理与发布**，创建新版本发布：
+
+<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-publish-bot.png" width="700"/>

 ## 二、项目配置

-1. 在 **凭证与基础信息** 中获取 `Client ID` 和 `Client Secret`
+1. 点击 **凭证与基础信息**，获取 `Client ID` 和 `Client Secret`：

-2. 填入 `config.json`：
+<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-get-secret.png" width="700"/>
+
+2. 将以下配置加入项目根目录的 `config.json` 文件：

 ```json
 {
@@ -31,8 +45,12 @@ description: 将 CowAgent 接入钉钉应用
 pip3 install dingtalk_stream
 ```

-4. 启动项目后，在钉钉开发者后台点击 **事件订阅**，点击 **已完成接入，验证连接通道**，显示"连接接入成功"即表示配置完成
+4. 启动项目后，在钉钉开发者后台点击 **事件订阅**，点击 **已完成接入，验证连接通道**，显示 **连接接入成功** 即表示配置完成：
+
+<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-event-sub.png" width="700"/>

 ## 三、使用

-与机器人私聊或将机器人拉入企业群中均可开启对话。
+与机器人私聊或将机器人拉入企业群中均可开启对话：
+
+<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-hosting-demo.png" width="650"/>
--- a/docs/channels/feishu.mdx
+++ b/docs/channels/feishu.mdx
@@ -3,65 +3,67 @@ title: 飞书
 description: 将 CowAgent 接入飞书应用
 ---

-通过自建应用将 CowAgent 接入飞书，支持 WebSocket 长连接（推荐）和 Webhook 两种事件接收模式。
+通过自建应用将 CowAgent 接入飞书，需要是飞书企业用户且具有企业管理权限。

 ## 一、创建企业自建应用

 ### 1. 创建应用

-进入 [飞书开发平台](https://open.feishu.cn/app/)，点击 **创建企业自建应用**，填写必要信息后创建。
+进入 [飞书开发平台](https://open.feishu.cn/app/)，点击 **创建企业自建应用**，填写必要信息后点击 **创建**：
+
+<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/feishu-hosting-create-app.jpg" width="500"/>

 ### 2. 添加机器人能力

-在 **添加应用能力** 菜单中，为应用添加 **机器人** 能力。
+在 **添加应用能力** 菜单中，为应用添加 **机器人** 能力：
+
+<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/feishu-hosting-add-bot.jpg" width="800"/>

 ### 3. 配置应用权限

-点击 **权限管理**，粘贴以下权限配置，全选并批量开通：
+点击 **权限管理**，复制以下权限配置，粘贴到 **权限配置** 下方的输入框内，全选筛选出来的权限，点击 **批量开通** 并确认：

 ```
 im:message,im:message.group_at_msg,im:message.group_at_msg:readonly,im:message.p2p_msg,im:message.p2p_msg:readonly,im:message:send_as_bot,im:resource
 ```

+<img src="https://cdn.link-ai.tech/doc/feishu-hosting-add-auth2.png" width="800"/>
+
 ## 二、项目配置

-在 **凭证与基础信息** 中获取 `App ID` 和 `App Secret`，填入 `config.json`：
+1. 在 **凭证与基础信息** 中获取 `App ID` 和 `App Secret`：

-<Tabs>
-  <Tab title="WebSocket 模式（推荐）">
-    无需公网 IP，配置如下：
+<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/feishu-hosting-appid-secret.jpg" width="800"/>

-    ```json
-    {
-      "channel_type": "feishu",
-      "feishu_app_id": "YOUR_APP_ID",
-      "feishu_app_secret": "YOUR_APP_SECRET",
-      "feishu_event_mode": "websocket"
-    }
-    ```
+2. 将以下配置加入项目根目录的 `config.json` 文件：

-    需安装依赖：`pip3 install lark-oapi`
-  </Tab>
-  <Tab title="Webhook 模式">
-    需要公网 IP，配置如下：
+```json
+{
+  "channel_type": "feishu",
+  "feishu_app_id": "YOUR_APP_ID",
+  "feishu_app_secret": "YOUR_APP_SECRET",
+  "feishu_bot_name": "YOUR_BOT_NAME"
+}
+```

-    ```json
-    {
-      "channel_type": "feishu",
-      "feishu_app_id": "YOUR_APP_ID",
-      "feishu_app_secret": "YOUR_APP_SECRET",
-      "feishu_token": "VERIFICATION_TOKEN",
-      "feishu_event_mode": "webhook",
-      "feishu_port": 9891
-    }
-    ```
-  </Tab>
-</Tabs>
+| 参数 | 说明 |
+| --- | --- |
+| `feishu_app_id` | 飞书机器人应用 App ID |
+| `feishu_app_secret` | 飞书机器人 App Secret |
+| `feishu_bot_name` | 飞书机器人名称（创建应用时设置），群聊中使用依赖此配置 |
+
+配置完成后启动项目。

 ## 三、配置事件订阅

-1. 启动项目后，在飞书开放平台点击 **事件与回调**，选择 **长连接** 方式并保存
-2. 点击 **添加事件**，搜索 "接收消息"，选择 "接收消息v2.0"，确认添加
-3. 点击 **版本管理与发布**，创建版本并申请线上发布，审核通过后即可使用
+1. 成功运行项目后，在飞书开放平台点击 **事件与回调**，选择 **长连接** 方式，点击保存：
+
+<img src="https://cdn.link-ai.tech/doc/202601311731183.png" width="600"/>
+
+2. 点击下方的 **添加事件**，搜索 "接收消息"，选择 "**接收消息v2.0**"，确认添加。
+
+3. 点击 **版本管理与发布**，创建版本并申请 **线上发布**，在飞书客户端查看审批消息并审核通过：
+
+<img src="https://cdn.link-ai.tech/doc/202601311807356.png" width="600"/>

 完成后在飞书中搜索机器人名称，即可开始对话。
--- a/docs/channels/web.mdx
+++ b/docs/channels/web.mdx
@@ -1,9 +1,9 @@
 ---
-title: Web 网页
-description: 通过 Web 网页端使用 CowAgent
+title: Web 控制台
+description: 通过 Web 控制台使用 CowAgent
 ---

-Web 是 CowAgent 的默认通道，启动后会自动运行 Web 控制台，通过浏览器即可与 Agent 对话。
+Web 控制台是 CowAgent 的默认通道，启动后会自动运行，通过浏览器即可与 Agent 对话，并支持在线管理模型、技能、记忆、通道等配置。

 ## 配置

@@ -19,13 +19,57 @@ Web 是 CowAgent 的默认通道，启动后会自动运行 Web 控制台，通
 | `channel_type` | 设为 `web` | `web` |
 | `web_port` | Web 服务监听端口 | `9899` |

-## 使用
+## 访问地址

 启动项目后访问：

- 本地运行：`http://localhost:9899/chat`
- 服务器运行：`http://<server-ip>:9899/chat`
+- 本地运行：`http://localhost:9899`
+- 服务器运行：`http://<server-ip>:9899`

 <Note>
  请确保服务器防火墙和安全组已放行对应端口。
 </Note>
+
+## 功能介绍
+
+### 对话界面
+
+支持流式输出，可实时展示 Agent 的思考过程（Reasoning）和工具调用过程（Tool Calls），更直观地观察 Agent 的决策过程：
+
+<img width="850" src="https://cdn.link-ai.tech/doc/20260227180120.png" />
+
+### 模型管理
+
+支持在线管理模型配置，无需手动编辑配置文件：
+
+<img width="850" src="https://cdn.link-ai.tech/doc/20260227173811.png" />
+
+### 技能管理
+
+支持在线查看和管理 Agent 技能（Skills）：
+
+<img width="850" src="https://cdn.link-ai.tech/doc/20260227173403.png" />
+
+### 记忆管理
+
+支持在线查看和管理 Agent 记忆：
+
+<img width="850" src="https://cdn.link-ai.tech/doc/20260227173349.png" />
+
+### 通道管理
+
+支持在线管理接入通道，支持实时连接/断开操作：
+
+<img width="850" src="https://cdn.link-ai.tech/doc/20260227173331.png" />
+
+### 定时任务
+
+支持在线查看和管理定时任务，包括一次性任务、固定间隔、Cron 表达式等多种调度方式的可视化管理：
+
+<img width="850" src="https://cdn.link-ai.tech/doc/20260227173704.png" />
+
+### 日志
+
+支持在线实时查看 Agent 运行日志，便于监控运行状态和排查问题：
+
+<img width="850" src="https://cdn.link-ai.tech/doc/20260227173514.png" />
--- a/docs/channels/wechatmp.mdx
+++ b/docs/channels/wechatmp.mdx
@@ -7,21 +7,22 @@ CowAgent 支持接入个人订阅号和企业服务号两种公众号类型。

 | 类型 | 要求 | 特点 |
 | --- | --- | --- |
-| **个人订阅号** | 个人可申请 | 回复生成后需用户主动发消息获取 |
+| **个人订阅号** | 个人可申请 | 收到消息时会回复一条提示，回复生成后需用户主动发消息获取 |
 | **企业服务号** | 企业申请，需通过微信认证开通客服接口 | 回复生成后可主动推送给用户 |

 <Note>
-  公众号仅支持服务器和 Docker 部署，需额外安装扩展依赖：`pip3 install -r requirements-optional.txt`
+  公众号仅支持服务器和 Docker 部署，不支持本地运行。需额外安装扩展依赖：`pip3 install -r requirements-optional.txt`
 </Note>

 ## 一、个人订阅号

-在 `config.json` 中配置：
+在 `config.json` 中添加以下配置：

 ```json
 {
  "channel_type": "wechatmp",
-  "wechatmp_app_id": "YOUR_APP_ID",
+  "single_chat_prefix": [""],
+  "wechatmp_app_id": "wx73f9******d1e48",
  "wechatmp_app_secret": "YOUR_APP_SECRET",
  "wechatmp_aes_key": "",
  "wechatmp_token": "YOUR_TOKEN",
@@ -31,22 +32,37 @@ CowAgent 支持接入个人订阅号和企业服务号两种公众号类型。

 ### 配置步骤

-1. 在 [微信公众平台](https://mp.weixin.qq.com/) 的 **设置与开发 → 基本配置 → 服务器配置** 中获取参数
-2. 启用开发者密码，将服务器 IP 加入白名单
-3. 启动程序（监听 80 端口）
-4. 在公众号后台 **启用服务器配置**，URL 格式为 `http://{HOST}/wx`
+这些配置需要和 [微信公众号后台](https://mp.weixin.qq.com/advanced/advanced?action=dev&t=advanced/dev) 中的保持一致，进入页面后，在左侧菜单选择 **设置与开发 → 基本配置 → 服务器配置**，按下图进行配置：
+
+<img src="https://cdn.link-ai.tech/doc/20260228103506.png" width="480"/>
+
+1. 在公众平台启用开发者密码（对应配置 `wechatmp_app_secret`），并将服务器 IP 填入白名单
+2. 按上图填写 `config.json` 中与公众号相关的配置，要与公众号后台的配置一致
+3. 启动程序，启动后会监听 80 端口（若无权限监听，则在启动命令前加上 `sudo`；若 80 端口已被占用，则关闭该占用进程）
+4. 在公众号后台 **启用服务器配置** 并提交，保存成功则表示已成功配置。注意 **"服务器地址(URL)"** 需要配置为 `http://{HOST}/wx` 的格式，其中 `{HOST}` 可以是服务器的 IP 或域名
+
+随后关注公众号并发送消息即可看到以下效果：
+
+<img src="https://cdn.link-ai.tech/doc/20260228103522.png" width="720"/>
+
+由于受订阅号限制，回复内容较短的情况下（15s 内），可以立即完成回复，但耗时较长的回复则会先回复一句 "正在思考中"，后续需要用户输入任意文字主动获取答案，而服务号则可以通过客服接口解决这一问题。
+
+<Tip>
+  **语音识别**：可利用微信自带的语音识别功能，需要在公众号管理页面的 "设置与开发 → 接口权限" 页面开启 "接收语音识别结果"。
+</Tip>

 ## 二、企业服务号

-与个人订阅号流程基本相同，差异如下：
+企业服务号与上述个人订阅号的接入过程基本相同，差异如下：

-1. 在公众平台申请企业服务号并完成微信认证，确认已获得 **客服接口** 权限
-2. 在 `config.json` 中设置 `"channel_type": "wechatmp_service"`
-3. 即使是较长耗时的回复，也可以主动推送给用户
+1. 在公众平台申请企业服务号并完成微信认证，在接口权限中确认已获得 **客服接口** 的权限
+2. 在 `config.json` 中设置 `"channel_type": "wechatmp_service"`，其他配置与上述订阅号相同
+3. 交互效果上，即使是较长耗时的回复，也可以主动推送给用户，无需用户手动获取

 ```json
 {
  "channel_type": "wechatmp_service",
+  "single_chat_prefix": [""],
  "wechatmp_app_id": "YOUR_APP_ID",
  "wechatmp_app_secret": "YOUR_APP_SECRET",
  "wechatmp_aes_key": "",
--- a/docs/channels/wecom.mdx
+++ b/docs/channels/wecom.mdx
@@ -19,17 +19,35 @@ description: 将 CowAgent 接入企业微信自建应用

 ## 二、创建企业微信应用

-1. 在 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#profile) **我的企业** 中获取 **企业ID**
-2. 切换到 **应用管理**，点击创建应用，记录 `AgentId` 和 `Secret`
-3. 点击 **设置API接收**，配置应用接口：
-   - URL 格式为 `http://ip:port/wxcomapp`（认证企业需使用备案域名）
-   - 随机获取 `Token` 和 `EncodingAESKey` 并保存
+1. 在 [企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#profile) 点击 **我的企业**，在最下方获取 **企业ID**（后续填写到 `wechatcom_corp_id` 字段中）。
+
+2. 切换到 **应用管理**，点击创建应用：
+
+<img src="https://cdn.link-ai.tech/doc/20260228103156.png" width="480"/>
+
+3. 进入应用创建页面，记录 `AgentId` 和 `Secret`：
+
+<img src="https://cdn.link-ai.tech/doc/20260228103218.png" width="580"/>
+
+4. 点击 **设置API接收**，配置应用接口：
+
+<img src="https://cdn.link-ai.tech/doc/20260228103211.png" width="520"/>
+
+- URL 格式为 `http://ip:port/wxcomapp`（认证企业需使用备案域名）
+- 随机获取 `Token` 和 `EncodingAESKey` 并保存
+
+<Note>
+  此时保存 API 接收配置会失败，因为程序还未启动，等项目运行后再回来保存。
+</Note>

 ## 三、配置和运行

+在 `config.json` 中添加以下配置（各参数与企业微信后台的对应关系见上方截图）：
+
 ```json
 {
  "channel_type": "wechatcom_app",
+  "single_chat_prefix": [""],
  "wechatcom_corp_id": "YOUR_CORP_ID",
  "wechatcomapp_token": "YOUR_TOKEN",
  "wechatcomapp_secret": "YOUR_SECRET",
@@ -48,12 +66,25 @@ description: 将 CowAgent 接入企业微信自建应用
 | `wechatcomapp_aes_key` | API 接收配置中的 EncodingAESKey |
 | `wechatcomapp_port` | 监听端口，默认 9898 |

-启动程序后，回到企业微信后台保存 **消息服务器配置**，并将服务器 IP 添加到 **企业可信IP** 中。
+配置完成后启动程序。当后台日志显示 `http://0.0.0.0:9898/` 时说明程序运行成功，需要将该端口对外开放（如在云服务器安全组中放行）。
+
+程序启动后，回到企业微信后台保存 **消息服务器配置**，保存成功后还需将服务器 IP 添加到 **企业可信IP** 中，否则无法收发消息：
+
+<img src="https://cdn.link-ai.tech/doc/20260228103224.png" width="520"/>

 <Warning>
-  如遇到配置失败：1. 确保防火墙和安全组已放行端口；2. 检查各参数配置是否一致；3. 认证企业需配置备案域名。
+  如遇到 URL 配置回调不通过或配置失败：
+  1. 确保服务器防火墙关闭且安全组放行监听端口
+  2. 仔细检查 Token、Secret Key 等参数配置是否一致，URL 格式是否正确
+  3. 认证企业微信需要配置与主体一致的备案域名
 </Warning>

 ## 四、使用

-在企业微信中搜索应用名称即可直接对话。如需让外部微信用户使用，可在 **我的企业 → 微信插件** 中分享邀请关注二维码。
+在企业微信中搜索刚创建的应用名称，即可直接对话：
+
+<img src="https://cdn.link-ai.tech/doc/20260228103228.png" width="720"/>
+
+如需让外部个人微信用户使用，可在 **我的企业 → 微信插件** 中分享邀请关注二维码，个人微信扫码关注后即可与应用对话：
+
+<img src="https://cdn.link-ai.tech/doc/20260228103232.png" width="520"/>