Skip to content

Commit c2a1c11

Browse files
committed
feat: refresh docs for agent capabilities and wording
1 parent 20069fb commit c2a1c11

3 files changed

Lines changed: 55 additions & 55 deletions

File tree

docs/ecosystem/plugin/extension-agent.md

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## 配置
88

9-
* 前往插件市场搜索 `chatluna-agent` 并安装。
9+
- 前往插件市场搜索 `chatluna-agent` 并安装。
1010

1111
![安装 chatluna-agent](/images/agent-install.png)
1212

@@ -18,8 +18,8 @@
1818

1919
以下是推荐的一些插件源:
2020

21-
* [https://koishi-registry.yumetsuki.moe/index.json](https://koishi-registry.yumetsuki.moe/index.json)
22-
* [https://kp.itzdrli.cc](https://kp.itzdrli.cc)
21+
- [https://koishi-registry.yumetsuki.moe/index.json](https://koishi-registry.yumetsuki.moe/index.json)
22+
- [https://kp.itzdrli.cc](https://kp.itzdrli.cc)
2323

2424
:::
2525

@@ -43,16 +43,16 @@
4343

4444
![总览页](/images/agent-overview.png)
4545

46-
总览页中每个区块对应一个子系统
46+
总览页中每个位置对应一个子系统
4747

48-
* **MCP**:已连接的服务器数量和可用工具数。
49-
* **Computer**:当前可用的后端和活跃会话数。
50-
* **Skills**:扫描到的技能总数和可见技能数。
51-
* **Sub-Agent**:已启用的子代理数量。
52-
* **Tools**:可用工具总数。
53-
* **Trigger**:启用的任务数。
48+
- **MCP**:已连接的服务器数量和可用工具数。
49+
- **Computer**:当前可用的后端和活跃会话数。
50+
- **Skills**:扫描到的技能总数和可见技能数。
51+
- **Sub-Agent**:已启用的子代理数量。
52+
- **Tools**:可用工具总数。
53+
- **Trigger**:启用的任务数。
5454

55-
如果某个区块显示错误或数值为零,点击进入对应页面进行排查
55+
如果某个位置显示错误,你可以点击进入对应页面进行排查
5656

5757
### MCP
5858

@@ -86,9 +86,9 @@ MCP 页面用于管理 MCP 协议服务器。你可以在此添加、编辑、
8686

8787
每个工具支持以下控制项:
8888

89-
* **启用/禁用**:关闭后该工具不会注册给模型。
90-
* **超时**:覆盖服务器级别的超时时间,单位秒。
91-
* **选择器**:填写关键词,只有对话中包含这些关键词时工具才会出现在候选列表中。留空表示始终可用。
89+
- **启用/禁用**:关闭后该工具不会注册给模型。
90+
- **超时**:覆盖服务器级别的超时时间,单位秒。
91+
- **选择器**:填写关键词,只有对话中包含这些关键词时工具才会出现在候选列表中。留空表示始终可用。
9292

9393
#### 重连和删除
9494

@@ -104,12 +104,12 @@ Tools 页面展示所有注册到 ChatLuna 的工具,包括 Computer 工具、
104104

105105
每个工具提供以下控制项:
106106

107-
* **启用**:工具总开关。
108-
* **主会话**:是否允许主 ChatLuna 会话使用。
109-
* **ChatLuna**:是否允许普通 ChatLuna 来源使用。
110-
* **角色**:是否允许角色扮演来源使用,可以分别控制群聊和私聊。
111-
* **权限等级**:调用该工具所需的最低 Koishi 用户权限。默认情况下,`bash``file_read``file_write``file_edit``trigger` 等工具需要 3 级权限。
112-
* **子代理**:控制哪些子代理可以使用该工具。
107+
- **启用**:工具总开关。
108+
- **主会话**:是否允许主 ChatLuna 会话使用。
109+
- **ChatLuna**:是否允许普通 ChatLuna 来源使用。
110+
- **角色**:是否允许角色扮演来源使用,可以分别控制群聊和私聊。
111+
- **权限等级**:调用该工具所需的最低 Koishi 用户权限。默认情况下,`bash``file_read``file_write``file_edit``trigger` 等工具需要 3 级权限。
112+
- **子代理**:控制哪些子代理可以使用该工具。
113113

114114
![Tools 页面 - 编辑工具](/images/agent-tools-edit.png)
115115

@@ -124,9 +124,9 @@ Computer 页面用于启用和管理文件操作、搜索、Shell 执行和终
124124

125125
插件支持三种 Computer 后端:
126126

127-
* **Local**:直接在 Koishi 所在机器上运行,适合个人开发机调试。
128-
* **E2B**:使用 E2B 云沙箱,适合需要隔离执行的场景。
129-
* **Open Terminal**:连接外部终端服务。
127+
- **Local**:直接在 Koishi 所在机器上运行,适合个人开发机调试。
128+
- **E2B**:使用 E2B 云沙箱,适合需要隔离执行的场景。
129+
- **Open Terminal**:连接外部终端服务。
130130

131131
#### 启用 Local 后端
132132

@@ -164,13 +164,13 @@ Local 后端直接操作宿主机。不要在面向普通用户的群聊中随
164164

165165
启用任一后端后,以下工具会自动注册:
166166

167-
* `file_read`:读取文件内容或列出目录。
168-
* `file_write`:创建或覆盖文件。
169-
* `file_edit`:对已有文件做精确字符串替换。
170-
* `grep`:正则搜索文件内容。
171-
* `glob`:按 glob 模式匹配文件。
172-
* `bash`:执行 Shell 命令,也可管理后台任务。
173-
* `file_publish`:把生成的文件发布给用户(需要 `chatluna-storage-service`)。
167+
- `file_read`:读取文件内容或列出目录。
168+
- `file_write`:创建或覆盖文件。
169+
- `file_edit`:对已有文件做精确字符串替换。
170+
- `grep`:正则搜索文件内容。
171+
- `glob`:按 glob 模式匹配文件。
172+
- `bash`:执行 Shell 命令,也可管理后台任务。
173+
- `file_publish`:把生成的文件发布给用户(需要 `chatluna-storage-service`)。
174174

175175
#### 终端和后台任务
176176

@@ -188,9 +188,9 @@ Skills 页面用于管理 `SKILL.md` 技能文件。技能是一种可复用的
188188

189189
点击导入按钮,可以从三种来源导入技能:
190190

191-
* **GitHub**:填写仓库或目录 URL。
192-
* **ZIP**:上传压缩包。
193-
* **文件夹**:选择本地目录内容。
191+
- **GitHub**:填写仓库或目录 URL。
192+
- **ZIP**:上传压缩包。
193+
- **文件夹**:选择本地目录内容。
194194

195195
![Skills 页面 - 导入](/images/agent-skills-import.png)
196196

@@ -200,11 +200,11 @@ Skills 页面用于管理 `SKILL.md` 技能文件。技能是一种可复用的
200200

201201
技能列表中每个技能支持以下操作:
202202

203-
* **启用/禁用**:控制技能是否可用。
204-
* **模式切换**:在 `off``description`(默认,只注入名称和描述)、`full`(每轮注入完整内容)之间切换。
205-
* **编辑内容**:编辑本地导入的 `SKILL.md`
206-
* **导出**:导出为压缩包。
207-
* **删除**:删除导入到 `data/chatluna/skills` 的本地技能。
203+
- **启用/禁用**:控制技能是否可用。
204+
- **模式切换**:在 `off``description`(默认,只注入名称和描述)、`full`(每轮注入完整内容)之间切换。
205+
- **编辑内容**:编辑本地导入的 `SKILL.md`
206+
- **导出**:导出为压缩包。
207+
- **删除**:删除导入到 `data/chatluna/skills` 的本地技能。
208208

209209
![Skills 页面 - 编辑技能](/images/agent-skills-edit.png)
210210

@@ -229,9 +229,9 @@ Sub-Agent 页面用于管理子代理。子代理允许主模型把特定任务
229229

230230
插件内置三个子代理,默认关闭。在 Sub-Agent 页面中找到并启用即可。
231231

232-
* **plan**:只读分析代理,用于制定实现方案。只能使用 `file_read``grep``glob`
233-
* **explore**:快速搜索代理,用于收集代码上下文。只能使用 `file_read``grep``glob`
234-
* **general**:通用实现代理,可以读写文件和执行命令。
232+
- **plan**:只读分析代理,用于制定实现方案。只能使用 `file_read``grep``glob`
233+
- **explore**:快速搜索代理,用于收集代码上下文。只能使用 `file_read``grep``glob`
234+
- **general**:通用实现代理,可以读写文件和执行命令。
235235

236236
![Sub-Agent 页面 - 启用内置子代理](/images/agent-subagent-builtin.png)
237237

@@ -251,9 +251,9 @@ Sub-Agent 页面用于管理子代理。子代理允许主模型把特定任务
251251

252252
点击导入按钮,可以上传或粘贴带 YAML frontmatter 的 Markdown 文件。插件兼容三种格式:
253253

254-
* **ChatLuna 格式**:推荐格式。
255-
* **Claude 格式**:来自 `~/.claude/agents` 的 Markdown 文件。
256-
* **OpenCode 格式**:来自 `~/.config/opencode/agents` 的 Markdown 文件。
254+
- **ChatLuna 格式**:推荐格式。
255+
- **Claude 格式**:来自 `~/.claude/agents` 的 Markdown 文件。
256+
- **OpenCode 格式**:来自 `~/.config/opencode/agents` 的 Markdown 文件。
257257

258258
![Sub-Agent 页面 - 导入子代理](/images/agent-subagent-import.png)
259259

@@ -291,21 +291,21 @@ Trigger 页面用于创建定时或被动触发任务。任务触发后会主动
291291

292292
#### 内置触发器类型
293293

294-
* **cron**:使用标准 cron 表达式周期触发。例如 `0 9 * * 1-5` 表示工作日上午 9 点。
295-
* **once**:在指定时间触发一次,触发后自动禁用。
296-
* **keyword**:当消息文本包含配置的关键词时被动触发。
297-
* **activity**:根据群聊活跃度(消息频率、参与人数等因素)达到阈值时触发。
294+
- **cron**:使用标准 cron 表达式周期触发。例如 `0 9 * * 1-5` 表示工作日上午 9 点。
295+
- **once**:在指定时间触发一次,触发后自动禁用。
296+
- **keyword**:当消息文本包含配置的关键词时被动触发。
297+
- **activity**:根据群聊活跃度(消息频率、参与人数等因素)达到阈值时触发。
298298

299299
![Trigger 页面 - Cron 配置](/images/agent-trigger-cron.png)
300300

301301
#### 管理任务
302302

303303
Trigger 列表中可以对每个任务进行以下操作:
304304

305-
* **启用/禁用**:暂停或恢复任务。
306-
* **编辑**:修改消息、参数、目标和回复方式。
307-
* **立即触发**:不等待触发条件,马上执行一次。
308-
* **删除**:移除任务。
305+
- **启用/禁用**:暂停或恢复任务。
306+
- **编辑**:修改消息、参数、目标和回复方式。
307+
- **立即触发**:不等待触发条件,马上执行一次。
308+
- **删除**:移除任务。
309309

310310
如果任务执行失败,可以在任务详情中查看 `lastError` 字段排查原因。
311311

docs/guide/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 介绍
22

3-
[ChatLuna](https://github.com/ChatLunaLab/chatluna) 是基于 [LangChain](https://github.com/langchain-ai/langchainjs) 构建的 Koishi 大语言模型聊天插件。它可以统一接入 OpenAI、Google Gemini、Claude 以及生态中的其他模型适配器。
3+
[ChatLuna](https://github.com/ChatLunaLab/chatluna) 是基于 [LangChain](https://github.com/langchain-ai/langchainjs) 构建的 Koishi 大语言模型聊天插件。它可以统一接入 OpenAI、Google Gemini、Claude 以及生态中的其他模型适配器,并提供 Agent 能力支持
44

55
除了面向最终用户的聊天能力,ChatLuna 也向 Koishi 插件开发者暴露了可复用的模型服务接口。长期记忆、知识库、渲染器、Agent 工具等特性都是基于这套 API 扩展的。
66

@@ -11,7 +11,7 @@
1111
- 资源管理:支持全局冷却、并发限制和调用次数控制。
1212
- 多模态:支持图片多模态,并可渲染模型回复,支持文本、图片、语音等多种格式。
1313
- 上下文管理:支持默认的短期聊天记录保存。并可额外安装长期记忆或知识库插件,实现更复杂的知识管理。
14-
- 多种聊天模式:提供 chat、browsing 和 agent 三种模式。browsing 可以联网感知消息,agent 模式则可让模型调用各种工具
14+
- Agent 模式:安装附加插件后,模型将拥有沙箱,skills 等能力,进行更复杂的操作
1515
- 内容安全:支持 koishi 的 censor 服务,过滤不良内容
1616

1717
## 接下来阅读

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ features:
2525
details: 集成 Deepseek、OpenAI、Google Gemini、Anthropic Claude 等主流平台,并持续扩展更多平台。
2626
- icon: 🔗
2727
title: Agentic 能力
28-
details: 使用 Agent 模式,可以让模型任意调用已有工具。支持 MCP,联网搜索,知识库等复杂工具
28+
details: Agent 模式下,可以让模型任意调用已有工具。支持 沙盒,MCP,联网搜索等复杂工具
2929
- icon: 🎨
3030
title: 多模态与渲染输出
3131
details: 支持图片多模态,并可渲染模型回复,支持文本、图片、语音等多种格式。

0 commit comments

Comments
 (0)