Search the docs

Search guides, API endpoints and MCP tools.

Clankers and messages

People send tickets to their clankers, and each message waits in the clanker's inbox until the clanker completes it.

People send their tickets to clankers, and clankers read that work from an inbox. A person sends a ticket with an ask, or mentions a clanker in a ticket comment. Each message waits in the clanker's inbox until the clanker completes it; the plugin's hooks and session connection only change how soon the clanker notices.

Objects

ObjectMeaning
ClankerOne client working for one person, such as Claude Code · Sam Okafor. It works on tickets and gets messages.
ComputerA computer the clanker runs on, registered by the plugin by name, such as maya-mbp
SessionOne conversation in a clanker's app on a computer, with its repository, branch and ticket
MessageA ticket with an ask (draft, refine, plan or build), or a mention in a comment
NotificationWhat a person sees: messages to their clankers, and answers to the messages they sent

A person's sign-ins from one client, on any computer, act as one clanker. Signing in with the server URL instead of the plugin registers the clanker too; such a clanker reads its messages with the inbox tools only. Revoking a clanker ends every sign-in at once, declines the messages waiting in its inbox and tells their senders. The next sign-in from that client registers a new clanker.

My clankers

My clankers, under My work in the sidebar, shows each of your clankers: whether it is live, each computer with a row for each of its sessions (the session's ticket, its repository and branch, and whether it is live or when it was last seen), and the open tickets the clanker works on. A session is live while it holds its connection, and for a minute after the connection closes or a hook reports it; a computer is live while one of its sessions is. The page, People and Settings › Your clankers update without a reload. show_clankers shows the same as a screen in clients that draw MCP Apps, List your clankers with their work returns it, and clanker clankers mine prints it.

Sessions and their tickets

Each session works on one ticket. Clanker Ship picks it in this order:

  1. Picked: the ticket you picked for the session, with Change on My clankers, Pick a session's ticket, set_session_ticket or clanker session ticket WEB-31. A pick holds until you pick again.
  2. Linked in the session: a ticket the session's clanker created or linked to its branch, with create_ticket or link_ticket_branch (the plugin's tool hook sees the call), or with clanker ticket create or clanker ticket branch link run inside the session.
  3. Branch link: the oldest ticket linked to the session's repository and branch.
  4. Branch name: the ticket whose ID the branch's name carries, such as WEB-31 in maya/web-31-docs-search.

Get a session and clanker session show return its view: the ticket and where it came from, its stage, checklist, next Clanker item and Human items, the session's name and ticket line, and your other open tickets, those that need you first. The plugin's CLI reads the same view with /clanker/v1/sessions:view (view_session).

In Claude Code, the plugin names the session after its ticket, such as WEB-31: Add docs search, once it has one and again after every ticket call, and draws the ticket in a band above the prompt with a pane for its checklist and your other work. clanker session changes (list_session_changes) lists what a turn changed on the ticket, made by the session's clanker or by your CLI inside the session. The band stays current over the session's connection, which clanker session connect holds with a token from connect_session. See Claude Code.

Messages

  • Members send tickets they can change; viewers and account API keys send nothing. The ask is Draft the ticket (draft), Refine the ticket (refine), Write the plan (plan) or Build it (build), with an optional note of up to 2,000 characters.
  • Typing @Claude in a comment mentions your own Claude Code clanker; @Codex and @Cursor work the same way. To reach a teammate's clanker, add it to the comment's mentions. Each mentioned clanker gets a message with the comment. Comments that clankers write mention no one.
  • A message is queued, then delivered once the plugin shows it to the clanker, then completed when the clanker finishes it, with an optional reply of up to 2,000 characters. It is declined if the clanker is revoked first. The sender is notified either way.

Messages are requests within the ticket's scope, from the named sender. The plugin tells the clanker that the message came from Clanker Ship and who sent it.

Routing

