Skip to main contentCrate computer_protocol
Source pub use act::ActReply;pub use act::ActRequest;pub use act::Action;pub use act::ActionError;pub use act::Button;pub use act::Direction;pub use act::Kind;pub use act::Point;pub use act::RawAction;
- act
- The
computer_act batch: what an agent sends, and the typed actions computerd runs.
- ApiError
- Body of every error reply from
computerd. - CreateSession
- Body of
POST /sessions. - Cursor
- Pointer position on the screen, in pixels.
- DownloadRequest
- Body of
POST /sessions/{id}/files/download. The reply body is a tar archive. - FileEntry
- One entry of a folder.
- Health
- LaunchAppRequest
- Body of
POST /sessions/{id}/launch. - ListFilesReply
- Reply to
POST /sessions/{id}/files/list. - ListFilesRequest
- Body of
POST /sessions/{id}/files/list. - Observation
- Reply to
POST /sessions/{id}/observe. - OpenPathRequest
- Body of
POST /sessions/{id}/open. - OwnerId
- Identifies one MCP server process: 32 lowercase hex digits, random per process.
- OwnerIdError
- The text is not an owner id.
- ReadFileRequest
- Body of
POST /sessions/{id}/files/read. - ScreenSize
- Screen size in pixels. Sides range from
MIN_SCREEN_SIDE to MAX_SCREEN_SIDE. - ScreenSizeError
- Why a screen size was refused.
- SessionCreated
- Reply to
POST /sessions. - SessionId
- The id
computerd issues for a session: 32 lowercase hex digits. - SessionIdError
- The text is not a session id.
- SessionTitle
- Short description of the task a session works on, 1 to 80 characters.
- SetCwdReply
- Reply to
POST /sessions/{id}/cwd. - SetCwdRequest
- Body of
POST /sessions/{id}/cwd. - ShellReply
- Reply to
POST /sessions/{id}/shell. - ShellRequest
- Body of
POST /sessions/{id}/shell. - ShellTimeouts
- How long a shell command may run, fixed when the session is created.
- SkipList
- The first skipped entries and how many more there were.
- Skipped
- One entry a transfer left out, and why.
- TransferReply
- What a finished transfer put in place.
- UploadCheck
- Body of
POST /sessions/{id}/files/upload-check, sent before the data so a refusal arrives at once. - UploadQuery
- Query of
POST /sessions/{id}/files/upload. The body is a tar archive. - ViewerInfo
- What the host needs to know about the viewer.
- WriteFileReply
- Reply to
POST /sessions/{id}/files/write. - WriteFileRequest
- Body of
POST /sessions/{id}/files/write.
- FileKind
- What a folder entry is.
- ImageType
- Image formats
read_file returns as images. - ReadFileReply
- Reply to
POST /sessions/{id}/files/read. - ShellOutcome
- How a shell command ended.
- ShellTimeoutsError
- Why a pair of shell timeouts was refused.
- TitleError
- Why a session title was refused.
- API_PORT
- Port
computerd listens on inside the container. - DEFAULT_IDLE_SECS
- Seconds without agent calls after which a session ends, unless the host sets another time.
- DEFAULT_PORT_BASE
- Host port the viewer page is published on unless the user picks another base.
- DEFAULT_SHELL_TIMEOUT_MAX_SECS
- Longest shell timeout used when
COMPUTER_USE_SHELL_TIMEOUT_MAX is not set, in seconds. - DEFAULT_SHELL_TIMEOUT_SECS
- Shell timeout used when
COMPUTER_USE_SHELL_TIMEOUT is not set, in seconds. - HEARTBEAT_INTERVAL_SECS
- Seconds between the heartbeats an MCP server sends for its sessions.
- HOST_PORT_BASE_ENV
- Environment variable that tells
computerd which host port its viewer port is published on. - LONGEST_SHELL_TIMEOUT_SECS
- Largest accepted shell timeout setting, in seconds.
- MAX_IMAGE_BYTES
- Largest image
read_file returns, in bytes. - MAX_LISTED_SKIPS
- Skipped entries a reply or an archive lists before it only counts the rest.
- MAX_SCREEN_SIDE
- Largest accepted screen side, in pixels.
- MAX_TITLE_CHARS
- Longest accepted session title, in characters.
- MAX_WRITE_BYTES
- Largest
write_file content, in bytes. - MIN_SCREEN_SIDE
- Smallest accepted screen side, in pixels.
- OWNER_ID_LEN
- Length of an owner id, in hex digits.
- OWNER_TIMEOUT_SECS
- Seconds without a heartbeat after which the sessions of an owner end.
- PROTOCOL_VERSION
- Version of the wire format between the host and
computerd. - RELEASE_VERSION
- SCREEN_COUNT
- Number of screens the computer has.
- SESSION_ID_LEN
- Length of a session id, in hex digits.
- SKIP_REPORT_ENTRY
- Name of the last archive entry, which carries the sender’s
SkipList as JSON. - TOKEN_ENV
- Environment variable that carries the API token into the container.
- VERSION
- VIEWER_PORT
- Port of the viewer page and its WebSocket bridge inside the container.
- viewer_link
- Link that opens the viewer page when the host publishes it on
host_port. - viewer_screen_link
- Link that opens the viewer page focused on
screen. - vnc_password_file
- Contents of a VNC password file for
key, as Xvnc and vncviewer -passwd read it. - vnc_port
- Port inside the container where raw VNC for
screen (1 to SCREEN_COUNT) is served.