Documentation

Tools

Tools

When you connect Claude, Cursor, Grok, or ChatGPT from Settings, they work this project through these rinkata tools. Talk in plain language; you don't call these by name.

Some writes still wait on you: Accept and Approve. Agents cannot forge those.

Who is who calls the tool: You (human session only), Agent (connected agent), or Either (reads). Gates and refuse codes live on rinkata_tool_contracts. This page is a directory, not a recipe book.

See the project

ToolWhoWhat it does
rinkata_doctorEitherRun rinkata project health checks.
rinkata_find_artifact_by_external_refEitherForeign→local lookup over the artifact's external_refs[].
rinkata_impactEitherRead-only multi-hop impact (blast radius) from a Goal section, Spec, Ticket, or Decision root.
rinkata_list_projectsEitherList rinkata projects in the bearer's tenant.
rinkata_read_artifactEitherRead any rinkata artifact's frontmatter + markdown body by id or canonical .rinkata path (legacy .plumb paths are also accepted).
rinkata_searchEitherSearch project artifacts by content BEFORE creating a Goal, spec, or ticket.
rinkata_statusEitherRead project status: counts plus server-computed summaries for orient (top out-of-date work, in flight, recent items).
rinkata_tool_contractsEitherRead the machine-readable agent contract catalog for every registered rinkata capability.
rinkata_work_queueEitherRead an agent-ready work queue combining ticket lifecycle, alignment, blockers, evidence, and health signals.

Ideas

ToolWhoWhat it does
rinkata_classify_ideaAgentAttach an advisory classification to an idea.
rinkata_comment_ideaAgentAppend a comment to an idea WITHOUT altering its captured prose, the way to attach a finding, a correction, or context after capture.
rinkata_create_ideaAgentCapture a lightweight idea artifact for later triage.
rinkata_idea_set_stateAgentSet an idea's lifecycle state: archive a captured/triaged idea to dismiss it from the active inbox, or unarchive (restore) an archived idea back to active.
rinkata_list_ideasEitherList captured idea artifacts from Hub.
rinkata_promote_ideaAgentPromote an idea into a concrete artifact while preserving the original idea and recording promoted_to provenance.
rinkata_repair_idea_promotion_linksAgentWhen a live origin_idea target exists, append it into promoted_to (keeping archived tombstones) and seal a captured/triaged idea (promoted + promoted_at) so it leaves the inbox.

Knowledge

ToolWhoWhat it does
rinkata_knowledge_askEitherAsk a question over this project's Knowledge (uploaded docs) with citations.
rinkata_knowledge_listEitherList this project's Knowledge areas and documents.
rinkata_knowledge_readEitherRead one Knowledge document's extracted text and its basis.
rinkata_knowledge_recordAgentWrite a markdown note into Knowledge under an existing customer area, or Unfiled.
rinkata_knowledge_uploadAgentUpload a file into this project's Knowledge File Search corpus.

Tickets

