Tools Documentation Index

SII CLI provides a rich set of tools to help you efficiently complete various tasks. This document provides an overview of all available tools and links to detailed documentation.

File Operation Tools

These tools are used for reading, writing, and managing files in the filesystem.

Tool Name	Description	Documentation
read_file	Read file content, supports text, images, and PDF	View Docs
write_file	Write file content, supports creating new files or overwriting existing ones	View Docs
replace	Replace text in files, supports single or multiple replacements	View Docs
read_many_files	Read multiple files in batch	View Docs

Directory and Search Tools

These tools are used for browsing directory structures and searching files.

Tool Name	Description	Documentation
list_directory	List files and subdirectories in a directory	View Docs
glob	Find files using glob patterns	View Docs
search_file_content	Search for regex patterns in file content	View Docs

Command Execution Tools

These tools are used for executing shell commands and scripts.

Tool Name	Description	Documentation
run_shell_command	Execute shell commands	View Docs

SII Platform Tools

These tools integrate with the SII platform to provide advanced features.

Search and Browse

Tool Name	Description	Documentation
sii_web_search	Web search using SII backend	View Docs
sii_web_fetch	Fetch and process web content	View Docs
sii_hybrid_search	Hybrid search (web + cognitions)	View Docs

Cognition Management

Tool Name	Description	Documentation
sii_cognitions	Access and search SII cognition database	View Docs
sii_cognition_extract_upload	Extract cognition from URLs and upload	View Docs

Research Tools

Tool Name	Description	Documentation
sii_deep_research	Conduct deep research	View Docs

Notification Tools

Tool Name	Description	Documentation
sii_email_notification	Send email notifications	View Docs

Other Tools

Tool Name	Description	Documentation
save_memory	Save long-term memory	View Docs
agent_tool	Create and manage sub-agents	View Docs

Tool Usage Guide

Basic Concepts

All tools follow these basic principles:

1. Parameter Validation: Tools validate all parameter validity
2. Security Restrictions: Tools check if file paths are within allowed scope
3. Error Handling: Tools provide clear error messages
4. User Confirmation: Some operations require user confirmation

Path Requirements

Most file operation tools require absolute paths:

• ✅ Correct: /home/user/project/src/main.ts
• ❌ Wrong: src/main.ts
• ❌ Wrong: ./src/main.ts

File Filtering

Many tools support file filtering options:

• respect_git_ignore: Whether to respect .gitignore rules
• respect_sii_ignore: Whether to respect .siiignore rules
• use_default_excludes: Whether to exclude common large directories

Best Practices

1. Check Before Writing: Use read_file to check content before writing or modifying files
2. Use Appropriate Tools:
   • Small changes: use replace
   • Large changes: use write_file
   • Batch operations: use read_many_files
3. Pagination: For large result sets, use limit and offset parameters
4. Error Handling: Always check error messages returned by tools

Tool Development

If you want to learn how to develop new tools or extend existing ones, please refer to:

• Tool Development Guide
• API Reference

Feedback and Support

If you encounter issues or have suggestions for improvement:

• Submit Issue: GitHub Issues
• Join Discussion: GitHub Discussions