Read tool description
SDK-CLI Agent SDK, print mode, v2.1.296. The text the model is given for this tool, line by line, with each line marked against the previous capture taken the same way. One model string produces this prompt.
As described in the slash command: /team-onboarding request, not the ordinary one.
Lines9790 characters
Moved+0−0 against v2.1.295
Sent to1model strings get this description
Copies1distinct descriptions under this name
Parameters51 of them required
Every tool→every description on this arm
Plain text · sha256 80fb15d2d15c
The description, line by line
9 lines Line numbers are v2.1.295 on the left and this capture on the right.
1
1
Reads a file from the local filesystem.
2
2
3
3
- `file_path` must be an absolute path.
4
4
- Reads up to 2000 lines by default.
5
5
- When you already know which part of the file you need, only read that part. This can be important for larger files.
6
6
- Results are returned using cat -n format, with line numbers starting at 1
7
7
- Reads images (PNG, JPG, …) and presents them visually. Reads PDFs via the `pages` parameter (e.g. "1-5", max 20 pages/request; required for PDFs over 10 pages). Reads Jupyter notebooks (.ipynb) as cells with outputs.
8
8
- Reading a directory, a missing file, or an empty file returns an error or system reminder rather than content.
9
9
- Do NOT re-read a file you just edited to verify — Edit/Write would have errored if the change failed, and the harness tracks file state for you.
What it accepts
5 parameters The JSON parameter schema sent beside this description, 1,199 characters of it. Name, type, then whether the client marked it required.allow_large
boolean
optional
Set to true to read a text file, or a line range of one, that is over the usual size limits, up to what still fits in your context. Only use this when you genuinely need all of it or the user asked for the whole file; otherwise read it in parts with offset and limit, or search it.
file_path
string
required
The absolute path to the file to read
limit
integer
optional
The number of lines to read. Only provide if the file is too large to read at once.
offset
integer
optional
The line number to start reading from. Only provide if the file is too large to read at once
pages
string
optional
Page range for PDF files (e.g., "1-5", "3", "10-20"). Only applicable to PDF files. Maximum 20 pages per request.
sha256 41cbc4151aa4 · the schema as the client sent it:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"allow_large": {
"description": "Set to true to read a text file, or a line range of one, that is over the usual size limits, up to what still fits in your context. Only use this when you genuinely need all of it or the user asked for the whole file; otherwise read it in parts with offset and limit, or search it.",
"type": "boolean"
},
"file_path": {
"description": "The absolute path to the file to read",
"type": "string"
},
"limit": {
"description": "The number of lines to read. Only provide if the file is too large to read at once.",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"offset": {
"description": "The line number to start reading from. Only provide if the file is too large to read at once",
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"pages": {
"description": "Page range for PDF files (e.g., \"1-5\", \"3\", \"10-20\"). Only applicable to PDF files. Maximum 20 pages per request.",
"type": "string"
}
},
"required": [
"file_path"
],
"type": "object"
}