Reference
runs
Test-run reports a runner publishes and clients follow. Index · shared schemas · errors.
| Procedure | Summary | REST | MCP tool | Stability |
|---|---|---|---|---|
runs.publish | A test runner publishes reporter events, so the studio and other clients can follow the run. seq MUST be contiguous. | POST | — | experimental |
runs.list | List recent runs (locally: the last 50, or 24 h) | GET | — | experimental |
runs.get | Read one run with its per-test results | GET | — | experimental |
runs.events | Replay a run's reporter events from since, then follow it live | GET | — | experimental |
runs.publish
A test runner publishes reporter events, so the studio and other clients can follow the run. seq MUST be contiguous.
| REST | POST /v1/runs/publish (input as a JSON body) |
| RPC | /rpc/v2/runs/publish |
| MCP | not a tool (runner and inspector plumbing); hints: none |
| Auth | runs:report |
| Tenancy | project |
| Troupe Cloud | answered by the control plane |
| Stability | experimental, since 1.0 |
Input:
{
runId: RunId
events: ReporterEnvelope[] // 1–500 items
}Output:
{ acceptedThrough: Seq }Named types: ReporterEnvelope, RunId, Seq.
runs.list
List recent runs (locally: the last 50, or 24 h)
| REST | GET /v1/runs/list (input as query parameters) |
| RPC | /rpc/v2/runs/list |
| MCP | not a tool (runner and inspector plumbing); hints: read-only, idempotent |
| Auth | runs:read |
| Tenancy | project |
| Troupe Cloud | answered by the control plane |
| Stability | experimental, since 1.0 |
Input:
{
status?: RunStatus
limit?: integer // default 50; 1–100
cursor?: Cursor
}Output:
{ runs: RunSummary[]; nextCursor?: string }Errors: U.
Named types: Cursor, RunStatus, RunSummary.
runs.get
Read one run with its per-test results
| REST | GET /v1/runs/get (input as query parameters) |
| RPC | /rpc/v2/runs/get |
| MCP | not a tool (runner and inspector plumbing); hints: read-only, idempotent |
| Auth | runs:read |
| Tenancy | project |
| Troupe Cloud | answered by the control plane |
| Stability | experimental, since 1.0 |
Input:
{ runId: RunId }Output:
RunDetailNamed types: RunDetail, RunId.
runs.events
Replay a run's reporter events from since, then follow it live
| REST | GET /v1/runs/events (input as query parameters) |
| RPC | /rpc/v2/runs/events |
| MCP | not a tool (an event iterator; MCP tools return one result); hints: read-only, idempotent |
| Auth | runs:read |
| Tenancy | project |
| Troupe Cloud | answered by the control plane |
| Stability | experimental, since 1.0 |
Input:
{ runId: RunId; since?: Seq }Output: an event iterator (text/event-stream on REST), each event:
ReporterEnvelopeOutNamed types: ReporterEnvelopeOut, RunId, Seq.