Reading this documentation as a tool

This page is for your AI tool. It explains how a tool signed in to Turn Zero Cloud reads these pages in parts, with the read_documentation action. Machine surfaces of this documentation lists the files a tool reads without a connection.

What the action reads

With tree set to cloud, read_documentation reads the index, one line per page. With part set to outline, it returns every page with its headings. It returns one page by its route with page, one section of that page with section, and the sections that match a few words with query. A query needs no tree: without one, it searches every documentation tree your account can read.

Long texts come in chunks

A long text comes back in chunks of about limit characters, 8,000 unless you set it. A chunk ends at the end of a line where the line fits, and never inside a code block that fits in one chunk.

A JSON text from read_context, such as the manifest schema, follows one more rule, and so does a .json file from read_library_entry. The rule covers such a text written one member to a line. In it, a chunk never ends inside a member that is shorter than half the limit and sits at the top level or one level below it.

To read on, pass each response's next_offset and stamp. Or, after the first response, ask with its stamp for every multiple of the limit at once. Each response's offset says where its text starts, which can be a little before the offset you asked for. Those chunks join in order with nothing missing or repeated.

Going straight to a section

The first chunk of a long page also says where to look instead of reading on. It lists the page's headings in headings, each with an offset. To go straight to a section, read the page again with that offset and the first chunk's stamp. The answer then starts at that heading. Or read one section alone, with section set to its heading.

A page with more than 40 headings lists only its second-level ones; use query or section to reach a deeper one. The list contains at most 200 headings, and a heading longer than 200 characters is cut to 200. When either limit cuts the list, the continuation says the list is cut short.

Searching

A query of a few distinctive words, such as a command's name, returns the matching sections. Each is one line with its page's title, its heading, a link to it, and its best matching line. A link with a heading's anchor, passed as page, reads that section. With page set too, a query returns that page's lines holding the words, each with its offset. Those offsets read on with the same stamp.