Skip to content
SHAMPOO

Manual · Chapter 19 of 19

Tool reference: index

Tool reference: index

The 106 tools are documented once, in full, as generated pages under tools/ (Markdown) and man/man7/shampoo-tool-<name>.7 (man). This chapter is navigation only: it states scope per category, links every tool, and explains how to read a tool page. It duplicates no descriptions. If an index entry and a tool page ever disagree, the tool page (generated from the curated record plus the live schema) wins, and the disagreement is a bug: the completeness gate exists to make it impossible.

How to read a tool page

Every page carries the same sections: purpose, classification (category, access, audience, direct-use), arguments (required/optional, derived from the live schema, never copied by hand), result shape, boundaries and authority, lifecycle and side effects, errors, a structured example, and see-also links. access: write includes tools that look read-like but persist something (sessions, cursors, audit events); the page says so explicitly in each case.

Tasks and notes (10)

create_task_or_note · upsert_note_by_title_project · update_task · assign_task · query_tasks · find_by_title · task_digest · archive_done_tasks · bump_overdue_priority · ready_context

Start here for everyday work; see 05-tasks-and-notes.

Knowledge graph (10)

create_entities · add_observations · create_relations · delete_entities · delete_observations · delete_relations · read_graph · search_nodes · open_nodes · search_by_project

The delete_* names are lifecycle retirement, never physical deletion; see 04-memory-and-knowledge.

link_task_entity · unlink_task_entity · get_task_links · get_entity_tasks · suggest_task_links

Sessions and context (4)

session_save · session_recall · resume_context · close_session

See 06-context-and-sessions.

Intel and knowledge tiers (12)

assess_context · queue_clarification · record_human_answer · extract_candidate_claims · promote_candidate · govern_fact · build_context_pack · enrich_context · explain_impact · audit_memory · replay_memory · list_memory_issues

Reflection (10)

reflect_audit · reflect_start · reflect_status · reflect_history · reflect_cancel · reflect_archive · reflect_decide · reflect_apply · reflect_review · reflect_discard

Pipeline order and lifecycle rules: 07-reflection.

Debate (29)

debate_init · debate_post · debate_post_with_recipients · debate_read · debate_search · debate_state · debate_close_topic · debate_compact · debate_escalate · debate_signal_check · debate_signal_advance · debate_bind_role · debate_add_role · debate_rotate_binding · debate_binding_list · debate_protocol_state · debate_set_topic_priority · debate_advance_watermark · debate_worker_claim · debate_wake_dry_run · debate_worker_no_action · debate_worker_reap · debate_worker_recover_stale · debate_message_claim_reclaim · debate_judge_prepare · debate_judge_verdict · debate_protocol_maintain · debate_reconcile_project · debate_work_queue

Read 08-debate before posting anything: ownership, privacy, and lifecycle rules are load-bearing.

Quorum (5)

quorum_create · quorum_resolve · quorum_cancel · quorum_list · quorum_participant_set

See 09-quorum.

Jobs and lanes (9)

job_create · job_claim · job_complete · job_release · lane_create · lane_set_state · lane_review · lane_merge · lane_list

See 10-jobs-and-lanes.

Inbox (3)

inbound_list · inbound_approve · inbound_reject

Review before agreed state; see 11-human-interaction.

Diagnostics (2)

memory_status · doctor

See 13-diagnostics.

Authentication (7)

handshake_challenge · handshake_complete · issue_enrollment_ticket · revoke_ticket · revoke_agent · kill_session · list_sessions

Session lifecycle (close_session) is indexed under sessions above. See 12-authentication-and-enrolment.

Coverage proof

Category counts above sum to 106. The machine-checked proof is tests/test_docs_tools.sh --mode full: implementation registration, runtime tools/list, curated records, Markdown pages, and man pages exactly equal, plus exact argument shapes, resolved source references, and byte-identical generation.

On this page