From 59e8fcb4096b2f4f3841150035aa995aaebc0e97 Mon Sep 17 00:00:00 2001 From: cperry-goog <78765543+cperry-goog@users.noreply.github.com> Date: Thu, 15 May 2025 20:43:01 -0700 Subject: Docs: Fix broken links and update documentation (#377) --- docs/tools/index.md | 21 ++++++--------------- docs/tools/shell.md | 2 +- 2 files changed, 7 insertions(+), 16 deletions(-) (limited to 'docs/tools') diff --git a/docs/tools/index.md b/docs/tools/index.md index f10477bd..2f35c99a 100644 --- a/docs/tools/index.md +++ b/docs/tools/index.md @@ -28,15 +28,6 @@ The server component (`packages/server`) manages these tools, presents their def You will typically see messages in the CLI indicating when a tool is being called and whether it succeeded or failed. -## Categories of Built-in Tools - -The built-in tools can be broadly categorized as follows: - -- **[File System Tools](./file-system.md):** For interacting with files and directories (reading, writing, listing, searching, etc.). -- **[Shell Tool](./shell.md):** For executing shell commands. -- **[Web Fetch Tool](./web.md):** For retrieving content from URLs. -- **[Multi-File Read Tool](./multi-file.md):** A specialized tool for reading content from multiple files or directories, often used by the `@` command. - ## Security and Confirmation Many tools, especially those that can modify your file system or execute commands (`write_file`, `edit`, `execute_bash_command`), are designed with safety in mind. The Gemini CLI will typically: @@ -46,13 +37,13 @@ Many tools, especially those that can modify your file system or execute command It's important to always review confirmation prompts carefully before allowing a tool to proceed. -## Detailed Tool Documentation +## Categories of Built-in Tools -For detailed information on each specific tool, including its parameters and behavior, please refer to the individual pages in this section: +The built-in tools can be broadly categorized as follows: -- **[File System Tools](./file-system.md)** -- **[Shell Tool (execute_bash_command)](./shell.md)** -- **[Web Fetch Tool](./web.md)** -- **[Multi-File Read Tool](./multi-file.md)** +- **[File System Tools](./file-system.md):** For interacting with files and directories (reading, writing, listing, searching, etc.). +- **[Shell Tool](./shell.md):** For executing shell commands. +- **[Web Fetch Tool](./web.md):** For retrieving content from URLs. +- **[Multi-File Read Tool](./multi-file.md):** A specialized tool for reading content from multiple files or directories, often used by the `@` command. Understanding the available tools and how they work will help you make the most effective use of the Gemini CLI. diff --git a/docs/tools/shell.md b/docs/tools/shell.md index 6715cfa9..5b8e8c9d 100644 --- a/docs/tools/shell.md +++ b/docs/tools/shell.md @@ -1,6 +1,6 @@ # Shell Tool -This document provides details on the shell tool available. +This document provides details on the shell tool. ## `execute_bash_command` -- cgit v1.2.3