Skip to content

Commit 6aeeba2

Browse files
committed
docs(ecosystem): update plugin configuration documentation
- Updated default values for request, chat, cron, and send tools to true - Added todos tool with default value true - Renamed 'codeSandbox' tool to 'music' and updated descriptions - Replaced 'memory' and 'knowledge' tools with 'actions' for OpenAPI tool calling - Revised plugin configuration sections with new structure and descriptions - Updated links and references to match new section names and plugin names - Adjusted formatting for better readability and consistenct
1 parent fee31f0 commit 6aeeba2

3 files changed

Lines changed: 461 additions & 80 deletions

File tree

docs/ecosystem/plugin/common.md

Lines changed: 155 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,20 @@
2121
#### request
2222

2323
- 类型:`boolean`
24-
- 默认值:`false`
24+
- 默认值:`true`
2525

2626
是否启用网络请求工具。开启后,模型可以调用 `request_get``request_post` 工具进行网络的 GET 和 POST 请求。
2727

28+
另外可以参考 [request 插件配置](#request-插件配置) 配置请求工具的相关选项。
29+
2830
#### fs
2931

3032
- 类型:`boolean`
3133
- 默认值:`false`
3234

3335
是否启用文件读写工具。开启后,模型可以调用 `file_write``file_read` 工具读写文件。
3436

35-
另外可以参考 [fs 插件配置](#fs) 配置文件读写的作用域。
37+
另外可以参考 [fs 插件配置](#fs-插件配置) 配置文件读写的作用域。
3638

3739
#### group
3840

@@ -55,7 +57,7 @@
5557
#### chat
5658

5759
- 类型:`boolean`
58-
- 默认值:`false`
60+
- 默认值:`true`
5961

6062
是否启用聊天工具。开启后,模型可以调用 `chat` 工具。该工具会等待用户的输入,返回给模型。
6163

@@ -66,17 +68,26 @@
6668

6769
是否启用思考工具。开启后,模型可以调用 `think` 工具。该工具会基于模型输入的内容,调用其他模型进行思维链推理,返回推理结果。一定程度上提升模型输出的质量。
6870

71+
#### todos
72+
73+
- 类型:`boolean`
74+
- 默认值:`true`
75+
76+
是否启用待办事项工具。开启后,模型可以调用 `todos` 工具。该工具可让 Agent 生成多步骤的待办事项,自动拆解任务。
77+
6978
#### cron
7079

7180
- 类型:`boolean`
72-
- 默认值:`false`
81+
- 默认值:`true`
7382

7483
是否启用定时任务工具。开启后,模型可以调用 `cron` 工具。
7584

85+
另可参考 [定时任务插件配置](#定时任务插件配置) 配置定时任务工具。
86+
7687
#### send
7788

7889
- 类型:`boolean`
79-
- 默认值:`false`
90+
- 默认值:`true`
8091

8192
是否启用发送消息工具。开启后,模型可以调用 `send` 工具。该工具会发送消息给用户。
8293

@@ -87,43 +98,64 @@
8798

8899
是否启用文生图工具。开启后,模型可以调用 `draw` 工具。该工具会基于模型输入的内容,调用 Koishi 上的文生图插件,生成图片。
89100

90-
另可参考 [文生图插件配置](#draw) 配置文生图工具。
101+
另可参考 [画图插件配置](#画图插件配置) 配置文生图工具。
91102

92-
#### codeSandbox
103+
#### music
93104

94105
- 类型:`boolean`
95106
- 默认值:`false`
96107

97-
是否启用代码执行工具。开启后,模型可以调用 `codeSandbox` 工具。该工具会基于模型输入的内容,执行 Python 代码
108+
是否启用音乐播放工具。开启后,模型可以调用 `music` 工具,播放音乐
98109

99-
参考 [代码执行器配置](#代码执行器配置) 配置代码执行工具所需的 API 密钥。
110+
在启用此工具前,需要确保 Koishi 的 `@dgck81lnn/music` 插件已启用。
111+
112+
另可参考 [音乐生成插件配置](#音乐生成插件配置) 配置音乐工具。
100113

101-
#### memory
114+
#### actions
102115

103116
- 类型:`boolean`
104117
- 默认值:`false`
105118

106-
是否启用主动记忆工具。开启后,模型可以调用 `memory_save``memory_search` 工具,保存和搜索用户的记忆
119+
是否启用 OpenAPI 工具调用功能。开启后,模型可以调用自定义的 OpenAPI 工具
107120

108-
使用前需要确保主插件的长期记忆功能是否能正常启用,正确配置了向量数据库和嵌入模型
121+
另可参考 [OpenAPI 工具调用插件配置](#openapi-工具调用插件配置) 配置 OpenAPI 工具。需要启用 request 工具才能请求
109122

110-
#### knowledge
123+
### request 工具配置
111124

112-
- 类型:`boolean`
113-
- 默认值:`false`
125+
#### requestMaxOutputLength
114126

115-
是否启用知识库工具。开启后,模型可以调用 `knowledge` 工具,搜索知识库中的内容。
127+
- 类型:`number`
128+
- 默认值:`58600`
116129

117-
另可参考 [知识库插件配置](#knowledge) 配置知识库工具
130+
request 插件最大输出长度
118131

119-
#### music
132+
#### requestSelector
120133

121-
- 类型:`boolean`
122-
- 默认值:`false`
134+
- 类型:`string[]`
135+
- 默认值:`['请求', 'request', 'get', 'post', '获取', '调用', 'api', 'http']`
123136

124-
是否启用音乐播放工具。开启后,模型可以调用 `music` 工具,播放音乐
137+
触发 request 工具的关键词。为空时始终选中
125138

126-
在启用此工具前,需要确保 Koishi 的 `@dgck81lnn/music` 插件已启用。
139+
#### requestHeaders
140+
141+
- 类型:`{ matcher: string, headers: Record<string, string> }[]`
142+
- 默认值:`[]`
143+
144+
根据域名匹配设置请求头。
145+
146+
##### requestHeaders.matcher
147+
148+
- 类型:`string`
149+
- 默认值:``
150+
151+
域名匹配模式(支持通配符,如 `*.example.com`, `api.github.com`)。
152+
153+
##### requestHeaders.headers
154+
155+
- 类型:`Record<string, string>`
156+
- 默认值:`{}`
157+
158+
该域名匹配时应用的请求头。
127159

128160
### fs 插件配置
129161

@@ -132,16 +164,37 @@
132164
- 类型:`string`
133165
- 默认值:``
134166

135-
文件读写的作用域。留空则为任意路径。
167+
文件读写的作用域。留空则为系统任意路径。
168+
169+
#### fsSelector
170+
171+
- 类型:`string[]`
172+
- 默认值:`['文件', 'file', '读取', '写入', '查找', '搜索', 'read', 'write', 'search', '路径', 'path']`
173+
174+
触发 fs 工具的关键词。为空时始终选中。
175+
176+
#### fsIgnores
177+
178+
- 类型:`string[]`
179+
- 默认值:`['**/node_modules/**', '**/.git/**', '**/dist/**', '**/build/**', '**/.yarn/**', '**/coverage/**', '**/.next/**', '**/.nuxt/**', '**/out/**', '**/.cache/**', '**/.vscode/**', '**/.idea/**', '**/temp/**', '**/tmp/**']`
180+
181+
默认忽略的文件夹表达式。
182+
183+
### 指令工具配置
184+
185+
#### commandWithSend
186+
187+
- 类型:`boolean`
188+
- 默认值:`true`
136189

137-
### 指令插件配置
190+
是否默认发送指令的执行结果。
138191

139192
#### commandList
140193

141-
- 类型:`{ command: string, description: string, selector: string[] }[]`
194+
- 类型:`{ command: string, description: string, selector: string[], confirm: boolean }[]`
142195
- 默认值:`[]`
143196

144-
需要注册的指令列表。
197+
需要注册的指令列表。不填写则默认注册所有一级指令。
145198

146199
##### commandList.command
147200

@@ -164,14 +217,12 @@
164217

165218
指令的触发条件。当聊天内容包含这些关键词时,此指令才会注册给模型。
166219

167-
### 代码执行器配置
220+
##### commandList.confirm
168221

169-
#### codeSandboxAPIKey
170-
171-
- 类型:`string`
172-
- 默认值:``
222+
- 类型:`boolean`
223+
- 默认值:`true`
173224

174-
代码执行工具所需的 API 密钥。密钥需要前往 [e2b](https://e2b.dev/) 获取
225+
执行指令时是否需要二次确认
175226

176227
### 群管插件配置
177228

@@ -180,9 +231,25 @@
180231
- 类型:`string[]`
181232
- 默认值:`[]`
182233

183-
群管理员账号列表。
234+
允许使用群管功能的成员 ID 列表。
235+
236+
#### groupWhitelist
237+
238+
- 类型:`string[]`
239+
- 默认值:`[]`
240+
241+
允许使用群管功能的群 ID 白名单。为空时在所有群可用。
184242

185-
### 画图插件配置
243+
### 定时工具配置
244+
245+
#### cronScopeSelector
246+
247+
- 类型:`string[]`
248+
- 默认值:`[]`
249+
250+
允许使用命令类型定时任务的成员 ID 列表。为空时所有人都可以创建提醒任务,但无法创建命令任务。
251+
252+
### 画图工具配置
186253

187254
#### drawPrompt
188255

@@ -196,16 +263,64 @@
196263
- 类型:`string`
197264
- 默认值:`nai {prompt}`
198265

199-
画图时实际执行的指令。
266+
画图时实际执行的指令。`{prompt}` 为调用时的 prompt。
267+
268+
#### drawSelector
269+
270+
- 类型:`string[]`
271+
- 默认值:`['画', 'image', 'sd', '图', '绘', 'draw', '生成', 'generate', '创作', 'create']`
272+
273+
触发绘画工具的关键词。为空时始终选中。
274+
275+
### 音乐工具配置
276+
277+
#### musicSelector
278+
279+
- 类型:`string[]`
280+
- 默认值:`['音乐', 'music', '歌曲', 'song', '音频', 'audio', '创作', 'create', '生成', 'generate']`
281+
282+
触发音乐生成工具的关键词。为空时始终选中。
283+
284+
### OpenAPI 工具调用插件配置
285+
286+
#### actionsList
287+
288+
- 类型:`{ name: string, description: string, openAPISpec: string, headers: Record<string, string>, selector: string[] }[]`
289+
- 默认值:`[]`
290+
291+
可用 OpenAPI 工具列表。
292+
293+
##### actionsList.name
294+
295+
- 类型:`string`
296+
- 默认值:``
297+
298+
工具名称。请使用纯英文的名称。
299+
300+
##### actionsList.description
301+
302+
- 类型:`string`
303+
- 默认值:``
304+
305+
工具描述。
306+
307+
##### actionsList.openAPISpec
308+
309+
- 类型:`string`
310+
- 默认值:``
311+
312+
OpenAPI 规范文件内容。
313+
314+
##### actionsList.headers
200315

201-
### 知识库插件配置
316+
- 类型:`Record<string, string>`
317+
- 默认值:`{}`
202318

203-
> [!WARNING] 警告
204-
> 启用此工具前需要配置知识库插件,前往 [知识库插件文档](../extension/knowledge.md) 查看用法。
319+
工具请求头。
205320

206-
#### knowledgeId
321+
##### actionsList.selector
207322

208323
- 类型:`string[]`
209324
- 默认值:`[]`
210325

211-
知识库的 ID 列表
326+
触发工具的关键词

0 commit comments

Comments
 (0)