Files
homeagent-sdk/example/files/skill/file-tools/SKILL.md
root db58f66d83 docs(skills): 按需插件 skill 对齐仓内规范 + 文件操作强制走 files 插件
## 1. 文件操作必须走 files 插件(用户明确要求)

旧 skill 写着「如果你已经有 run_shell / bash 之类的能力,优先用那个 —— 它更直接」,
与「文件操作必须走 files_*」相悖。改为:

- 所有已知内容的读写一律 files_read/files_write/files_edit/files_edit_line;
- 不用 cat/echo/sed/tee/重定向代替(shell 拼长文本会被引号转义吃掉,
  且重定向会截断原文件,而本插件是原子写 + 写前留档);
- 唯一例外:文件是命令的副产物(go build -o、git clone、日志重定向)。

cmd-tools skill 同步补一条:文件读写不要用 shell 代替。

## 2. 三个新 skill 对齐 ai_image 等既有规范

- 结构统一为:什么时候用 / 先拉起插件(plugin_start 代码块)/ 工具表 /
  用完可释放(plugin_stop)/ 注意 / 「plugin_stop vs plugin_disable」对照表;
- 修正上一版的错误:把 `plugin_enable` 写成拉起方式 —— 那是**持久**解禁,
  会改开机行为;按需拉起应使用 `plugin_start name=<插件>`。
- files skill 保持 auto_start=false(与「大部分插件不需要自启」一致),
  但把「怎么拉起」写清楚。

## 3. cmd_run 描述补充能力边界

「经完整 bash 执行,支持管道、分号、&&、命令替换、heredoc、重定向;
不支持交互(vim/ssh/top 用 terminal_create)」。

验证:四工程 hmapdev 构建通过;本机重装后 skills_registered=1;
问 agent 写文件时它先 plugin_start 再 files_write/files_read,未用 shell 代替。
2026-10-20 08:57:53 +08:00

2.3 KiB
Raw Blame History

name, description
name description
file-tools 文件读写(read/write/edit/edit_line/ls)。文件操作一律走本插件,不要用 shell 的 cat/echo/sed 代替。按需工具:先 plugin_start files。

文件操作

什么时候用

所有文件读写都走本插件(files_read / files_write / files_edit / files_edit_line / files_ls)。

不要用 cmd_run 或终端里的 cat / echo / sed / tee 代替文件操作:

  • shell 拼长文本会被引号与转义吃掉,写坏文件后很难发现;
  • 本插件是原子写 + 写前留档,shell 重定向会直接截断原文件。

唯一例外:文件本来就是某条命令的副产物(如 go build -o x、 git clone、重定向日志),那属于命令执行,用 cmd/终端没问题; 但只要目标是「把已知内容写进文件」或「读出文件内容」,就用 files_*。

先拉起插件

plugin_start  name=files

文件操作前若 files_* 不在工具清单里,先执行上面这条。

工具 用途
files_read 读文件内容
files_write 写文件(覆盖)
files_edit 局部替换编辑(old 文本须全文件唯一)
files_edit_line 按行号精确替换/插入/删除(目标文本不唯一时用它,如改第 N 个 })
files_ls 列目录

注意

  • 只能访问配置的工作目录内。走出沙箱会明确报错,不要试图绕。
  • 写/改之前先读一遍,确认不是要保留的内容。

★ 用 plugin_stop / plugin_start,不要用 plugin_disable / plugin_enable

四个工具看着像同义词,语义差别很大:

工具 作用 跨重启
plugin_stop 运行态关闭,现在停掉 不影响,重启照常加载
plugin_start 运行态拉起,现在开回来 不影响
plugin_disable 持久禁用 会记下来,开机也不自启
plugin_enable 解除持久禁用 会记下来

释放上下文用 plugin_stop。 用 plugin_disable 会顺手把"开机自启" 永久关掉 —— 用户下次开机发现插件没了,得再手动开回来。

(本插件声明 auto_start: false,本来就不自启;但 plugin_disable 仍会写进持久禁用清单,让 plugin_start 拒绝拉起,只能再用 plugin_enable 解。)