Skip to main content
Every client reaches one core, the Workspace. An app calls it directly. The mirage CLI, MCP clients and RPC clients reach the server's HTTP routes. SSH clients reach its SSH server. Both servers call the Workspace.Every client reaches one core, the Workspace. An app calls it directly. The mirage CLI, MCP clients and RPC clients reach the server's HTTP routes. SSH clients reach its SSH server. Both servers call the Workspace.
HTTP, MCP, RPC, CLI and SSH connections go through the Mirage server, a FastAPI app in Python and a Fastify app in TypeScript that speak the same protocol. It serves HTTP, and SSH on its own port when ssh_port is set or over HTTP through mirage ssh-proxy. The CLI starts the server on your machine when it needs one. In-app access reaches the workspace directly.

What each one exposes

Each way in exposes what its own protocol defines. A dash means the protocol has no such operation.

Sessions

A session is one shell inside a workspace. It keeps its own working directory, environment variables and history, and runs under one session profile. Agents in different sessions share the workspace’s files but not their shell state. A call that specifies no session runs in the workspace’s default session. Its profile is the one the config’s profile: names, else the one called default, else none.

Cancel

To stop a whole session, whichever way its lines came in:

Auth

When authentication is configured, every way in proves who is calling. GET /v1/health and OAuth discovery stay public. A server you start directly in local mode, with no token configured, accepts requests without one. In jwt mode a token’s sub is an account that reaches only its own workspaces, and an SSH key names its account with mirage-account. See Auth.