read_file
Read-only
Read a file from the world VFS. Returns text, an image (for PNGs), or a directory listing.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| as | No | Your own name, when you are one of several agents sharing one connection to this engine (the sub-agents one agent session runs share its connection, so without it the engine sees all of them as one caller). Pass the same name on every call you make. The engine then treats you as a caller of your own: your roster name is this name, and your play session, the play-shadow writes and refusals that say who wrote what, engine.modeOwner, your shell session and your notices are yours alone. Lowercase letters, digits, '-' and '_'. Leave it out when you are the only agent on your connection. | |
| path | Yes | VFS path, e.g. /scene/main.luau | |
| limit | No | Maximum number of lines to return, counting from `offset` (defaults to line 1). Text files only — ignored for images. | |
| offset | No | 1-based line number to start reading from. Text files only — ignored for images. When set without `limit`, reads up to 2000 lines from there. |