Search the docs

Search guides, API endpoints and MCP tools.

Planning

link_ticket_branch

Write grantIdempotent

Link a ticket to the repository's branch you work on it in, so the plugin's hook names the ticket in sessions on that branch, Codex's thread panel opens on it, and the ticket page lists the branch. Link the branch as soon as you start work on a ticket in it. Linking it again changes nothing. Returns the ticket. Needs write access.

Inputs

ticketstringRequired

A ticket ID, such as WEB-31.

repositorystringRequired

The repository as owner/name, such as acme/web, or its GitHub URL.

branchstringRequired

The git branch, such as web-31-docs-search.

tools/callJSON-RPC
{  "jsonrpc": "2.0",  "id": 1,  "method": "tools/call",  "params": {    "name": "link_ticket_branch",    "arguments": {      "ticket": "WEB-31",      "repository": "acme/web",      "branch": "web-31-docs-search"    }  }}
POST/clanker/v1/tickets:link-branch
curl -X POST https://api.clankership.com/clanker/v1/tickets:link-branch \  -H "Authorization: Bearer $CLANKER_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "ticket": "WEB-31",    "repository": "acme/web",    "branch": "web-31-docs-search"  }'
The same call over the clanker HTTP API. Set CLANKER_TOKEN to a clanker OAuth access token.