---
title: Web
description: Search the open web and read pages. 2 tools.
group: web
tools: [web.search, web.read]
source: [packages/agents/src/tools/web.ts]
generated: true
---

> Roadstar docs for agents. Every page, as markdown: https://docs.roadstar.app/llms.txt

The open web, for what the business's own records don't hold: a new client's site, a supplier's prices, a council's opening hours. Say which page each fact came from.

`search` takes an objective in a sentence and up to four short queries. `read` returns the text of up to five pages, or with an objective only the passages that bear on it.

## How to use it

What `find_tools` sends with these tools, word for word:

> The open web. Results carry their links: say which page a fact came from.

## Tools

| Tool | What it does | Owner's yes |
| --- | --- | --- |
| [web.search](#search) | Pages that answer the objective, each with its link and the passages that matter | No |
| [web.read](#read) | The text of up to 5 pages; with an objective, only the passages that bear on it | No |

## search

`web.search` · Pages that answer the objective, each with its link and the passages that matter.

**Owner's yes:** No. Nothing of the owner's changes.

| Input | Type | Required | Limits |
| --- | --- | --- | --- |
| `objective` | text | yes | 1–500 characters |
| `queries` | list of text | yes | 1–4 items, each 1–120 characters |
| `limit` | whole number | no | 1–10 |

Returns:

```ts
{
  results: {
    title: string | null;
    url: string;
    published: string | null;
    excerpts: string[];
  }[];
}
```

## read

`web.read` · The text of up to 5 pages; with an objective, only the passages that bear on it.

**Owner's yes:** No. Nothing of the owner's changes.

| Input | Type | Required | Limits |
| --- | --- | --- | --- |
| `urls` | list of link | yes | 1–5 items |
| `objective` | text | no | 1–500 characters |

Returns:

```ts
{
  pages: {
    title: string | null;
    url: string;
    text: string;
  }[];
  failed: {
    url: string;
    error: string;
  }[];
}
```
