• AI reference · Always listed

read

Read a file. Read a folder file, list a folder or search it (one of path, list or search). version: an older one. A long answer comes in parts: call again with offset: next_offset.

Where it is

Always listed: call it by its name.

Does it need a yes?

Reads only: it changes nothing. Here: a folder file.

Inputs

InputTypeNeededAbout
pathstringnoA file path, e.g. AGENTS.md. · 1 to 200 characters
liststringnoA folder, e.g. skills/ (empty: everything). · up to 200 characters
searchstringnoWords to search the folder for. · 1 to 300 characters
offsetintegernoWith path or list: the next_offset you got. · 0 or more
versioninteger or stringnoWith path: an older version from its history. To restore it, write its body with base_version = the current_version you get.
run_idstringnoThe run_id from start. Pass it on every call: it keeps your task held. · 1 to 100 characters

Example

{
  "name": "read",
  "arguments": {}
}

When it is refused

  • invalid: The input isn't right. The sentence names the field and the fix; nothing was done. Fix it and call again.
  • not_found: No such thing in this company (a task, file, person, record). Check the number or name, or list first.
  • not_allowed: Not without another step: the owner's yes, your own task held with pick_up, or a setting the owner turns on. The sentence says which.
  • taken: Someone else holds it (another AI on that task). Pick another task.
  • stale: It changed since you read it. Read it again and use the new version.
  • failed: On our side or a service's, never your input. Try again in a minute; if it keeps failing, call report_problem.