工具文档索引

SII CLI 提供了丰富的工具集，帮助你高效地完成各种任务。本文档提供了所有可用工具的概览和详细文档链接。

文件操作工具

这些工具用于读取、写入和管理文件系统中的文件。

工具名称	说明	文档链接
read_file	读取文件内容，支持文本、图片和 PDF	查看文档
write_file	写入文件内容，支持创建新文件或覆盖现有文件	查看文档
replace	在文件中替换文本，支持单次或多次替换	查看文档
read_many_files	批量读取多个文件	查看文档

目录和搜索工具

这些工具用于浏览目录结构和搜索文件。

工具名称	说明	文档链接
list_directory	列出目录中的文件和子目录	查看文档
glob	使用 glob 模式查找文件	查看文档
search_file_content	在文件内容中搜索正则表达式模式	查看文档

命令执行工具

这些工具用于执行 shell 命令和脚本。

工具名称	说明	文档链接
run_shell_command	执行 shell 命令	查看文档

SII 平台工具

这些工具与 SII 平台集成，提供高级功能。

搜索和浏览

工具名称	说明	文档链接
sii_web_search	使用 SII 后端进行网络搜索	查看文档
sii_web_fetch	获取和处理网页内容	查看文档
sii_hybrid_search	混合搜索（网络 + 认知库）	查看文档

认知管理

工具名称	说明	文档链接
sii_cognitions	访问和搜索 SII 认知库	查看文档
sii_cognition_extract_upload	从 URL 提取认知并上传	查看文档

研究工具

工具名称	说明	文档链接
sii_deep_research	进行深度研究	查看文档

通知工具

工具名称	说明	文档链接
sii_email_notification	发送电子邮件通知	查看文档

其他工具

工具名称	说明	文档链接
save_memory	保存长期记忆	查看文档
agent_tool	创建和管理子代理	查看文档

工具使用指南

基本概念

所有工具都遵循以下基本原则：

1. 参数验证：工具会验证所有参数的有效性
2. 安全限制：工具会检查文件路径是否在允许的范围内
3. 错误处理：工具会提供清晰的错误消息
4. 用户确认：某些操作需要用户确认

路径要求

大多数文件操作工具要求使用绝对路径：

• ✅ 正确：/home/user/project/src/main.ts
• ❌ 错误：src/main.ts
• ❌ 错误：./src/main.ts

文件过滤

许多工具支持文件过滤选项：

• respect_git_ignore: 是否遵守 .gitignore 规则
• respect_sii_ignore: 是否遵守 .siiignore 规则
• use_default_excludes: 是否排除常见的大型目录

最佳实践

1. 读取前检查：在写入或修改文件前，先使用 read_file 检查内容
2. 使用合适的工具：
   • 小改动使用 replace
   • 大改动使用 write_file
   • 批量操作使用 read_many_files
3. 分页处理：对于大量结果，使用 limit 和 offset 参数
4. 错误处理：始终检查工具返回的错误信息

工具开发

如果你想了解如何开发新工具或扩展现有工具，请参考：

• 工具开发指南
• API 参考

反馈和支持

如果你在使用工具时遇到问题或有改进建议，请：

• 提交 Issue：GitHub Issues
• 加入讨论：GitHub Discussions