Builtin Tools

Ailoy provides several builtin tools that can be used out-of-the-box without having to define tool descriptions or functions.

See Tutorials > Using Tools > Using Builtin Tools for how to use builtin tools in detail.

terminal

Executes a command on the current system using the default shell. (bash for UNIX-based OS and powershell for Windows).

info

This tool is not available on web environments.

Arguments

Name	Type	Description	Required
command	string	The command to execute.	✅
cwd	string	Optional working directory.
env	object	Optional environment variables as key-value pairs.
stdin	string	Optional string to send to STDIN.

Returns

Name	Type	Description
stdout	string	stdout of the executed command.
stderr	string	stderr of the executed command.
exit_code	number	Exit code of the executed command.

web_search_duckduckgo

Search webpages using DuckDuckGo and return formatted results.

info

This tool may not work in web environments due to CORS restrictions. To avoid this issue, configure your requests to pass through a proxy server that forwards the call to the original DuckDuckGo endpoint. See the example proxy server implementation in our test codes.

Configuration

Name	Type	Description	Default
base_url	string	Base URL to send the request	https://html.duckduckgo.com/html
requests_per_minute	number	Maximum number of requests per minute	60

Arguments

Name	Type	Description	Required
query	string	The search query string	✅
max_results	number	Maximum number of results to return (default: 10)

Returns

Name	Type	Description
results	string	Formatted results in a single string

web_fetch

Fetch and parse content from a webpage URL.

info

Most of the public webpages may not be accessible directly from web environments due to CORS restrictions. To avoid this issue, configure your requests to pass through a proxy server that forwards the call to the original URL provided via url query parameter. See the example proxy server implementation in our test codes.

Configuration

Name	Type	Description	Default
proxy_url	string	Proxy URL to send the request. The proxy server should proxy the requests to original url in query parameter.	None
requests_per_minute	number	Maximum number of requests per minute	60

Arguments

Name	Type	Description	Required
url	string	The webpage URL to fetch content from	✅

Returns

Name	Type	Description
results	string	Parsed web contents