← All MCP tools

Report runner heartbeat

runner_heartbeat
Write

What it does

For a self-hosted runner box only. Registers this box against the account and reports its health, so the human can see their runner in Done rather than by reading logs over SSH. Call it on connect, on the interval this returns, and once after every run with that run's outcome. Report run.status 'auth_failed' when the model credential is rejected — a box whose subscription login expired still holds its stream open, so that is the one failure Done cannot otherwise see.

Parameters

NameTypeRequiredDescription
namestringRequired

Stable name for this box. Same name = same box across restarts.

providerstringRequired

Which CLI this box runs.

Allowed valuesclaudecodex
versionstringOptional

Daemon version, for support.

claimedbooleanOptional

For a Done-provisioned box: true once a model credential exists on this machine. Done cannot see this for itself, so the box reports it.

runobjectOptional

The outcome of the run that just finished. Omit on a plain check-in — omitting it leaves the previous outcome standing rather than clearing it.

run.statusstringRequired
Allowed valuesokfailedauth_failedtimeout
run.errorstringOptional

Short failure detail. Redact credentials before sending.

Annotations

The hints the server sends with this tool. A host reads them to decide whether to ask you before a call.

Read-onlyreadOnlyHint: false
Changes data in your Done account.
DestructivedestructiveHint: false
Only adds or reads; nothing already there is removed or overwritten.
IdempotentidempotentHint: false
Each call can add something new, such as a comment, a run or a task.
Open worldopenWorldHint: false
Touches only your own Done account.

Which tokens can call it

A connection made with OAuth has full access. A token from Settings → Agent access → Extra MCP tokens can be narrowed, and a narrowed token never sees beyond its project or workspace.

  • Full accessAllowed
  • Read-only tokenRefused
  • Single-project tokenAllowed
  • Single-workspace tokenAllowed

Try it

With Done connected, ask your assistant something like:

“Report this runner's health to Done after every run.”

Connect Done to your assistant

One MCP endpoint per account, over OAuth or a token. Step-by-step setup for each client:

MCP setup overview →