komrad

run_doctor

Check whether the machine the server runs on can run agents.

read-onlyidempotentMCP toolDoctor

The checks cover tmux, the config, the CLIs, hooks, worktree directories and the database.

Calling it#

curl -X POST http://127.0.0.1:8787/komrad.doctor.v1.DoctorService/RunDoctor \
  -H 'Content-Type: application/json' \
  -d '{}'

Request#

Empty#

No fields.

Response#

RunDoctorResponse#

FieldTypeDescription
findingsFinding[]

Every check, in the order it ran.

summarySummary

The findings counted by status.

Types#

Finding#

Finding is the result of one doctor check.

FieldTypeDescription
namestring

The check's name, such as database or tmux version.

descriptionstring

What the check is for, in one sentence.

statusStatus

How the check came out.

detailstring

What the check found, such as a version or a path. Empty when there is nothing to report.

codestring

A stable code for the problem, such as db_unreachable. Empty when nothing went wrong.

errorstring

The problem, as the check worded it. Empty when nothing went wrong.

fixstring

What to do about the problem. Empty when there is nothing to do.

Summary#

Summary counts the findings of a doctor run by status.

FieldTypeDescription
okint32

How many checks passed.

warnint32

How many checks passed with a warning.

failint32

How many checks failed.

skipint32

How many checks were skipped because a check they need did not pass.

totalint32

How many checks there are in all.

healthybool

Whether no check failed.

Status#

Status is how a doctor check came out.

ValueDescription
ok

The check passed.

warn

The check passed with a warning.

fail

The check failed.

skip

The check was skipped because a check it needs did not pass.