Skip to content
SHAMPOO

Tool catalogue

107 documented tools.

Derived from the canonical SHAMPOO tool documentation (the same source the implementation is gated against), so these pages and the software cannot drift apart.

3 tools

Diagnostics

Status and health checks for a session and the service.

doctor

Read · Ordinary

SHAMPOO-wide health diagnostics in nine grouped sections with typed checks. Call it to distinguish ok, warn, fail, and unknown before investigating or repairing.

Full documentation →

Arguments, result and boundaries
Arguments
Optional: `detail`, `sections`. - `detail`: summary | full. Note: summary omits per-check detail text; full includes it. - `sections`: CSV section filter; empty runs all. Note: CSV filter using exact section names (config, database, auth, jobs, pump, wake, ledger, readiness, invariants); empty runs all.
Result
Object with sections array; each section has a name and checks with id, status (ok, warn, fail, unknown), severity, summary, and detail (full mode only).
Boundaries
Read-only across the selected profile; secret material is never disclosed (presence and mode only). UNKNOWN means unobservable, never unhealthy.
Lifecycle
Pure diagnostic read; records nothing and changes nothing.
Errors
Wrong-typed arguments rejected by validation. Unknown section names are silently skipped. Backend failures surface as transport errors.
Example
```json { "detail": "summary" } ``` Result shape: ```json { "sections": [ { "checks": [ { "id": "readiness_db_ping", "severity": "info", "status": "ok", "summary": "database reachable (3 ms)" } ], "section": "readiness" } ] } ```

licence_status

Read · Ordinary

Licence compliance information for this SHAMPOO copy. Call it to see whether the copy presents FREE or a valid paid artefact; the answer never changes what the software can do.

Full documentation →

Arguments, result and boundaries
Arguments
Takes no arguments.
Result
Object with licence (FREE or VALID PERPETUAL LICENCE), artefact_present, and legacy_preset (display-only guess for older artefacts).
Boundaries
Compliance and display information only: the artefact never unlocks code and its absence never refuses. The legacy preset guess is display compatibility, never authority.
Lifecycle
Pure read; zero writes by construction.
Errors
Takes no arguments; backend failures surface as transport errors.
Example
```json {} ``` Result shape: ```json { "artefact_present": false, "legacy_preset": "", "licence": "FREE" } ```

memory_status

Read · Ordinary

Lightweight operational snapshot for the caller's own view. Call it at session start to see live counts and which profile you are on.

Full documentation →

Arguments, result and boundaries
Arguments
Takes no arguments.
Result
Object with product, version, backend, database, profile, caller, role, visibility (self or global), caller-filtered counts, tools_total, and tools_debate.
Boundaries
Counts are filtered to caller visibility: star sees global with an explicit global marker, others see only granted projects; debates count via owned bindings and inbox/wake numbers are star-only, so no metadata leaks across scopes.
Lifecycle
Pure read; zero writes by construction.
Errors
Takes no arguments; backend failures surface as transport errors.
Example
```json {} ``` Result shape: ```json { "backend": "mariadb", "counts": { "entities": 12, "tasks_live": 5 }, "product": "saphira-memory", "visibility": "self" } ```