summaryrefslogtreecommitdiff
path: root/docs/tools/web-search.md
diff options
context:
space:
mode:
authorJenna Inouye <[email protected]>2025-06-24 15:31:58 -0700
committerGitHub <[email protected]>2025-06-24 22:31:58 +0000
commit4bf18da2b08e145d2f4c91f2331347bf8568aed3 (patch)
tree4833d2232d19943171f64e27ace895b9fbf5cf27 /docs/tools/web-search.md
parent8bd5645dd487574763325fb44e15feb97771607c (diff)
Documents: Add docs tools pages (#1397)
Diffstat (limited to 'docs/tools/web-search.md')
-rw-r--r--docs/tools/web-search.md48
1 files changed, 32 insertions, 16 deletions
diff --git a/docs/tools/web-search.md b/docs/tools/web-search.md
index da2e3315..c0f7c8db 100644
--- a/docs/tools/web-search.md
+++ b/docs/tools/web-search.md
@@ -1,20 +1,36 @@
-# Google Web Search Tool
+# Web Search Tool (`google_web_search`)
This document describes the `google_web_search` tool.
-## `google_web_search`
+## Description
-- **Purpose:** Performs a web search using Google Search (via the Gemini API) and returns a summary of the results with sources. This tool is useful for finding up-to-date information on the internet.
-- **Arguments:**
- - `query` (string, required): The search query.
-- **Behavior:**
- - The tool sends the query to the Gemini API, which performs a Google Search.
- - It returns a generated response based on the search results, complete with citations and a list of sources.
-- **Examples:**
- - Getting information on a topic:
- ```
- google_web_search(query="latest advancements in AI-powered code generation")
- ```
-- **Important Notes:**
- - The tool returns a processed summary, not a raw list of search results.
- - The response includes citations to the sources used to generate the summary.
+Use `google_web_search` to perform a web search using Google Search via the Gemini API. The `google_web_search` tool returns a summary of web results with sources.
+
+### Arguments
+
+`google_web_search` takes one argument:
+
+- `query` (string, required): The search query.
+
+## How to use `google_web_search` with the Gemini CLI
+
+The `google_web_search` tool sends a query to the Gemini API, which then perform a web search. `google_web_search` will return a generated response based on the search results, including citations and sources.
+
+Usage:
+
+```
+google_web_search(query="Your query goes here.")
+```
+
+## `google_web_search` examples
+
+Get information on a topic:
+
+```
+google_web_search(query="latest advancements in AI-powered code generation")
+```
+
+## Important notes
+
+- **Response returned:** The `google_web_search` tool returns a processed summary, not a raw list of search results.
+- **Citations:** The response includes citations to the sources used to generate the summary.