Reference
runtime
Discovery, health and administration of the runtime itself. Index · shared schemas · errors.
| Procedure | Summary | REST | MCP tool | Stability |
|---|---|---|---|---|
runtime.version | Identify the server and its contract range. The only unauthenticated read; it says nothing about devices. | GET | — | stable |
runtime.capabilities | Report contract features, enabled platforms and their capabilities, and limits | GET | — | stable |
runtime.status | Report daemon health: sessions, the device inventory, supervisors and restart counts, governor level, leaks | GET | — | stable |
runtime.hostInfo | Report the host: OS, arch, RAM and disk, GUI session, profile, resolved toolchain paths and versions, limits | GET | — | stable |
runtime.doctor | Run read-only environment checks (troupe doctor --json). Failures come back as results; they are not thrown. | GET | — | stable |
runtime.shutdown | Stop the daemon. With live sessions and no force it refuses with CONFLICT. | POST | — | stable |
runtime.sweep | Find leaked Troupe-owned devices and processes, and remove them when apply is set; anything not Troupe-owned is reported, never touched | POST | — | stable |
runtime.version
Identify the server and its contract range. The only unauthenticated read; it says nothing about devices.
| REST | GET /v1/runtime/version (input as query parameters) |
| RPC | /rpc/v2/runtime/version |
| MCP | not a tool (discovery and administration of the runtime); hints: read-only, idempotent |
| Auth | public: no credential; any credential sent is ignored |
| Tenancy | none |
| Troupe Cloud | answered by the control plane |
| Stability | stable, since 1.0 |
Input:
{}Output:
{
product: 'troupe'
kind: 'runtime' | 'cloud' | …
version: string
contract: ContractInfo
instanceId?: RuntimeInstanceId
}Errors: U.
Named types: ContractInfo, RuntimeInstanceId.
runtime.capabilities
Report contract features, enabled platforms and their capabilities, and limits
| REST | GET /v1/runtime/capabilities (input as query parameters) |
| RPC | /rpc/v2/runtime/capabilities |
| MCP | not a tool (discovery and administration of the runtime); hints: read-only, idempotent |
| Auth | session: any authenticated principal, no scope check |
| Tenancy | none |
| Troupe Cloud | answered by the control plane |
| Stability | stable, since 1.0 |
Input:
{}Output:
{
contract: ContractInfo
features: string[]
platforms: PlatformCapabilities[]
limits: { maxTimeoutMs: integer; mcpMaxTimeoutMs: integer }
}Errors: U.
Named types: ContractInfo, PlatformCapabilities.
runtime.status
Report daemon health: sessions, the device inventory, supervisors and restart counts, governor level, leaks
| REST | GET /v1/runtime/status (input as query parameters) |
| RPC | /rpc/v2/runtime/status |
| MCP | not a tool (discovery and administration of the runtime); hints: read-only, idempotent |
| Auth | runtime:read |
| Tenancy | none |
| Troupe Cloud | not served; local runtime only |
| Stability | stable, since 1.0 |
Input:
{}Output:
RuntimeStatusErrors: U.
Named types: RuntimeStatus.
runtime.hostInfo
Report the host: OS, arch, RAM and disk, GUI session, profile, resolved toolchain paths and versions, limits
| REST | GET /v1/runtime/host-info (input as query parameters) |
| RPC | /rpc/v2/runtime/hostInfo |
| MCP | not a tool (discovery and administration of the runtime); hints: read-only, idempotent |
| Auth | runtime:read |
| Tenancy | none |
| Troupe Cloud | not served; local runtime only |
| Stability | stable, since 1.0 |
Input:
{}Output:
HostInfoErrors: U.
Named types: HostInfo.
runtime.doctor
Run read-only environment checks (troupe doctor --json). Failures come back as results; they are not thrown.
| REST | GET /v1/runtime/doctor (input as query parameters) |
| RPC | /rpc/v2/runtime/doctor |
| MCP | not a tool (discovery and administration of the runtime); hints: read-only, idempotent |
| Auth | runtime:read |
| Tenancy | none |
| Troupe Cloud | not served; local runtime only |
| Stability | stable, since 1.0 |
Input:
{
platforms?: PlatformId[] // ≤ 16 items
}Output:
{ ok: boolean; checks: DoctorCheck[] }Errors: U.
Named types: DoctorCheck, PlatformId.
runtime.shutdown
Stop the daemon. With live sessions and no force it refuses with CONFLICT.
| REST | POST /v1/runtime/shutdown (input as a JSON body) |
| RPC | /rpc/v2/runtime/shutdown |
| MCP | not a tool (discovery and administration of the runtime); hints: destructive |
| Auth | runtime:admin |
| Tenancy | none |
| Troupe Cloud | not served; local runtime only |
| Stability | stable, since 1.0 |
Input:
{
force?: boolean // default false
}Output:
{
endedSessions: integer // ≥ 0
}runtime.sweep
Find leaked Troupe-owned devices and processes, and remove them when apply is set; anything not Troupe-owned is reported, never touched
| REST | POST /v1/runtime/sweep (input as a JSON body) |
| RPC | /rpc/v2/runtime/sweep |
| MCP | not a tool (discovery and administration of the runtime); hints: destructive |
| Auth | runtime:admin |
| Tenancy | none |
| Troupe Cloud | not served; local runtime only |
| Stability | stable, since 1.0 |
Input:
{
apply?: boolean // default false
}Output:
{
found: LeakItem[]
removed: integer // ≥ 0
}Errors: U.
Named types: LeakItem.