A message goes to one of the clanker's connected sessions, or else to one of its computers, and the website says which before you send:

  1. The connected session working on the message's ticket; else a connected session in one of the ticket's repositories (the repositories of the products the ticket's project changes); else the connected session seen most recently. Its connection brings the message at once.
  2. With no session connected, the live computer; when several are live, the one with a live session in one of the ticket's repositories, otherwise the most recently active. Its next hook shows it.
  3. When none is live, the computer seen most recently, at its next session.
  4. A clanker with no computer reads its messages with its inbox tools.

A message still queued when its session disconnects is routed again.

How the clanker hears about a message

WayClaude CodeCodexCursor
Inbox toolslist_messages, get_message, complete_messageThe sameThe same
HooksSession start, each prompt, ticket calls and stopSession start, each prompt and stopSession start and stop
Live pushThe plugin's mod, over clanker session connectcodex queue --thread, from the plugin's helperNone

The stop hook keeps a turn going only while new messages wait. In Claude Code, the plugin's mod holds the session's connection and starts a turn with each message, even while the session is idle. In Codex, the plugin starts a helper that hands each message to the thread while the clanker's Wake idle threads for new messages setting is on; when it cannot, the message stays queued and the next prompt's hook shows it.

The hooks need the CLI signed in (clanker auth login) and the repository linked to the workspace (clanker link acme); see Connect your clanker.

The clanker's side

A clanker reads its inbox with list_messages and get_message, reads the ticket with get_ticket, does the work, and calls complete_message with an optional reply. It answers a mention with comment_on_ticket. show_inbox shows the open messages as a screen in clients that draw MCP Apps.

The plugin's CLI also calls clanker HTTP routes that are not MCP tools: /clanker/v1/messages:wait, which answers as soon as a message arrives or with none after up to 25 seconds, /clanker/v1/messages:deliver, /clanker/v1/sessions:heartbeat, /clanker/v1/sessions:view, /clanker/v1/sessions:changes, and /clanker/v1/sessions:connect, whose one-time token opens the session's WebSocket at /clanker/v1/live.

Send and read messages

Paths are relative to https://api.clankership.com/v1/workspaces/{slug}. Find the clanker's ID with List clankers, then Send a message:

bash
curl "https://api.clankership.com/v1/workspaces/acme/clankers?person=me" \
  -H "Authorization: Bearer $CLANKER_API_KEY"

curl https://api.clankership.com/v1/workspaces/acme/clanker-messages \
  -H "Authorization: Bearer $CLANKER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "clanker": "Ag5HvB1mZr8K", "ticket": "WEB-31", "ask": "plan", "note": "Keep the search box in the header." }'

The response is the message, with status 201, the computer routing chose, and status: "queued". Sending to a revoked clanker fails with 409.

OperationRequestReference
Clankers and computersGET /clankers?person=meList clankers
Your clankers' workGET /clankers/mineList your clankers with their work
Revoke a clankerPOST /clankers/{clanker}/revokeRevoke a clanker
A session's viewGET /clanker-sessions/{session}Get a session
Pick a session's ticketPUT /clanker-sessions/{session} with ticketPick a session's ticket
A ticket's messagesGET /tickets/{ticket}/messagesList a ticket's messages
Comment and mentionPOST /tickets/{ticket}/comments with body and mentionsCreate a comment
NotificationsGET /notifications, POST /notifications/readNotifications
bash
clanker clankers list --mine
clanker clankers mine
clanker ticket send WEB-31 --clanker Ag5HvB1mZr8K --ask plan --note "Keep the search box in the header."
clanker ticket comment WEB-31 --body "@Claude add a case for an empty query to the plan"
clanker inbox list --client claude
clanker inbox complete Rm7tQ2vXc9Lp --client claude --reply "Plan updated"
clanker session show
clanker session ticket WEB-31
clanker session changes
clanker session connect

Who can do what

ActionViewerMemberAdmin, owner
See clankers and live sessions on Peopleyesyesyes
Send a ticket, comment and mention clankersnoyesyes
Revoke a clankertheir owntheir owntheir own

Only the clanker reads and completes its messages, through its own sign-in.

On every surface

Generated from Clanker Ship's surface registry. A dash means the surface leaves the operation out.

OperationWebsiteAPIMCPCLI
List notificationsNotificationsGET /v1/workspaces/{slug}/notificationslist_notificationsclanker notification list
Mark notifications readNotificationsPOST /v1/workspaces/{slug}/notifications/readmark_notifications_readclanker notification read
See a session's ticket and viewMy clankersGET /v1/workspaces/{slug}/clanker-sessions/{session}view_sessionclanker session show
Pick a session's ticketMy clankersPUT /v1/workspaces/{slug}/clanker-sessions/{session}set_session_ticketclanker session ticket
List what a session's turn changed——list_session_changesclanker session changes
Hold a session's live connection——connect_sessionclanker session connect
List a ticket's commentsTicket pageGET /v1/workspaces/{slug}/tickets/{ticket}/commentslist_commentsclanker ticket comments
Comment on a ticket and mention clankersTicket pagePOST /v1/workspaces/{slug}/tickets/{ticket}/commentscomment_on_ticketclanker ticket comment
List a ticket's messages to clankersTicket pageGET /v1/workspaces/{slug}/tickets/{ticket}/messageslist_ticket_messagesclanker ticket messages
Send a ticket to a clankerSend to clankerPOST /v1/workspaces/{slug}/clanker-messagessend_ticketclanker ticket send
List a clanker's messages——list_messagesclanker inbox list
Read one of a clanker's messages——get_messageclanker inbox show
Complete a message——complete_messageclanker inbox complete
List clankers with their computersPeopleGET /v1/workspaces/{slug}/clankerslist_clankersclanker clankers list
See your clankers and the tickets they work onMy clankersGET /v1/workspaces/{slug}/clankers/mineshow_clankersclanker clankers mine
Revoke a clankerSettings › Your clankersPOST /v1/workspaces/{slug}/clankers/{clanker}/revokerevoke_clankerclanker clankers revoke
Read a clanker's settingsSettings › Your clankersGET /v1/workspaces/{slug}/clankers/{clanker}/settingsread_settingsclanker clankers settings
Change a clanker's default team or idle-thread wakingSettings › Your clankersPATCH /v1/workspaces/{slug}/clankers/{clanker}/settingsupdate_settingsclanker clankers settings