GenAIScript

--- title: Builtin Tools description: List of tools in system prompts --- import { LinkCard } from '@astrojs/starlight/components'; ### Builtin tools <LinkCard title="fetch" description="Fetch data from a URL from allowed domains." href="/genaiscript/reference/scripts/system#systemfetch" /> <LinkCard title="fs_ask_file" description="Runs a LLM query over the content of a file. Use this tool to extract information from a file." href="/genaiscript/reference/scripts/system#systemfs_ask_file" /> <LinkCard title="fs_data_query" description="Query data in a file using GROQ syntax" href="/genaiscript/reference/scripts/system#systemfs_data_query" /> <LinkCard title="fs_diff_files" description="Computes a diff between two different files. Use git diff instead to compare versions of a file." href="/genaiscript/reference/scripts/system#systemfs_diff_files" /> <LinkCard title="fs_find_files" description="Finds file matching a glob pattern. Use pattern to specify a regular expression to search for in the file content. Be careful about asking too many files." href="/genaiscript/reference/scripts/system#systemfs_find_files" /> <LinkCard title="fs_read_file" description="Reads a file as text from the file system. Returns undefined if the file does not exist." href="/genaiscript/reference/scripts/system#systemfs_read_file" /> <LinkCard title="git_branch_default" description="Gets the default branch using client." href="/genaiscript/reference/scripts/system#systemgit" /> <LinkCard title="git_branch_current" description="Gets the current branch using client." href="/genaiscript/reference/scripts/system#systemgit" /> <LinkCard title="git_branch_list" description="List all branches using client." href="/genaiscript/reference/scripts/system#systemgit" /> <LinkCard title="git_list_commits" description="Generates a history of commits using the git log command." href="/genaiscript/reference/scripts/system#systemgit" /> <LinkCard title="git_status" description="Generates a status of the repository using client." href="/genaiscript/reference/scripts/system#systemgit" /> <LinkCard title="git_last_tag" description="Gets the last tag using client." href="/genaiscript/reference/scripts/system#systemgit" /> <LinkCard title="git_diff" description="Computes file diffs using the git diff command. If the diff is too large, it returns the list of modified/added files." href="/genaiscript/reference/scripts/system#systemgit_diff" /> <LinkCard title="github_actions_workflows_list" description="List all github workflows." href="/genaiscript/reference/scripts/system#systemgithub_actions" /> <LinkCard title="github_actions_jobs_list" description="List all jobs for a github workflow run." href="/genaiscript/reference/scripts/system#systemgithub_actions" /> <LinkCard title="github_actions_job_logs_get" description="Download github workflow job log. If the log is too large, use 'github_actions_job_logs_diff' to compare logs." href="/genaiscript/reference/scripts/system#systemgithub_actions" /> <LinkCard title="github_actions_job_logs_diff" description="Diffs two github workflow job logs." href="/genaiscript/reference/scripts/system#systemgithub_actions" /> <LinkCard title="github_files_get" description="Get a file from a repository." href="/genaiscript/reference/scripts/system#systemgithub_files" /> <LinkCard title="github_files_list" description="List all files in a repository." href="/genaiscript/reference/scripts/system#systemgithub_files" /> <LinkCard title="github_issues_list" description="List all issues in a repository." href="/genaiscript/reference/scripts/system#systemgithub_issues" /> <LinkCard title="github_issues_get" description="Get a single issue by number." href="/genaiscript/reference/scripts/system#systemgithub_issues" /> <LinkCard title="github_issues_comments_list" description="Get comments for an issue." href="/genaiscript/reference/scripts/system#systemgithub_issues" /> <LinkCard title="github_pulls_list" description="List all pull requests in a repository." href="/genaiscript/reference/scripts/system#systemgithub_pulls" /> <LinkCard title="github_pulls_get" description="Get a single pull request by number." href="/genaiscript/reference/scripts/system#systemgithub_pulls" /> <LinkCard title="github_pulls_review_comments_list" description="Get review comments for a pull request." href="/genaiscript/reference/scripts/system#systemgithub_pulls" /> <LinkCard title="math_eval" description="Evaluates a math expression. Do NOT try to compute arithmetic operations yourself, use this tool." href="/genaiscript/reference/scripts/system#systemmath" /> <LinkCard title="md_find_files" description="Get the file structure of the documentation markdown/MDX files. Retursn filename, title, description for each match. Use pattern to specify a regular expression to search for in the file content." href="/genaiscript/reference/scripts/system#systemmd_find_files" /> <LinkCard title="md_read_frontmatter" description="Reads the frontmatter of a markdown or MDX file." href="/genaiscript/reference/scripts/system#systemmd_frontmatter" /> <LinkCard title="meta_prompt" description="Tool that applies OpenAI's meta prompt guidelines to a user prompt. Modified from https://platform.openai.com/docs/guides/prompt-generation?context=text-out." href="/genaiscript/reference/scripts/system#systemmeta_prompt" /> <LinkCard title="meta_schema" description="Generate a valid JSON schema for the described JSON. Source https://platform.openai.com/docs/guides/prompt-generation?context=structured-output-schema." href="/genaiscript/reference/scripts/system#systemmeta_schema" /> <LinkCard title="node_test" description="build and test current project using `npm test`" href="/genaiscript/reference/scripts/system#systemnode_test" /> <LinkCard title="python_code_interpreter_run" description="Executes python 3.12 code for Data Analysis tasks in a docker container. The process output is returned. Do not generate visualizations. The only packages available are numpy===2.1.3, pandas===2.2.3, scipy===1.14.1, matplotlib===3.9.2. There is NO network connectivity. Do not attempt to install other packages or make web requests. You must copy all the necessary files or pass all the data because the python code runs in a separate container." href="/genaiscript/reference/scripts/system#systempython_code_interpreter" /> <LinkCard title="python_code_interpreter_copy_files_to_container" description="Copy files from the workspace file system to the container file system. NO absolute paths. Returns the path of each file copied in the python container." href="/genaiscript/reference/scripts/system#systempython_code_interpreter" /> <LinkCard title="python_code_interpreter_read_file" description="Reads a file from the container file system. No absolute paths." href="/genaiscript/reference/scripts/system#systempython_code_interpreter" /> <LinkCard title="retrieval_fuzz_search" description="Search for keywords using the full text of files and a fuzzy distance." href="/genaiscript/reference/scripts/system#systemretrieval_fuzz_search" /> <LinkCard title="retrieval_vector_search" description="Search files using embeddings and similarity distance." href="/genaiscript/reference/scripts/system#systemretrieval_vector_search" /> <LinkCard title="retrieval_web_search" description="Search the web for a user query using Tavily or Bing Search." href="/genaiscript/reference/scripts/system#systemretrieval_web_search" /> <LinkCard title="think" description="Use the tool to think about something. It will not obtain new information or change the database, but just append the thought to the log. Use it when complex reasoning or some cache memory is needed." href="/genaiscript/reference/scripts/system#systemthink" /> <LinkCard title="transcribe" description="Generate a transcript from a audio/video file using a speech-to-text model." href="/genaiscript/reference/scripts/system#systemtranscribe" /> <LinkCard title="user_input_confirm" description="Ask the user to confirm a message." href="/genaiscript/reference/scripts/system#systemuser_input" /> <LinkCard title="user_input_select" description="Ask the user to select an option." href="/genaiscript/reference/scripts/system#systemuser_input" /> <LinkCard title="user_input_text" description="Ask the user to input text." href="/genaiscript/reference/scripts/system#systemuser_input" /> <LinkCard title="video_probe" description="Probe a video file and returns the metadata information" href="/genaiscript/reference/scripts/system#systemvideo" /> <LinkCard title="video_extract_audio" description="Extract audio from a video file into an audio file. Returns the audio filename." href="/genaiscript/reference/scripts/system#systemvideo" /> <LinkCard title="video_extract_clip" description="Extract a clip from from a video file. Returns the video filename." href="/genaiscript/reference/scripts/system#systemvideo" /> <LinkCard title="video_extract_frames" description="Extract frames from a video file" href="/genaiscript/reference/scripts/system#systemvideo" /> <LinkCard title="vision_ask_images" description="Use vision model to run a query on multiple images" href="/genaiscript/reference/scripts/system#systemvision_ask_images" /> <LinkCard title="z3" description="Solves a SMTLIB2 problem using the Z3 constraint solver. Send problems one at a time. Use this tool if you need to run Z3." href="/genaiscript/reference/scripts/system#systemz3" />