foliko 1.0.77 → 1.0.78
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/.agent/data/default.json +31559 -0
- package/.agent/data/plugins-state.json +10 -1
- package/.claude/settings.local.json +13 -2
- package/.env.example +54 -54
- package/cli/src/commands/chat.js +1 -1
- package/examples/basic.js +1 -1
- package/package.json +5 -3
- package/plugins/ai-plugin.js +1 -1
- package/plugins/ambient-agent/index.js +1 -1
- package/plugins/audit-plugin.js +1 -1
- package/plugins/default-plugins.js +92 -209
- package/plugins/email/index.js +1 -1
- package/plugins/extension-executor-plugin.js +326 -0
- package/plugins/feishu-plugin.js +1 -1
- package/plugins/file-system-plugin.js +57 -6
- package/plugins/gate-trading.js +747 -0
- package/plugins/install-plugin.js +1 -1
- package/plugins/python-executor-plugin.js +1 -1
- package/plugins/python-plugin-loader.js +275 -105
- package/plugins/rules-plugin.js +1 -1
- package/plugins/scheduler-plugin.js +1 -1
- package/plugins/session-plugin.js +132 -7
- package/plugins/shell-executor-plugin.js +1 -1
- package/plugins/storage-plugin.js +24 -1
- package/plugins/subagent-plugin.js +2 -2
- package/plugins/telegram-plugin.js +1 -1
- package/plugins/think-plugin.js +10 -10
- package/plugins/tools-plugin.js +1 -1
- package/plugins/web-plugin.js +49 -18
- package/plugins/weixin-plugin.js +1 -1
- package/skills/foliko-dev/SKILL.md +583 -500
- package/skills/python-plugin-dev/SKILL.md +238 -266
- package/src/core/agent-chat.js +103 -4
- package/src/core/agent.js +85 -19
- package/src/core/plugin-base.js +43 -0
- package/src/executors/mcp-executor.js +126 -22
|
@@ -1,500 +1,583 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: foliko-dev
|
|
3
|
-
description: Foliko Framework 插件开发指南。当用户说"创建插件"、"开发插件"时立即调用此 skill。
|
|
4
|
-
allowed-tools: Read, Write, Edit, Glob, Grep, Bash
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Foliko Plugin Development Guide
|
|
8
|
-
|
|
9
|
-
## 概述
|
|
10
|
-
|
|
11
|
-
Foliko 是一个基于插件的 Agent 框架,核心简单,通过插件扩展功能。
|
|
12
|
-
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
## 插件存放位置
|
|
16
|
-
|
|
17
|
-
### `.agent/plugins/` 目录(用户插件,自动加载)
|
|
18
|
-
|
|
19
|
-
用户自定义插件放在项目根目录的 `.agent/plugins/` 下,**自动加载**,无需手动注册。
|
|
20
|
-
|
|
21
|
-
**推荐使用文件夹结构**(适合复杂插件):
|
|
22
|
-
|
|
23
|
-
```
|
|
24
|
-
项目目录/
|
|
25
|
-
└── .agent/
|
|
26
|
-
└── plugins/
|
|
27
|
-
├── my-plugin/ ✅ 文件夹结构(推荐)
|
|
28
|
-
│ ├── package.json # 可选,main 字段指定入口
|
|
29
|
-
│ ├── index.js # 默认入口
|
|
30
|
-
│ └── node_modules/ # 可选,插件私有依赖
|
|
31
|
-
├── another-plugin/ ✅ 另一个文件夹插件
|
|
32
|
-
│ └── index.js
|
|
33
|
-
└── legacy.js ✅ 单文件仍支持
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
**文件夹结构的优势:**
|
|
37
|
-
|
|
38
|
-
- 支持 `package.json` 的 `main` 字段自定义入口
|
|
39
|
-
- 支持 `node_modules` 存放插件私有依赖
|
|
40
|
-
- 更适合复杂插件的代码组织
|
|
41
|
-
|
|
42
|
-
### `plugins/` 目录(内置插件)
|
|
43
|
-
|
|
44
|
-
框架内置插件位于 `plugins/` 目录。
|
|
45
|
-
|
|
46
|
-
---
|
|
47
|
-
|
|
48
|
-
## 用户插件写法(`.agent/plugins/`)
|
|
49
|
-
|
|
50
|
-
**必须使用免引入写法**:
|
|
51
|
-
|
|
52
|
-
### 文件夹结构(推荐)
|
|
53
|
-
|
|
54
|
-
```
|
|
55
|
-
.agent/plugins/my-plugin/
|
|
56
|
-
├── package.json # 可选
|
|
57
|
-
└── index.js # 入口
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
```json
|
|
61
|
-
// package.json 示例
|
|
62
|
-
{
|
|
63
|
-
"name": "my-plugin",
|
|
64
|
-
"main": "index.js"
|
|
65
|
-
}
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
```javascript
|
|
69
|
-
// .agent/plugins/my-plugin/index.js
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
this.
|
|
77
|
-
this.
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
//
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
}
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
this.
|
|
123
|
-
this.
|
|
124
|
-
this.
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
description: '我的工具',
|
|
132
|
-
inputSchema: z.object({
|
|
133
|
-
param: z.string().describe('参数描述'),
|
|
134
|
-
}),
|
|
135
|
-
execute: async (args
|
|
136
|
-
return { success: true, result: args.param };
|
|
137
|
-
},
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
};
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
}
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
```
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
1
|
+
---
|
|
2
|
+
name: foliko-dev
|
|
3
|
+
description: Foliko Framework 插件开发指南。当用户说"创建插件"、"开发插件"时立即调用此 skill。
|
|
4
|
+
allowed-tools: Read, Write, Edit, Glob, Grep, Bash
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Foliko Plugin Development Guide
|
|
8
|
+
|
|
9
|
+
## 概述
|
|
10
|
+
|
|
11
|
+
Foliko 是一个基于插件的 Agent 框架,核心简单,通过插件扩展功能。
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## 插件存放位置
|
|
16
|
+
|
|
17
|
+
### `.agent/plugins/` 目录(用户插件,自动加载)
|
|
18
|
+
|
|
19
|
+
用户自定义插件放在项目根目录的 `.agent/plugins/` 下,**自动加载**,无需手动注册。
|
|
20
|
+
|
|
21
|
+
**推荐使用文件夹结构**(适合复杂插件):
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
项目目录/
|
|
25
|
+
└── .agent/
|
|
26
|
+
└── plugins/
|
|
27
|
+
├── my-plugin/ ✅ 文件夹结构(推荐)
|
|
28
|
+
│ ├── package.json # 可选,main 字段指定入口
|
|
29
|
+
│ ├── index.js # 默认入口
|
|
30
|
+
│ └── node_modules/ # 可选,插件私有依赖
|
|
31
|
+
├── another-plugin/ ✅ 另一个文件夹插件
|
|
32
|
+
│ └── index.js
|
|
33
|
+
└── legacy.js ✅ 单文件仍支持
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
**文件夹结构的优势:**
|
|
37
|
+
|
|
38
|
+
- 支持 `package.json` 的 `main` 字段自定义入口
|
|
39
|
+
- 支持 `node_modules` 存放插件私有依赖
|
|
40
|
+
- 更适合复杂插件的代码组织
|
|
41
|
+
|
|
42
|
+
### `plugins/` 目录(内置插件)
|
|
43
|
+
|
|
44
|
+
框架内置插件位于 `plugins/` 目录。
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## 用户插件写法(`.agent/plugins/`)
|
|
49
|
+
|
|
50
|
+
**必须使用免引入写法**:
|
|
51
|
+
|
|
52
|
+
### 文件夹结构(推荐)
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
.agent/plugins/my-plugin/
|
|
56
|
+
├── package.json # 可选
|
|
57
|
+
└── index.js # 入口
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
// package.json 示例
|
|
62
|
+
{
|
|
63
|
+
"name": "my-plugin",
|
|
64
|
+
"main": "index.js"
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
```javascript
|
|
69
|
+
// .agent/plugins/my-plugin/index.js
|
|
70
|
+
const { z } = require('zod');
|
|
71
|
+
|
|
72
|
+
module.exports = function (Plugin) {
|
|
73
|
+
return class MyPlugin extends Plugin {
|
|
74
|
+
constructor(config = {}) {
|
|
75
|
+
super();
|
|
76
|
+
this.name = 'my-plugin';
|
|
77
|
+
this.version = '1.0.0';
|
|
78
|
+
this.description = '我的工具插件';
|
|
79
|
+
this.priority = 10;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
// 工具定义在 this.tools 中
|
|
83
|
+
tools = {
|
|
84
|
+
my_tool: {
|
|
85
|
+
description: '我的工具',
|
|
86
|
+
inputSchema: z.object({
|
|
87
|
+
param: z.string().describe('参数描述'),
|
|
88
|
+
}),
|
|
89
|
+
execute: async (args) => {
|
|
90
|
+
return { success: true, result: args.param };
|
|
91
|
+
},
|
|
92
|
+
},
|
|
93
|
+
};
|
|
94
|
+
|
|
95
|
+
install(framework) {
|
|
96
|
+
// 也可以用 this.registerTool() 注册额外工具
|
|
97
|
+
this.registerTool('another_tool', {
|
|
98
|
+
description: '另一个工具',
|
|
99
|
+
inputSchema: z.object({}),
|
|
100
|
+
execute: async (args) => ({ success: true }),
|
|
101
|
+
});
|
|
102
|
+
return this;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
uninstall(framework) {
|
|
106
|
+
// 清理资源
|
|
107
|
+
}
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### 单文件结构(仍支持)
|
|
113
|
+
|
|
114
|
+
```javascript
|
|
115
|
+
// .agent/plugins/my-plugin.js
|
|
116
|
+
const { z } = require('zod');
|
|
117
|
+
|
|
118
|
+
module.exports = function (Plugin) {
|
|
119
|
+
return class MyPlugin extends Plugin {
|
|
120
|
+
constructor(config = {}) {
|
|
121
|
+
super();
|
|
122
|
+
this.name = 'my-plugin';
|
|
123
|
+
this.version = '1.0.0';
|
|
124
|
+
this.description = '我的工具插件';
|
|
125
|
+
this.priority = 10;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
// 工具定义在 this.tools 中
|
|
129
|
+
tools = {
|
|
130
|
+
my_tool: {
|
|
131
|
+
description: '我的工具',
|
|
132
|
+
inputSchema: z.object({
|
|
133
|
+
param: z.string().describe('参数描述'),
|
|
134
|
+
}),
|
|
135
|
+
execute: async (args) => {
|
|
136
|
+
return { success: true, result: args.param };
|
|
137
|
+
},
|
|
138
|
+
},
|
|
139
|
+
};
|
|
140
|
+
|
|
141
|
+
install(framework) {
|
|
142
|
+
return this;
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
uninstall(framework) {
|
|
146
|
+
// 清理资源
|
|
147
|
+
}
|
|
148
|
+
};
|
|
149
|
+
};
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
**注意**:如果文件夹和同名 `.js` 文件同时存在,**文件夹优先**。
|
|
153
|
+
|
|
154
|
+
**插件开发流程:**
|
|
155
|
+
|
|
156
|
+
1. **创建插件**(优先使用文件夹结构)
|
|
157
|
+
2. **安装依赖**:
|
|
158
|
+
- 文件夹插件:`install { package: "包名", path: ".agent/plugins/插件名" }`
|
|
159
|
+
- 单文件插件:`install { package: "包名" }`
|
|
160
|
+
3. **热重载**:`reload_plugins`
|
|
161
|
+
4. **检查加载状态**
|
|
162
|
+
|
|
163
|
+
**关键点:**
|
|
164
|
+
|
|
165
|
+
- `Plugin` 基类由系统自动传入(无需 require)
|
|
166
|
+
- 函数直接返回插件类
|
|
167
|
+
- 在 `install(framework)` 中通过 `framework` 注册工具
|
|
168
|
+
|
|
169
|
+
---
|
|
170
|
+
|
|
171
|
+
## 依赖管理
|
|
172
|
+
|
|
173
|
+
当插件需要使用第三方 npm 包(如 `zod`、`axios` 等)时,根据插件类型选择安装位置:
|
|
174
|
+
|
|
175
|
+
| 插件类型 | 安装位置 | 说明 |
|
|
176
|
+
| -------------- | ------------------------------------- | ---------------------- |
|
|
177
|
+
| **文件夹插件** | `.agent/plugins/插件名/node_modules/` | 插件自包含,可独立迁移 |
|
|
178
|
+
| **单文件插件** | `.agent/node_modules/` | 共享依赖 |
|
|
179
|
+
|
|
180
|
+
### 自动安装工具
|
|
181
|
+
|
|
182
|
+
框架提供了 `install` 工具,支持以下用法:
|
|
183
|
+
|
|
184
|
+
```javascript
|
|
185
|
+
// 安装到默认位置 .agent/node_modules
|
|
186
|
+
install({ package: 'zod' });
|
|
187
|
+
|
|
188
|
+
// 安装到指定目录(用于文件夹插件)
|
|
189
|
+
install({ package: 'axios', path: '.agent/plugins/my-plugin' });
|
|
190
|
+
|
|
191
|
+
// 从 package.json 安装所有依赖到默认位置
|
|
192
|
+
install({ file: './package.json' });
|
|
193
|
+
|
|
194
|
+
// 从 package.json 安装所有依赖到指定目录
|
|
195
|
+
install({ file: './my-plugin/package.json', path: '.agent/plugins/my-plugin' });
|
|
196
|
+
|
|
197
|
+
// 仅指定路径,安装该目录下的 package.json 依赖
|
|
198
|
+
install({ path: '.agent/plugins/my-plugin' });
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### 文件夹插件的依赖安装示例
|
|
202
|
+
|
|
203
|
+
```javascript
|
|
204
|
+
// .agent/plugins/my-plugin/index.js
|
|
205
|
+
const { z } = require('zod');
|
|
206
|
+
|
|
207
|
+
module.exports = function (Plugin) {
|
|
208
|
+
return class MyPlugin extends Plugin {
|
|
209
|
+
constructor(config = {}) {
|
|
210
|
+
super();
|
|
211
|
+
this.name = 'my-plugin';
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
tools = {
|
|
215
|
+
fetch_data: {
|
|
216
|
+
description: '获取远程数据',
|
|
217
|
+
inputSchema: z.object({
|
|
218
|
+
url: z.string().describe('API URL'),
|
|
219
|
+
}),
|
|
220
|
+
execute: async (args) => {
|
|
221
|
+
// 安装到插件自己的目录
|
|
222
|
+
const pluginDir = '.agent/plugins/my-plugin';
|
|
223
|
+
await framework.callTool('install', {
|
|
224
|
+
package: 'axios',
|
|
225
|
+
path: pluginDir,
|
|
226
|
+
});
|
|
227
|
+
|
|
228
|
+
// 引入插件目录下的 node_modules
|
|
229
|
+
const axios = require(`${pluginDir}/node_modules/axios`);
|
|
230
|
+
const response = await axios.get(args.url);
|
|
231
|
+
return { success: true, data: response.data };
|
|
232
|
+
},
|
|
233
|
+
},
|
|
234
|
+
};
|
|
235
|
+
|
|
236
|
+
install(framework) {
|
|
237
|
+
return this;
|
|
238
|
+
}
|
|
239
|
+
};
|
|
240
|
+
};
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
### 安装步骤
|
|
244
|
+
|
|
245
|
+
当 LLM 检测到 `Cannot find module 'xxx'` 错误时,必须:
|
|
246
|
+
|
|
247
|
+
1. **确定插件目录**:如果插件是文件夹结构,安装到插件目录
|
|
248
|
+
2. **调用 `install` 工具** 安装缺失的包
|
|
249
|
+
3. **安装完成后** 重新加载插件
|
|
250
|
+
4. **返回状态** 给用户
|
|
251
|
+
|
|
252
|
+
示例流程(文件夹插件):
|
|
253
|
+
|
|
254
|
+
```
|
|
255
|
+
错误: Cannot find module 'axios'
|
|
256
|
+
↓
|
|
257
|
+
确定插件目录: .agent/plugins/my-plugin
|
|
258
|
+
↓
|
|
259
|
+
自动安装: install { package: "axios", path: ".agent/plugins/my-plugin" }
|
|
260
|
+
↓
|
|
261
|
+
重新加载插件
|
|
262
|
+
↓
|
|
263
|
+
成功
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
### 重要提醒
|
|
267
|
+
|
|
268
|
+
- **文件夹插件优先安装到插件目录** - 使用 `path` 参数指定插件目录
|
|
269
|
+
- **不要尝试手动 require 全局安装的包** - 必须在指定目录中安装
|
|
270
|
+
- **使用 `install` 工具自动处理** - 让 LLM 知道如何处理缺失依赖
|
|
271
|
+
- **插件加载失败时检查依赖** - 优先安装缺失的包再重试
|
|
272
|
+
|
|
273
|
+
---
|
|
274
|
+
|
|
275
|
+
## 内置插件写法(`plugins/` 目录)
|
|
276
|
+
|
|
277
|
+
内置插件需要 `require` Plugin 基类:
|
|
278
|
+
|
|
279
|
+
```javascript
|
|
280
|
+
// plugins/my-plugin.js
|
|
281
|
+
const { Plugin } = require('../src/core/plugin-base');
|
|
282
|
+
const { z } = require('zod');
|
|
283
|
+
|
|
284
|
+
class MyPlugin extends Plugin {
|
|
285
|
+
constructor(config = {}) {
|
|
286
|
+
super();
|
|
287
|
+
this.name = 'my-plugin';
|
|
288
|
+
this.version = '1.0.0';
|
|
289
|
+
this.description = '我的工具插件';
|
|
290
|
+
this.priority = 10;
|
|
291
|
+
}
|
|
292
|
+
|
|
293
|
+
// 工具定义在 this.tools 中,ExtensionExecutor 自动扫描注册
|
|
294
|
+
tools = {
|
|
295
|
+
my_tool: {
|
|
296
|
+
description: '我的工具',
|
|
297
|
+
inputSchema: z.object({
|
|
298
|
+
param: z.string().describe('参数描述'),
|
|
299
|
+
}),
|
|
300
|
+
execute: async (args) => {
|
|
301
|
+
return { success: true, result: args.param };
|
|
302
|
+
},
|
|
303
|
+
},
|
|
304
|
+
};
|
|
305
|
+
|
|
306
|
+
install(framework) {
|
|
307
|
+
// 可以用 this.registerTool() 注册额外工具
|
|
308
|
+
this.registerTool('another_tool', {
|
|
309
|
+
description: '另一个工具',
|
|
310
|
+
inputSchema: z.object({}),
|
|
311
|
+
execute: async (args) => ({ success: true }),
|
|
312
|
+
});
|
|
313
|
+
return this;
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
uninstall(framework) {}
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
module.exports = MyPlugin;
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
---
|
|
323
|
+
|
|
324
|
+
## 插件属性
|
|
325
|
+
|
|
326
|
+
| 属性 | 类型 | 必须 | 说明 |
|
|
327
|
+
| ------------- | ------ | ---- | ------------------------------------------------------------ |
|
|
328
|
+
| `name` | string | ✅ | 唯一名称 |
|
|
329
|
+
| `version` | string | ❌ | 版本号,默认 '1.0.0' |
|
|
330
|
+
| `description` | string | ❌ | 插件描述 |
|
|
331
|
+
| `priority` | number | ❌ | 加载优先级,默认 10 |
|
|
332
|
+
| `tools` | object | ❌ | 工具定义 `{ name: toolDef }`,ExtensionExecutor 自动扫描注册 |
|
|
333
|
+
|
|
334
|
+
---
|
|
335
|
+
|
|
336
|
+
## 生命周期
|
|
337
|
+
|
|
338
|
+
| 方法 | 调用时机 | 必须实现 |
|
|
339
|
+
| ---------------------- | ---------- | -------- |
|
|
340
|
+
| `install(framework)` | 插件安装时 | ✅ |
|
|
341
|
+
| `start(framework)` | 插件启动时 | 推荐 |
|
|
342
|
+
| `reload(framework)` | 热重载时 | 可选 |
|
|
343
|
+
| `uninstall(framework)` | 卸载时 | 推荐 |
|
|
344
|
+
|
|
345
|
+
---
|
|
346
|
+
|
|
347
|
+
## 注册工具
|
|
348
|
+
|
|
349
|
+
### 最新方式:定义在 `this.tools = {}`
|
|
350
|
+
|
|
351
|
+
插件将工具定义在 `this.tools = {}` 中,ExtensionExecutor 会自动扫描并注册到系统提示词:
|
|
352
|
+
|
|
353
|
+
```javascript
|
|
354
|
+
class MyPlugin extends Plugin {
|
|
355
|
+
constructor(config = {}) {
|
|
356
|
+
super();
|
|
357
|
+
this.name = 'my-plugin';
|
|
358
|
+
this.description = '我的工具插件';
|
|
359
|
+
}
|
|
360
|
+
|
|
361
|
+
tools = {
|
|
362
|
+
my_tool: {
|
|
363
|
+
description: '我的工具',
|
|
364
|
+
inputSchema: z.object({
|
|
365
|
+
param: z.string().describe('参数描述'),
|
|
366
|
+
}),
|
|
367
|
+
execute: async (args) => {
|
|
368
|
+
return { success: true, result: args.param };
|
|
369
|
+
},
|
|
370
|
+
},
|
|
371
|
+
};
|
|
372
|
+
}
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
### 方式2:使用 `this.registerTool()`
|
|
376
|
+
|
|
377
|
+
支持两种调用格式:
|
|
378
|
+
|
|
379
|
+
```javascript
|
|
380
|
+
install(framework) {
|
|
381
|
+
const { z } = require('zod');
|
|
382
|
+
|
|
383
|
+
// 方式1:分开传 name 和 def
|
|
384
|
+
this.registerTool('my_tool', {
|
|
385
|
+
description: '我的工具',
|
|
386
|
+
inputSchema: z.object({
|
|
387
|
+
param: z.string().describe('参数描述')
|
|
388
|
+
}),
|
|
389
|
+
execute: async (args) => {
|
|
390
|
+
return { success: true, result: args.param };
|
|
391
|
+
}
|
|
392
|
+
});
|
|
393
|
+
|
|
394
|
+
// 方式2:直接传对象(name 在对象中)
|
|
395
|
+
this.registerTool({
|
|
396
|
+
name: 'another_tool',
|
|
397
|
+
description: '另一个工具',
|
|
398
|
+
inputSchema: z.object({}),
|
|
399
|
+
execute: async (args) => ({ success: true })
|
|
400
|
+
});
|
|
401
|
+
|
|
402
|
+
return this;
|
|
403
|
+
}
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
### 旧方式(仍兼容,但不推荐)
|
|
407
|
+
|
|
408
|
+
```javascript
|
|
409
|
+
install(framework) {
|
|
410
|
+
framework.registerTool({
|
|
411
|
+
name: 'my_tool',
|
|
412
|
+
description: '工具描述',
|
|
413
|
+
inputSchema: z.object({
|
|
414
|
+
param: z.string().describe('参数描述')
|
|
415
|
+
}),
|
|
416
|
+
execute: async (args, framework) => {
|
|
417
|
+
return { success: true, result: args.param }
|
|
418
|
+
}
|
|
419
|
+
})
|
|
420
|
+
return this
|
|
421
|
+
}
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
---
|
|
427
|
+
|
|
428
|
+
## 核心规则
|
|
429
|
+
|
|
430
|
+
| 规则 | 说明 |
|
|
431
|
+
| ----------------------------- | ------------------------------------------------- |
|
|
432
|
+
| **优先使用 this.tools = {}** | ExtensionExecutor 自动扫描并注册到系统提示词 |
|
|
433
|
+
| **优先使用文件夹结构** | 复杂插件推荐用文件夹,便于管理依赖和代码 |
|
|
434
|
+
| **必须用 inputSchema** | `inputSchema: z.object({})`(不是 parameters!) |
|
|
435
|
+
| **必须用 zod 定义参数** | `param: z.string().describe('描述')` |
|
|
436
|
+
| **install 必须返回 this** | 确保链式调用 |
|
|
437
|
+
| **文件夹与文件重名时** | 文件夹优先,同名 `.js` 文件会被忽略 |
|
|
438
|
+
| **工具自动出现在系统提示词** | 定义在 `this.tools` 中会自动注册 |
|
|
439
|
+
|
|
440
|
+
## 开发完成后注意事项
|
|
441
|
+
|
|
442
|
+
### 引入第三方库时
|
|
443
|
+
|
|
444
|
+
**必须先安装依赖,再热重载!**
|
|
445
|
+
|
|
446
|
+
如果插件需要使用第三方 npm 包(如 `zod`、`axios`),按以下顺序操作:
|
|
447
|
+
|
|
448
|
+
1. **创建插件文件**(暂不加载)
|
|
449
|
+
2. **安装依赖**:`install { package: "包名" }`
|
|
450
|
+
3. **热重载**:`reload_plugins`
|
|
451
|
+
4. **检查加载状态**
|
|
452
|
+
|
|
453
|
+
示例:
|
|
454
|
+
|
|
455
|
+
```
|
|
456
|
+
|
|
457
|
+
创建插件 my-plugin.js(需要 zod)
|
|
458
|
+
↓
|
|
459
|
+
install { package: "zod" }
|
|
460
|
+
↓
|
|
461
|
+
reload_plugins
|
|
462
|
+
↓
|
|
463
|
+
成功加载
|
|
464
|
+
|
|
465
|
+
````
|
|
466
|
+
|
|
467
|
+
### 其他注意事项
|
|
468
|
+
|
|
469
|
+
--**开发完成重载成功后检测有没有加载新的插件,不需要进行过多测试步骤,直接告知用户状态即可**
|
|
470
|
+
|
|
471
|
+
---
|
|
472
|
+
|
|
473
|
+
## 内置占位符
|
|
474
|
+
|
|
475
|
+
Agent 支持 `sharedPrompt` 中的占位符替换:
|
|
476
|
+
|
|
477
|
+
| 占位符 | 说明 |
|
|
478
|
+
| --------------- | -------- |
|
|
479
|
+
| `{{WORK_DIR}}` | 工作目录 |
|
|
480
|
+
| `{{HOME_DIR}}` | 主目录 |
|
|
481
|
+
| `{{HOST_NAME}}` | 主机名 |
|
|
482
|
+
| `{{PLATFORM}}` | 平台 |
|
|
483
|
+
| `{{TIME}}` | 当前时间 |
|
|
484
|
+
| `{{DATE}}` | 当前日期 |
|
|
485
|
+
|
|
486
|
+
---
|
|
487
|
+
|
|
488
|
+
## 创建 Agent
|
|
489
|
+
|
|
490
|
+
```javascript
|
|
491
|
+
const agent = framework.createAgent({
|
|
492
|
+
name: 'MyAgent',
|
|
493
|
+
systemPrompt: '你是一个助手',
|
|
494
|
+
sharedPrompt: '工作目录: {{WORK_DIR}}\n项目: {{projectName}}',
|
|
495
|
+
metadata: {
|
|
496
|
+
projectName: 'MyProject',
|
|
497
|
+
version: '1.0.0',
|
|
498
|
+
},
|
|
499
|
+
});
|
|
500
|
+
````
|
|
501
|
+
|
|
502
|
+
---
|
|
503
|
+
|
|
504
|
+
## 热重载
|
|
505
|
+
|
|
506
|
+
```javascript
|
|
507
|
+
// 重载单个插件
|
|
508
|
+
await framework.reloadPlugin('my-plugin');
|
|
509
|
+
|
|
510
|
+
// 重载所有插件
|
|
511
|
+
await framework.reloadAllPlugins();
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
---
|
|
515
|
+
|
|
516
|
+
## 子 Agent 注册
|
|
517
|
+
|
|
518
|
+
插件可以通过 `this.agents = []` 配置或 `this.registerSubAgent()` 方法注册子Agent。
|
|
519
|
+
|
|
520
|
+
### 方式1:配置 `agents` 数组
|
|
521
|
+
|
|
522
|
+
```javascript
|
|
523
|
+
// plugins/my-plugin.js
|
|
524
|
+
const { Plugin } = require('../src/core/plugin-base');
|
|
525
|
+
const { tool } = require('ai');
|
|
526
|
+
const { z } = require('zod');
|
|
527
|
+
|
|
528
|
+
class MyPlugin extends Plugin {
|
|
529
|
+
constructor(config = {}) {
|
|
530
|
+
super();
|
|
531
|
+
this.name = 'my-plugin';
|
|
532
|
+
}
|
|
533
|
+
|
|
534
|
+
// 配置式注册子Agent,插件启动时自动创建
|
|
535
|
+
agents = [
|
|
536
|
+
{
|
|
537
|
+
name: 'code-agent',
|
|
538
|
+
role: '代码专家',
|
|
539
|
+
description: '处理代码开发任务',
|
|
540
|
+
tools: {
|
|
541
|
+
compile: tool({
|
|
542
|
+
description: '编译代码',
|
|
543
|
+
parameters: z.object({
|
|
544
|
+
language: z.string(),
|
|
545
|
+
code: z.string(),
|
|
546
|
+
}),
|
|
547
|
+
execute: async (args) => ({ success: true }),
|
|
548
|
+
}),
|
|
549
|
+
},
|
|
550
|
+
parentTools: ['read_file', 'write_file'],
|
|
551
|
+
},
|
|
552
|
+
];
|
|
553
|
+
}
|
|
554
|
+
```
|
|
555
|
+
|
|
556
|
+
### 方式2:手动调用 `registerSubAgent()`
|
|
557
|
+
|
|
558
|
+
```javascript
|
|
559
|
+
start(framework) {
|
|
560
|
+
this.registerSubAgent({
|
|
561
|
+
name: 'code-agent',
|
|
562
|
+
role: '代码专家',
|
|
563
|
+
tools: {
|
|
564
|
+
compile: tool({
|
|
565
|
+
description: '编译代码',
|
|
566
|
+
parameters: z.object({ language: z.string(), code: z.string() }),
|
|
567
|
+
execute: async (args) => ({ success: true })
|
|
568
|
+
})
|
|
569
|
+
},
|
|
570
|
+
parentTools: ['read_file', 'write_file']
|
|
571
|
+
})
|
|
572
|
+
}
|
|
573
|
+
```
|
|
574
|
+
|
|
575
|
+
### 子Agent配置说明
|
|
576
|
+
|
|
577
|
+
| 字段 | 类型 | 说明 |
|
|
578
|
+
| ------------- | ------ | ----------------------------------------------- |
|
|
579
|
+
| `name` | string | 子Agent名称(唯一标识) |
|
|
580
|
+
| `role` | string | 角色描述 |
|
|
581
|
+
| `description` | string | 详细描述 |
|
|
582
|
+
| `tools` | object | 自定义工具 `{ name: toolDef }`,只属于此子Agent |
|
|
583
|
+
| `parentTools` | array | 从父Agent继承的工具名称列表 |
|