diff options
| author | cperry-goog <[email protected]> | 2025-06-07 10:47:30 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-06-07 10:47:30 -0700 |
| commit | 63757d6a7ae6dcff47e912578903ed4040b2b82f (patch) | |
| tree | 243f231880d3456ae0c055a9deccf3c23a84c113 /docs/tools/web.md | |
| parent | dcaecde844fd21d101bbb76c41163919373543d2 (diff) | |
docs: update and reorganize documentation (#806)
Diffstat (limited to 'docs/tools/web.md')
| -rw-r--r-- | docs/tools/web.md | 26 |
1 files changed, 0 insertions, 26 deletions
diff --git a/docs/tools/web.md b/docs/tools/web.md deleted file mode 100644 index 5832fab4..00000000 --- a/docs/tools/web.md +++ /dev/null @@ -1,26 +0,0 @@ -# Web Fetch Tool - -This document describes the `web_fetch` tool. - -## `web_fetch` - -- **Purpose:** Fetches text content from a given URL. This is useful for retrieving data from web pages, APIs, or other online resources. -- **Arguments:** - - `url` (string, required): The absolute URL to fetch (e.g., `https://example.com/data.txt`). -- **Behavior:** - - The tool attempts to retrieve the content from the specified URL. - - It handles potential network errors (e.g., DNS resolution failure, connection timeout) and non-success HTTP status codes (e.g., 404 Not Found, 500 Internal Server Error). - - The returned content is expected to be text-based. For binary files, the behavior might be undefined or result in garbled text. -- **Examples:** - - Fetching a plain text file: - ``` - web_fetch(url="https://example.com/robots.txt") - ``` - - Retrieving data from a simple API endpoint: - ``` - web_fetch(url="https://api.example.com/items/123") - ``` -- **Important Notes:** - - **Content Type:** This tool is primarily designed for text-based content. It may not be suitable for fetching binary files like images or executables. - - **Error Handling:** Always check the tool's output for error messages or status indicators to ensure the fetch was successful and the content is as expected. - - **Rate Limiting/Authentication:** Be mindful of website terms of service, rate limits, and authentication requirements. This tool does not inherently handle complex authentication mechanisms. |
