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 or mode-specific access). 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_activityYouRead the workspace change log, newest first: every change to members, invites, keys, agents, the workspace, projects, repos, Knowledge, requirement changes and feedback.
rinkata_read_artifactEitherRead any rinkata artifact's frontmatter + markdown body by id or canonical .rinkata path (legacy .plumb paths are also accepted).
rinkata_read_historyEitherRead every change of one Goal, spec, ticket, decision, handoff or idea, newest first and paginated, with its facts in the same timeline.
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_whoamiEitherWho this connection is: { you: { handle, displayName, workspace: { name, tenantId } } }.
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_linksAgentRepair an idea whose promotion did not finish: link it to the work it became and mark it promoted, so it leaves Ideas.

Knowledge

ToolWhoWhat it does
rinkata_knowledge_askEitherAsk a question over this project's Knowledge (uploaded docs) with citations.
rinkata_knowledge_create_areaAgentCreate a customer-named Knowledge area in this project and return its areaId for rinkata_knowledge_record, rinkata_knowledge_upload and rinkata_knowledge_move_document.
rinkata_knowledge_listEitherList this project's Knowledge areas and documents.
rinkata_knowledge_move_documentAgentMove a listed Knowledge document into another area, or out of an area into Unfiled.
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 (create an area first with rinkata_knowledge_create_area).
rinkata_knowledge_uploadAgentUpload a file into this project's Knowledge File Search corpus.

Tickets

ToolWhoWhat it does
rinkata_bind_usage_sessionAgentRecord that this host session works on a ticket from now, so its measured token usage counts for that ticket.
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 and record the completion, with optional evidence.
rinkata_create_ticketAgentCreate a new feature ticket.
rinkata_link_requirementsAgentChange which approved criteria of its own spec an open ticket covers, under expectedVersion.
rinkata_list_ticketsEitherList tickets filtered by status × goalPath × assignee.
rinkata_preflight_ticketEitherAn advisory read: whether a ticket is safe, out of date, blocked, or unknown. No write requires it, and it never refuses Start or complete.
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 several open tickets as replaced by one surviving ticket, in a single call.
rinkata_update_ticketAgentSet a ticket's status (todo, in_progress or blocked), title and assignee in one write, under expectedVersion.
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_batchAgentEdit an open batch's title, owner, target date or description (the fields the Hub batch drawer edits).
rinkata_update_batch_membersAgentAdd or remove tagged roots on an open batch.

Specs

ToolWhoWhat it does
rinkata_approve_specEitherA resolved pak_ key may un-park a drafting spec only when that agent created it approved and parked it itself, and no person has approved it since, and an agent's un-park writes no human review stamp.
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_specAgentStart a successor spec from a finished one (complete, reopened, or archived), with the earlier spec filled in.
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_specEitherPer-spec requirement checks: preparing and applying Create/Retire cards when switched on is person-only; planning returns a read-only Review changes view (review + reviewUrl).
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_statusEitherA resolved pak_ key may un-park a drafting spec only when that agent created it approved and parked it itself, and no person has approved it since, and an agent's un-park writes no human review stamp.
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_migrate_goal_requirementsAgentPreview or apply suggested requirements for one existing Goal.
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_accept_decisionEitherHub Accept already does this for a person; the tool is for approving a Decision outside Hub. An agent key approves a Decision that agent recorded, or one another agent recorded once it is in effect, when only agents have written to it; a plain proposal from another agent stays with that agent. Hub records the agent and the person it works for. It also accepts a proposed Decision. A retry finishes an approval that did not complete, and keeps the first approver, time and chosen option. An approval recorded from a merged pull request does not accept the Decision.
rinkata_list_decisionsEitherList decisions filtered by lifecycle status.
rinkata_log_decisionEitherCapture a new decision artifact for the project.
rinkata_propose_from_decisionEitherPropose a change review for the work an accepted Decision affects.
rinkata_resolve_decisionYouA person resolves a Decision from their MCP client, as in the Hub UI Decision drawer.
rinkata_update_decisionEitherUpdate 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.

Out of date

ToolWhoWhat it does
rinkata_apply_staged_reconcileEitherApply a change review (Goal→Spec or Spec→Ticket) after a person approves that concrete plan. An agent key applies only the review of a Decision that agent wrote every version of, or logged or accepted while it is in effect and only agents wrote it, and Hub records the agent and the person it works for. A review that archives work or reopens a finished ticket still needs a person.
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 Out of date 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.

Mismatches

ToolWhoWhat it does
rinkata_list_drift_findingsEitherRead the mismatches Hub found when work completed, merged or deployed, each with its cause and who resolved it. It also says whether a tenant admin turned the checks off for the project (they are on until then), how the last check went, how many are open, and when they are piling up.
rinkata_resolve_driftEitherResolve one mismatch Hub found: a bug ticket under active work, a Decision that replaces the old one, or the safer option flagged for a person.

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.

More

ToolWhoWhat it does
rinkata_confirmYouRecords the person's tap on Rinkata's confirm card (MCP Apps).
rinkata_create_projectYouCreate a draft project (no repository) in your own workspace; the workspace is always the caller's.
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, plus the project's Knowledge changes (an area created, a document move) as events with source knowledge.

See also