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.

Parameterspath - File path to read
ReturnsFile contents as string
Use CasesExamining source code, reading configuration, analyzing logs

write-file

Medium Risk

Creates a new file with specified contents.

Parameterspath - File path to create
content - File contents
ReturnsSuccess/failure status
Use CasesCreating new files, generating code, writing reports

edit-file

Medium Risk

Modifies an existing file using search and replace.

Parameterspath - File path
old_string - Text to find
new_string - Replacement text
ReturnsSuccess/failure status with preview
Use CasesBug fixes, refactoring, updating configuration

find-files

Low Risk

Searches for files matching a glob pattern.

Parameterspattern - Glob pattern (e.g., **/*.ts)
ReturnsList of matching file paths
Use CasesLocating files by extension, finding configuration files

Dependency: Requires glob npm package.

search-files

Low Risk

Searches file contents for a pattern.

Parameterspattern - Search pattern (regex supported)
path - Directory to search
ReturnsMatching lines with file paths and line numbers
Use CasesFinding function definitions, locating usages, code analysis

Command Execution

run-command

High Risk

Executes arbitrary shell commands.

Parameterscommand - Shell command to execute
ReturnsCommand output (stdout/stderr) and exit code
Use CasesRunning 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.

Parametersoperation - Git operation (status, diff, log, etc.)
args - Additional arguments
ReturnsGit command output
Use CasesChecking status, viewing diffs, creating commits

Web Operations

web-search

Low Risk

Searches the web for information.

Parametersquery - Search query
ReturnsSearch results with titles, snippets, and URLs
Use CasesResearch, finding documentation, checking current information

web-fetch

Low Risk

Fetches and parses web page content.

Parametersurl - URL to fetch
ReturnsPage content (HTML parsed to text)
Use CasesReading documentation, extracting data, analyzing content

Dependencies: Requires axios and cheerio npm packages.

Database

database-query

Medium Risk

Executes SQL queries against a database.

Parametersquery - SQL query
database - Database path/connection
ReturnsQuery results as JSON
Use CasesData analysis, report generation, debugging

Dependency: Requires better-sqlite3 npm package.

Integrations

api-client

Medium Risk

Makes HTTP API requests.

Parametersurl - API endpoint
method - HTTP method
headers - Request headers
body - Request body
ReturnsAPI response
Use CasesAPI integrations, data fetching, webhooks

doc-ingest

Medium Risk

Extracts text from documents (PDF, DOCX, etc.).

Parameterspath - Document file path
ReturnsExtracted text content
Use CasesDocument processing, content extraction, analysis

Dependencies: Requires pdf-parse and mammoth npm packages.

table-extract

Medium Risk

Extracts tables from documents to structured formats.

Parameterspath - Document path
format - Output format (csv, json)
ReturnsTable data in specified format
Use CasesData extraction, spreadsheet processing, report parsing

source-notes

Low Risk

Tracks citations and sources for research.

Parameterssource - Source information
quote - Relevant excerpt
note - Your annotation
ReturnsStored citation reference
Use CasesResearch documentation, bibliography building, evidence tracking

local-rag

Low Risk

Performs semantic search over local document corpus.

Parametersquery - Semantic search query
corpus - Document directory
ReturnsRelevant document chunks with similarity scores
Use CasesKnowledge retrieval, document Q&A, research assistance

Permission Levels Summary

Permission LevelEnabled Tools
Restrictiveread-file, find-files, search-files, web-search
BalancedRestrictive + write-file, git-operations, web-fetch, api-client
PermissiveAll tools including run-command