---
title: Help
description: These docs, from inside Roadstar. 2 tools.
group: help
tools: [help.search, help.read]
source: [packages/agents/src/tools/help.ts]
generated: true
---

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

These docs, read from the docs site in the same environment. Use them when you aren't sure how something works: what a tool returns, why the check held an action back, how a routine fires.

- `search` finds pages and parts of pages with the most of your words. Search with words you'd expect on the page, such as a tool's name: `mail.send`, `when.ask`, `not_done_yet`.
- `read` returns a page as markdown, by its address. Add `#part` to get only that part, such as `/tools/mail/#send`.

Outside Roadstar, an agent starts from [/llms.txt](/llms.txt), and every page is at its address with `.md` added.

## How to use it

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

> Roadstar's docs, as markdown: how agents, threads, hand-offs, routines and the owner's yes work, every tool with its input, result and limits, and worked examples. Search with the words you'd expect on the page, such as a tool's name; then read the page, or just the part you need.

## Tools

| Tool | What it does | Owner's yes |
| --- | --- | --- |
| [help.search](#search) | The pages and parts of pages with the most of these words, best first, each with its address and opening lines | No |
| [help.read](#read) | One page as markdown, by its address from search or a link, such as "/tools/mail/"; with #part, only that part, such as "/tools/mail/#send" | No |

## search

`help.search` · The pages and parts of pages with the most of these words, best first, each with its address and opening lines.

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

| Input | Type | Required | Limits |
| --- | --- | --- | --- |
| `query` | text | yes | 1–200 characters |
| `limit` | whole number | no | 1–20 |

Returns:

```ts
{
  total: number;
  results: {
    page: string;
    title: string;
    opens: string;
  }[];
}
```

## read

`help.read` · One page as markdown, by its address from search or a link, such as "/tools/mail/"; with #part, only that part, such as "/tools/mail/#send".

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

| Input | Type | Required | Limits |
| --- | --- | --- | --- |
| `page` | text | yes | 1–300 characters |

Returns:

```ts
{
  page: string;
  title: string;
  text: string;
}
```