ToolWhoWhat it does
rinkata_claimAgentClaim an assignable artifact for yourself: set its assignee to the caller (the agent principal over stdio, or your tenant-user via Hub).
rinkata_complete_ticketAgentMark a ticket done with deployed evidence.
rinkata_create_ticketAgentCreate a new feature ticket.
rinkata_list_ticketsEitherList tickets filtered by status × goalPath × assignee.
rinkata_preflight_ticketEitherCheck whether a ticket is safe, out of date, blocked, or unknown before work starts.
rinkata_read_ticketEitherRead a ticket's full frontmatter + markdown body from Hub DB.
rinkata_set_assigneeAgentSet or clear the assignee on a ticket.
rinkata_set_ticket_sourceAgentRe-anchor an EXISTING ticket onto a Goal (whole body or #section), complements rinkata_set_ticket_spec.
rinkata_set_ticket_statusAgentFlip a ticket's status (todo, in_progress, blocked, archived).
rinkata_supersede_ticketsAgentArchive N open tickets as superseded by one surviving ticket in a single call, the reviewable alternative to N bare set_ticket_status(archived) writes.
rinkata_update_ticket_dependenciesAgentAdd or remove ticket ids on this ticket's blocked_by in one call.
rinkata_write_ticket_bodyAgentReplace the markdown body of a ticket.

Batches

ToolWhoWhat it does
rinkata_create_batchAgentCreate a batch.
rinkata_list_batchesEitherList batches in this project.
rinkata_read_batchEitherRead one batch plus shared health (tagged roots, feature progress, blockers).
rinkata_set_batch_phaseAgentAgents may start, pause, or resume a batch, while close and delete require a human session.
rinkata_update_batch_membersAgentAdd or remove tagged roots on an open batch.

Specs

ToolWhoWhat it does
rinkata_approve_completed_spec_reopenYouHuman-only: stamp durable reopen approval on a derived-complete spec, bound to the current spec version and reviewed graph.
rinkata_approve_specYouHuman approve for a drafting spec: verifies human principal or durable stamp, checks version+graphHash, transitions drafting→approved, resolves open spec_approval review requests, records audit (status write + review resolve share one DB transaction).
rinkata_archive_specAgentArchive a spec and apply a downstream policy to its member tickets.
rinkata_create_spec_stubAgentCreate a lightweight deterministic spec stub anchored at a Goal section.
rinkata_create_standalone_specAgentCreate a standalone spec without a parent Goal section.
rinkata_create_successor_specAgentmint a standalone successor SPEC with predecessor pre-filled from a derived-complete SPEC.
rinkata_extract_specAgentCreate a new spec stub anchored at a Goal section.
rinkata_list_specsEitherList non-archived specs with status, source, ticket count, derived state.
rinkata_migrate_spec_requirementsAgentPreview existing specs without saving. A person can run the reviewed migration; requirement checks stay off.
rinkata_move_specAgentMove a spec to a different Goal section.
rinkata_plan_from_specAgentplan-on-create execution.
rinkata_read_specEitherRead a spec's frontmatter + body.
rinkata_set_spec_acceptanceAgentReplace a spec's typed acceptance: array atomically.
rinkata_set_spec_assigneeAgentSet or clear the assignee on a spec, the single member accountable for driving it to completion (distinct from the free-form authors[] contributor list).
rinkata_set_spec_sequenceAgentSet a spec's recommended order hint (sequence: [TICK-…]) through a constrained frontmatter-only write.
rinkata_set_spec_sourceAgentRetarget a spec to a different Goal section.
rinkata_set_spec_statusYouTransition a spec's status, where approving needs a signed-in person and similar specs do not block it.
rinkata_set_ticket_specAgentRe-anchor an EXISTING ticket onto a spec, the programmatic equivalent of linking a ticket to a (standalone or Goal-section) spec.
rinkata_write_spec_bodyAgentReplace the markdown body of a spec.

Goals

ToolWhoWhat it does
rinkata_approve_goalYouConstrained Goal governance approve: draft → active.
rinkata_create_goalAgentCreate a new Goal in Hub DB.
rinkata_list_goalsEitherList Goals filtered by status.
rinkata_set_goal_assigneeAgentSet or clear the assignee on a Goal, the single member accountable for it.
rinkata_write_goalAgentUpdate an existing Goal in Hub DB.

Decisions

ToolWhoWhat it does
rinkata_list_decisionsEitherList decisions filtered by lifecycle status.
rinkata_log_decisionYouCapture a new decision artifact for the project.
rinkata_propose_from_decisionEitherPropose a change review from an accepted or ratified decision's affects[] fan-out (GOAL-PLUMB-43 P2).
rinkata_ratify_decisionYouHuman-only. Hub Accept already does this; the tool is for sealing outside Hub. Human ratify also accepts a proposed Decision; a retry repairs a stuck ratified proposal while preserving its original seal and validating its locked option choice. Returns lifecycle status. Merge ratification stays stamp-only.
rinkata_update_decisionYouUpdate a decision's lifecycle status, owner, structured options, overrides, or supersede-in-state link.

Inbox

ToolWhoWhat it does
rinkata_inbox_addAgentCapture a new inbox note.
rinkata_inbox_listEitherList inbox notes.
rinkata_inbox_promoteAgentPromote a raw inbox note into a tracked ticket and resolve the note in one step.
rinkata_inbox_resolveAgentMark a raw inbox note resolved without promoting it to a durable decision.
rinkata_inbox_set_stateAgentTransition a raw inbox note to a terminal state: resolved, archived, or discarded.

Handoffs

ToolWhoWhat it does
rinkata_amend_handoffAgentAppend a correction to a handoff WITHOUT replacing or superseding it.
rinkata_list_handoffsEitherList session handoffs newest-first, filterable by state (default open), about, and query (keyword search over title+body+id).
rinkata_read_handoffEitherRead a session handoff.
rinkata_set_handoff_stateAgentTransition a handoff one-way: open→consumed (stamps consumed_at/consumed_by), open→archived, or consumed→archived.
rinkata_write_handoffAgentStash a session-handoff prompt for the next session/context window.

Review changes

ToolWhoWhat it does
rinkata_apply_staged_reconcileYouApply a change review (Goal→Spec or Spec→Ticket) only after explicit human approval of that concrete plan.
rinkata_list_driftEitherRead out-of-date tickets for the current rinkata project.
rinkata_propose_reconcileEitherCompute the current change-review proposal without writing files.
rinkata_propose_staged_reconcileAgentPropose a two-stage (Goal→Spec or Spec→Ticket) change review for a target, same semantics as the Hub UI Review changes drawer.
rinkata_read_drift_proposalAgentRead a stored change review.
rinkata_reconcile_applyYouApply a Hub change review only after explicit human approval of that concrete plan.
rinkata_reconcile_writeAgentWrite a Hub change review as a review artifact.

Complete

ToolWhoWhat it does
rinkata_begin_demo_screenshot_uploadAgentStart an out-of-band Demo Pack screenshot upload.
rinkata_complete_specAgentComplete a spec (verify member tickets are done/archived).
rinkata_finalize_demo_screenshot_uploadAgentFinish an out-of-band Demo Pack screenshot upload after the curl PUT.
rinkata_list_demo_reviewsEitherList the actionable Demo Pack review queue from Hub.
rinkata_propose_demo_evidenceAgentAttach completion evidence for a spec from an agent or API-key context.
rinkata_read_demo_packEitherRead a spec's Demo Pack readiness projection from Hub.
rinkata_set_spec_demo_requiredAgentToggle a spec's demo_required policy flag through a constrained frontmatter-only write.
rinkata_upload_demo_screenshotAgentLegacy: small images only; use rinkata_begin_demo_screenshot_upload / rinkata_finalize_demo_screenshot_upload for real screenshots (bytes never pass through the model).

More

ToolWhoWhat it does
rinkata_draft_review_rewriteAgentAttach an agent-drafted ticket body to an Update action on a stored review.
rinkata_list_agentsEitherList agents in the bearer's tenant (GOAL-PLUMB-4).
rinkata_list_gate_eventsEitherRead the human-gate ledger rows for one subject (spec, Goal, ticket, or Decision id), oldest first, with every column.
rinkata_list_usersEitherList users in the bearer's tenant.
rinkata_project_list_reposEitherList the repos attached to a rinkata project, primary first.
rinkata_rank_anchor_repairEitherS4 / TICK-PLUMB-942: rank section-anchor repair candidates for a ticket or spec with a broken/tombstoned/suspect source_anchor_id.
rinkata_read_hub_imageEitherFetch one HubImage as MCP ImageContent so agents can vision-read a design attached to an idea (or rehomed onto a Goal/spec/ticket).
rinkata_record_human_approvalYouHuman-only: stamp a durable human review approval on a Goal or drafting spec, bound to current version+graphHash.
rinkata_record_requirement_exceptionYouRecord, renew, or end a person-only exception.
rinkata_repair_task_graphAgentRepair task-graph inverse edges by making blocks and blocked_by mirror each other.
rinkata_set_requirement_modeAgentSwitching on is person-only. Switching off is allowed for agents.
rinkata_submit_feedbackAgentVolunteer free-form feedback about using rinkata itself, friction, a confusing error, a surprising or great result.
rinkata_work_changesEitherRead what changed for your work since a cursor.

See also