Tools Reference
Complete reference for all 15 built-in agent tools.
Tools are the capabilities your agent uses to interact with the world. Each tool has specific parameters, behaviors, and risk levels.
File Operations
read-file
Low Risk
Reads the contents of a file.
| Parameters | path - File path to read |
| Returns | File contents as string |
| Use Cases | Examining source code, reading configuration, analyzing logs |
write-file
Medium Risk
Creates a new file with specified contents.
| Parameters | path - File path to createcontent - File contents |
| Returns | Success/failure status |
| Use Cases | Creating new files, generating code, writing reports |
edit-file
Medium Risk
Modifies an existing file using search and replace.
| Parameters | path - File pathold_string - Text to findnew_string - Replacement text |
| Returns | Success/failure status with preview |
| Use Cases | Bug fixes, refactoring, updating configuration |
find-files
Low Risk
Searches for files matching a glob pattern.
| Parameters | pattern - Glob pattern (e.g., **/*.ts) |
| Returns | List of matching file paths |
| Use Cases | Locating files by extension, finding configuration files |
Dependency: Requires glob npm package.
search-files
Low Risk
Searches file contents for a pattern.
| Parameters | pattern - Search pattern (regex supported)path - Directory to search |
| Returns | Matching lines with file paths and line numbers |
| Use Cases | Finding function definitions, locating usages, code analysis |
Command Execution
run-command
High Risk
Executes arbitrary shell commands.
| Parameters | command - Shell command to execute |
| Returns | Command output (stdout/stderr) and exit code |
| Use Cases | Running builds, executing tests, system administration |
Security warning
This tool can execute any shell command. Only enable when necessary and use permission restrictions to limit scope.
git-operations
Medium Risk
Performs Git version control operations.
| Parameters | operation - Git operation (status, diff, log, etc.)args - Additional arguments |
| Returns | Git command output |
| Use Cases | Checking status, viewing diffs, creating commits |
Web Operations
web-search
Low Risk
Searches the web for information.
| Parameters | query - Search query |
| Returns | Search results with titles, snippets, and URLs |
| Use Cases | Research, finding documentation, checking current information |
web-fetch
Low Risk
Fetches and parses web page content.
| Parameters | url - URL to fetch |
| Returns | Page content (HTML parsed to text) |
| Use Cases | Reading documentation, extracting data, analyzing content |
Dependencies: Requires axios and cheerio npm packages.
Database
database-query
Medium Risk
Executes SQL queries against a database.
| Parameters | query - SQL querydatabase - Database path/connection |
| Returns | Query results as JSON |
| Use Cases | Data analysis, report generation, debugging |
Dependency: Requires better-sqlite3 npm package.
Integrations
api-client
Medium Risk
Makes HTTP API requests.
| Parameters | url - API endpointmethod - HTTP methodheaders - Request headersbody - Request body |
| Returns | API response |
| Use Cases | API integrations, data fetching, webhooks |
doc-ingest
Medium Risk
Extracts text from documents (PDF, DOCX, etc.).
| Parameters | path - Document file path |
| Returns | Extracted text content |
| Use Cases | Document processing, content extraction, analysis |
Dependencies: Requires pdf-parse and mammoth npm packages.
table-extract
Medium Risk
Extracts tables from documents to structured formats.
| Parameters | path - Document pathformat - Output format (csv, json) |
| Returns | Table data in specified format |
| Use Cases | Data extraction, spreadsheet processing, report parsing |
source-notes
Low Risk
Tracks citations and sources for research.
| Parameters | source - Source informationquote - Relevant excerptnote - Your annotation |
| Returns | Stored citation reference |
| Use Cases | Research documentation, bibliography building, evidence tracking |
local-rag
Low Risk
Performs semantic search over local document corpus.
| Parameters | query - Semantic search querycorpus - Document directory |
| Returns | Relevant document chunks with similarity scores |
| Use Cases | Knowledge retrieval, document Q&A, research assistance |
Permission Levels Summary
| Permission Level | Enabled Tools |
|---|---|
| Restrictive | read-file, find-files, search-files, web-search |
| Balanced | Restrictive + write-file, git-operations, web-fetch, api-client |
| Permissive | All tools including run-command |